Code Monkey home page Code Monkey logo

portfolio-api's People

Contributors

actions-user avatar pochetes avatar

Watchers

avatar

portfolio-api's Issues

Building the endpoints 3/5-> `/projects`

/projects Parameters

Path Parameters

Parameter Required/Optional Description Type
{ projectId } integer required The value for the Project object you want to look up.

Query Parameters /projects

Parameter Required/Optional Description Type
title string optional The title of the project I work(ed) on.
description string optional The description of the project that I work(ed) on.
image string optional The image of the project website or pictures.
link string required The link to the Github repository of the project.

Figure out how to "Prettify" JSON response in docs

Confused as to why JSON response comes out like:

"[{\"_id\": {\"$oid\": \"61bafafedbfa18faad30ac98\"}, \"firstName\": \"Brother\", \"lastName\": \"Martinez\", \"email\": \"[email protected]\", \"description\": \"Hate him.\"}]"

Maybe it's the json_util method when using json_dumps to serialize the python object.

Create Database Model off Schema in Wiki/Issue

ref to the issue

Entire Schema in JSON

{
    "firstName": "Roberto",
    "lastName": "Martinez",
    "email": "[email protected]",
    "description": "I am a Sophomore at ...",
    "image": "<link_to_image>",
    "interests": [
        {
            "topic": "AI",
            "image": "<link_to_image>"
        },
        {
            "topic": "Innovation",
            "image": "<link_to_image>"
        },
        {
            "topic": "Blockchain",
            "image": "<link_to_image>"
        },
        {
            "topic": "Venture Capital",
            "image": "<link_to_image>"
        }
    ],
    "projects": [
        {
            "id": 1,
            "title": "Navi Web Companion",
            "description": "This project is...",
            "image": "<link_to_image>",
            "link": "https://github.com/..."
        },
        {
            "id": 2,
            "title": "RealTalk Application",
            "description": "This project is...",
            "image": "<link_to_image>",
            "link": "https://github.com/..."
        },
        {
            "id": 3,
            "title": "SmartClaims",
            "description": "This project is...",
            "image": "<link_to_image>",
            "link": "https://github.com/..."
        }
    ],
    "skills": [
        "Python",
        "C",
        "Javascript"
    ],
    "experiences": [
        {
            "id": 1,
            "company": "Meta Platforms Inc.",
            "position": "Software Engineer Intern",
            "dateStarted": "June 2021",
            "dateEnded": "August 2021",
            "image": "<link_to_image>"
        },
        {
            "id": 2,
            "company": "Libery Mutual Insurance",
            "position": "Software Engineer Intern",
            "dateStarted": "June 2021",
            "dateEnded": "August 2021",
            "image": "<link_to_image>"
        },
        {
            "id": 3,
            "company": "Florida International University",
            "position": "Research Assistant - DaMRL",
            "dateStarted": "June 2021",
            "dateEnded": "August 2021",
            "image": "<link_to_image>"
        }
    ],
    "contact": [
        {
            "title": "Twitter",
            "link": "<link_to_social>"
        },
        {
            "title": "Github",
            "link": "<link_to_social>"
        },
        {
            "title": "LinkedIn",
            "link": "<link_to_social>"
        }
    ]
}

Building the endpoints 2/5 -> `/projects`

Sample /projects Response

{
    "projects": [
        {
            "id": 1,
            "title": "Navi Web Companion",
            "description": "This project is...",
            "image": "<link_to_image>",
            "link": "https://github.com/..."
        },
        {
            "id": 2,
            "title": "RealTalk Application",
            "description": "This project is...",
            "image": "<link_to_image>",
            "link": "https://github.com/..."
        },
        {
            "id": 3,
            "title": "SmartClaims",
            "description": "This project is...",
            "image": "<link_to_image>",
            "link": "https://github.com/..."
        }
    ]
}

Building the endpoints 2/5 -> `/experiences`

Sample /experiences Response

{
    "experiences": [
        {
            "id": 1,
            "company": "Meta Platforms Inc.",
            "position": "Software Engineer Intern",
            "dateStarted": "June 2021",
            "dateEnded": "August 2021",
            "image": "<link_to_image>"
        },
        {
            "id": 2,
            "company": "Libery Mutual Insurance",
            "position": "Software Engineer Intern",
            "dateStarted": "June 2021",
            "dateEnded": "August 2021",
            "image": "<link_to_image>"
        },
        {
            "id": 3,
            "company": "Florida International University",
            "position": "Research Assistant - DaMRL",
            "dateStarted": "June 2021",
            "dateEnded": "August 2021",
            "image": "<link_to_image>"
        }
    ]
}

Building the endpoints 3/5 -> `/personal`

/personal Parameters

Path Parameters

Parameter Required/Optional Description Type
{ interestId } integer required The value for the Interest object you want to look up.
{ skillId } integer required The value for the skill of type Thing you want to look up.
{ interestId } integer required The value for the Interest object you want to look up.
{ contactId } integer required The value for the Contact object you want to look up.

Query Parameters personal/info

Parameter Required/Optional Description Type
firstName string optional The first name of the person in the Person object.
lastName string optional The last name of the person in the Person object.
email string optional The email of the person in the Person object.
description string required A brief description of the person in the Person object.

Query Parameters personal/interests

Parameter Required/Optional Description Type
{ interestId } integer optional The value for the interest object you want to look up.
topic string optional The name of the specific interest in the type Thing in the interest property.
image string optional The image of the specific interest in the type Thing in the interest property.

Query Parameters personal/skills

Parameter Required/Optional Description Type
{ skillId } integer optional The value for the skill object you want to look up.
topic string optional The name of the specific skill in the type Thing in the skill property.
image string optional The image of the specific skill/technology in the type Thing in the skill property.

Query Parameters personal/contact

Parameter Required/Optional Description Type
{ contactId } integer optional The value for the contact object you want to look up.
title string optional The title of the social media application in the type Social in the contact property.
image string optional The image of the specific interest in the type Thing in the contact property.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.