Resume · GPT-Aktionen

{
  "openapi": "3.0.0",
  "paths": {
    "/resume": {
      "post": {
        "operationId": "generateResume",
        "summary": "",
        "description": "Generate a resume",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateResumeDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": ""
          }
        }
      }
    }
  },
  "info": {
    "title": "Quanthium Resumes",
    "description": "This is the Quanthium Resumes API documentation, ready for Resume generation",
    "version": "1.0",
    "contact": {}
  },
  "tags": [
    {
      "name": "api",
      "description": ""
    }
  ],
  "servers": [
    {
      "url": "https://resumes.api.quanthium.io",
      "description": "Resume generator on Quanthium.io"
    }
  ],
  "components": {
    "securitySchemes": {
      "bearer": {
        "scheme": "bearer",
        "bearerFormat": "plain",
        "type": "apiKey",
        "name": "Authorization"
      }
    },
    "schemas": {
      "PersonalInfo": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The full name of the person",
            "example": "John Doe"
          },
          "title": {
            "type": "string",
            "description": "The proffesional title of the person",
            "example": "Full Stack Developer"
          },
          "mobilePhone": {
            "type": "string",
            "description": "The mobile phone to contact",
            "example": "+1 555 555 5555"
          },
          "email": {
            "type": "string",
            "description": "The email to contact",
            "example": "johndoe@example.com"
          },
          "location": {
            "type": "string",
            "description": "The location of the person",
            "example": "New York, NY"
          },
          "bio": {
            "type": "string",
            "description": "The about section of the resume, consisting in a pragraph with 3 or 4 sentences"
          },
          "websiteUrl": {
            "type": "string",
            "description": "The website of the person",
            "example": "https://example.com"
          },
          "websiteLabel": {
            "type": "string",
            "description": "The label that introduces the website in the resume",
            "example": "Portfolio"
          }
        },
        "required": [
          "name",
          "title",
          "bio"
        ]
      },
      "Experience": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "The proffesional title during the experience",
            "example": "Full Stack Developer"
          },
          "description": {
            "type": "string",
            "description": "A description of the experience, consisting in a pragraph with 2 or 3 sentences"
          },
          "company": {
            "type": "string",
            "description": "The company where the experience took place",
            "example": "Google"
          },
          "period": {
            "type": "string",
            "description": "The period of time where the experience took place",
            "example": "January 2021 - July 2022"
          }
        },
        "required": [
          "title"
        ]
      },
      "Education": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "The proffesional title during the education",
            "example": "Degree in Computer Science"
          },
          "description": {
            "type": "string",
            "description": "A description of the education, consisting in a pragraph with 2 or 3 sentences"
          },
          "institution": {
            "type": "string",
            "description": "The institution where the education took place",
            "example": "Harvard University"
          },
          "period": {
            "type": "string",
            "description": "The period of time where the education took place",
            "example": "January 2020 - Current"
          }
        },
        "required": [
          "title"
        ]
      },
      "CreateResumeDto": {
        "type": "object",
        "properties": {
          "personalInfo": {
            "description": "The personal info section of the resume",
            "allOf": [
              {
                "$ref": "#/components/schemas/PersonalInfo"
              }
            ]
          },
          "skills": {
            "description": "The skills section of the resume",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "experiences": {
            "description": "The experience section of the resume",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Experience"
            }
          },
          "education": {
            "description": "The education section of the resume",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Education"
            }
          }
        },
        "required": [
          "personalInfo"
        ]
      }
    }
  }
}