Reactive-Resume/docs/spec.json

{"info":{"title":"Reactive Resume","version":"5.0.0","description":"Reactive Resume API","license":{"name":"MIT","url":"https://github.com/amruthpillai/reactive-resume/blob/main/LICENSE"},"contact":{"name":"Amruth Pillai","email":"hello@amruthpillai.com","url":"https://amruthpillai.com"}},"servers":[{"url":"http://localhost:3000/api/openapi"}],"externalDocs":{"url":"https://docs.rxresu.me","description":"Reactive Resume Documentation"},"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"x-api-key","in":"header","description":"The API key to authenticate requests."}}},"security":[{"apiKey":[]}],"openapi":"3.1.1","paths":{"/auth/providers/list":{"get":{"operationId":"auth.providers.list","summary":"List all auth providers","description":"A list of all authentication providers, and their display names, supported by the instance of Reactive Resume.","tags":["Authentication"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/auth/verify-resume-password":{"post":{"operationId":"auth.verifyResumePassword","summary":"Verify resume password","description":"Verify a resume password, to grant access to the locked resume.","tags":["Authentication","Resume"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","minLength":1},"username":{"type":"string","minLength":1},"password":{"type":"string","minLength":1}},"required":["slug","username","password"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/auth/delete-account":{"delete":{"operationId":"auth.deleteAccount","summary":"Delete user account","description":"Delete the authenticated user's account and all associated data.","tags":["Authentication"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/resume/tags/list":{"get":{"operationId":"resume.tags.list","summary":"List all resume tags","description":"List all tags for the authenticated user's resumes. Used to populate the filter in the dashboard.","tags":["Resume"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/resume/statistics/{id}":{"get":{"operationId":"resume.statistics.getById","summary":"Get resume statistics","description":"Get the statistics for a resume, such as number of views and downloads.","tags":["Resume"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"isPublic":{"type":"boolean"},"views":{"type":"number"},"downloads":{"type":"number"},"lastViewedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"lastDownloadedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]}},"required":["isPublic","views","downloads","lastViewedAt","lastDownloadedAt"]}}}}}}},"/resume/list":{"get":{"operationId":"resume.list","summary":"List all resumes","description":"List of all the resumes for the authenticated user.","tags":["Resume"],"parameters":[{"name":"tags","in":"query","schema":{"type":"array","items":{"type":"string"},"default":[]},"style":"deepObject","explode":true,"allowEmptyValue":true,"allowReserved":true},{"name":"sort","in":"query","schema":{"enum":["lastUpdatedAt","createdAt","name"],"default":"lastUpdatedAt"},"style":"deepObject","explode":true,"allowEmptyValue":true,"allowReserved":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"isPublic":{"type":"boolean"},"isLocked":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"updatedAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["id","name","slug","tags","isPublic","isLocked","createdAt","updatedAt"]}}}}}}}},"/resume/{id}":{"get":{"operationId":"resume.getById","summary":"Get resume by ID","description":"Get a resume, along with its data, by its ID.","tags":["Resume"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"data":{"type":"object","properties":{"picture":{"type":"object","properties":{"hidden":{"type":"boolean","description":"Whether to hide the picture from the resume."},"url":{"type":"string","description":"The URL to the picture to display on the resume. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"size":{"type":"number","minimum":32,"maximum":512,"description":"The size of the picture to display on the resume, defined in points (pt)."},"rotation":{"type":"number","minimum":0,"maximum":360,"description":"The rotation of the picture to display on the resume, defined in degrees (°)."},"aspectRatio":{"type":"number","minimum":0.5,"maximum":2.5,"description":"The aspect ratio of the picture to display on the resume, defined as width / height (e.g. 1.5 for 1.5:1 or 0.5 for 1:2)."},"borderRadius":{"type":"number","minimum":0,"maximum":100,"description":"The border radius of the picture to display on the resume, defined in points (pt)."},"borderColor":{"type":"string","description":"The color of the border of the picture to display on the resume, defined as rgba(r, g, b, a)."},"borderWidth":{"type":"number","minimum":0,"description":"The width of the border of the picture to display on the resume, defined in points (pt)."},"shadowColor":{"type":"string","description":"The color of the shadow of the picture to display on the resume, defined as rgba(r, g, b, a)."},"shadowWidth":{"type":"number","minimum":0,"description":"The width of the shadow of the picture to display on the resume, defined in points (pt)."}},"required":["hidden","url","size","rotation","aspectRatio","borderRadius","borderColor","borderWidth","shadowColor","shadowWidth"],"description":"Configuration for photograph displayed on the resume"},"basics":{"type":"object","properties":{"name":{"type":"string","description":"The full name of the author of the resume."},"headline":{"type":"string","description":"The headline of the author of the resume."},"email":{"anyOf":[{"type":"string","format":"email"},{"const":""}],"description":"The email address of the author of the resume. Leave blank to hide."},"phone":{"type":"string","description":"The phone number of the author of the resume. Leave blank to hide."},"location":{"type":"string","description":"The location of the author of the resume."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The website of the author of the resume."},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the custom field. Usually generated as a UUID."},"icon":{"type":"string","description":"The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."},"text":{"type":"string","description":"The text to display for the custom field."}},"required":["id","icon","text"]},"description":"The custom fields to display on the resume."}},"required":["name","headline","email","phone","location","website","customFields"],"description":"Basic information about the author, such as name, email, phone, location, and website"},"summary":{"type":"object","properties":{"title":{"type":"string","description":"The title of the summary of the resume."},"columns":{"type":"number","description":"The number of columns the summary should span across."},"hidden":{"type":"boolean","description":"Whether to hide the summary from the resume."},"content":{"type":"string","description":"The content of the summary of the resume. This should be a HTML-formatted string. Leave blank to hide."}},"required":["title","columns","hidden","content"],"description":"Summary section of the resume, useful for a short bio or introduction"},"sections":{"type":"object","properties":{"profiles":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"icon":{"type":"string","description":"The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."},"network":{"type":"string","minLength":1,"description":"The name of the network or platform."},"username":{"type":"string","description":"The username of the author on the network or platform."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The link to the profile of the author on the network or platform, if any."}},"required":["id","hidden","icon","network","username","website"]},"description":"The items to display in the profiles section."}},"required":["title","columns","hidden","items"],"description":"The section to display the profiles of the author."},"experience":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"company":{"type":"string","minLength":1,"description":"The name of the company or organization."},"position":{"type":"string","description":"The position held at the company or organization."},"location":{"type":"string","description":"The location of the company or organization."},"period":{"type":"string","description":"The period of time the author was employed at the company or organization."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The website of the company or organization, if any."},"description":{"type":"string","description":"The description of the experience. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","company","position","location","period","website","description"]},"description":"The items to display in the experience section."}},"required":["title","columns","hidden","items"],"description":"The section to display the experience of the author."},"education":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"school":{"type":"string","minLength":1,"description":"The name of the school or institution."},"degree":{"type":"string","description":"The degree or qualification obtained."},"area":{"type":"string","description":"The area of study or specialization."},"grade":{"type":"string","description":"The grade or score achieved."},"location":{"type":"string","description":"The location of the school or institution."},"period":{"type":"string","description":"The period of time the education was obtained over."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The website of the school or institution, if any."},"description":{"type":"string","description":"The description of the education. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","school","degree","area","grade","location","period","website","description"]},"description":"The items to display in the education section."}},"required":["title","columns","hidden","items"],"description":"The section to display the education of the author."},"projects":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"name":{"type":"string","minLength":1,"description":"The name of the project."},"period":{"type":"string","description":"The period of time the project was worked on."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The link to the project, if any."},"description":{"type":"string","description":"The description of the project. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","name","period","website","description"]},"description":"The items to display in the projects section."}},"required":["title","columns","hidden","items"],"description":"The section to display the projects of the author."},"skills":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"icon":{"type":"string","description":"The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."},"name":{"type":"string","minLength":1,"description":"The name of the skill."},"proficiency":{"type":"string","description":"The proficiency level of the skill. Can be any text, such as 'Beginner', 'Intermediate', 'Advanced', etc."},"level":{"type":"number","minimum":0,"maximum":5,"description":"The proficiency level of the skill, defined as a number between 0 and 5. If set to 0, the icons displaying the level will be hidden."},"keywords":{"type":"array","items":{"type":"string"},"description":"The keywords associated with the skill, if any. These are displayed as tags below the name."}},"required":["id","hidden","icon","name","proficiency","level","keywords"]},"description":"The items to display in the skills section."}},"required":["title","columns","hidden","items"],"description":"The section to display the skills of the author."},"languages":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"language":{"type":"string","minLength":1,"description":"The name of the language the author knows."},"fluency":{"type":"string","description":"The fluency level of the language. Can be any text, such as 'Native', 'Fluent', 'Conversational', etc. or can also be a CEFR level (A1, A2, B1, B2, C1, C2)."},"level":{"type":"number","minimum":0,"maximum":5,"description":"The proficiency level of the language, defined as a number between 0 and 5. If set to 0, the icons displaying the level will be hidden."}},"required":["id","hidden","language","fluency","level"]},"description":"The items to display in the languages section."}},"required":["title","columns","hidden","items"],"description":"The section to display the languages of the author."},"interests":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"icon":{"type":"string","description":"The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."},"name":{"type":"string","minLength":1,"description":"The name of the interest/hobby."},"keywords":{"type":"array","items":{"type":"string"},"description":"The keywords associated with the interest/hobby, if any. These are displayed as tags below the name."}},"required":["id","hidden","icon","name","keywords"]},"description":"The items to display in the interests section."}},"required":["title","columns","hidden","items"],"description":"The section to display the interests of the author."},"awards":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"title":{"type":"string","minLength":1,"description":"The title of the award."},"awarder":{"type":"string","description":"The awarder of the award."},"date":{"type":"string","description":"The date when the award was received."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The website of the award, if any."},"description":{"type":"string","description":"The description of the award. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","title","awarder","date","website","description"]},"description":"The items to display in the awards section."}},"required":["title","columns","hidden","items"],"description":"The section to display the awards of the author."},"certifications":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"title":{"type":"string","minLength":1,"description":"The title of the certification."},"issuer":{"type":"string","description":"The issuer of the certification."},"date":{"type":"string","description":"The date when the certification was received."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The website of the certification, if any."},"description":{"type":"string","description":"The description of the certification. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","title","issuer","date","website","description"]},"description":"The items to display in the certifications section."}},"required":["title","columns","hidden","items"],"description":"The section to display the certifications of the author."},"publications":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"title":{"type":"string","minLength":1,"description":"The title of the publication."},"publisher":{"type":"string","description":"The publisher of the publication."},"date":{"type":"string","description":"The date when the publication was published."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The link to the publication, if any."},"description":{"type":"string","description":"The description of the publication. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","title","publisher","date","website","description"]},"description":"The items to display in the publications section."}},"required":["title","columns","hidden","items"],"description":"The section to display the publications of the author."},"volunteer":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"organization":{"type":"string","minLength":1,"description":"The name of the organization or company."},"location":{"type":"string","description":"The location of the organization or company."},"period":{"type":"string","description":"The period of time the author was volunteered at the organization or company."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The link to the organization or company, if any."},"description":{"type":"string","description":"The description of the volunteer experience. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","organization","location","period","website","description"]},"description":"The items to display in the volunteer section."}},"required":["title","columns","hidden","items"],"description":"The section to display the volunteer experience of the author."},"references":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"name":{"type":"string","minLength":1,"description":"The name of the reference, or a note such as 'Available upon request'."},"description":{"type":"string","description":"The description of the reference. Can be used to display a quote, a testimonial, etc. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","name","description"]},"description":"The items to display in the references section."}},"required":["title","columns","hidden","items"],"description":"The section to display the references of the author."}},"required":["profiles","experience","education","projects","skills","languages","interests","awards","certifications","publications","volunteer","references"],"description":"Various sections of the resume, such as experience, education, projects, etc."},"customSections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"id":{"type":"string","description":"The unique identifier for the custom section. Usually generated as a UUID."},"content":{"type":"string","description":"The content of the custom section. This should be a HTML-formatted string. Leave blank to hide."}},"required":["title","columns","hidden","id","content"]},"description":"Custom sections of the resume, such as a custom section for notes, etc."},"metadata":{"type":"object","properties":{"template":{"enum":["azurill","bronzor","chikorita","ditto","gengar","glalie","kakuna","lapras","leafish","onyx","pikachu","rhyhorn"],"description":"The template to use for the resume. Determines the overall design and appearance of the resume."},"layout":{"type":"object","properties":{"sidebarWidth":{"type":"number","minimum":10,"maximum":50,"description":"The width of the sidebar column, defined as a percentage of the page width."},"pages":{"type":"array","items":{"type":"object","properties":{"fullWidth":{"type":"boolean","description":"Whether the layout of the page should be full width. If true, the main column will span the entire width of the page. This means that there should be no items in the sidebar column."},"main":{"type":"array","items":{"type":"string"},"description":"The items to display in the main column of the page. A string array of section IDs (experience, education, projects, skills, languages, interests, awards, certifications, publications, volunteer, references, profiles, summary or UUIDs for custom sections)."},"sidebar":{"type":"array","items":{"type":"string"},"description":"The items to display in the sidebar column of the page. A string array of section IDs (experience, education, projects, skills, languages, interests, awards, certifications, publications, volunteer, references, profiles, summary or UUIDs for custom sections)."}},"required":["fullWidth","main","sidebar"]},"description":"The pages to display in the layout."}},"required":["sidebarWidth","pages"],"description":"The layout of the resume. Determines the structure and arrangement of the sections on the resume."},"css":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether to enable custom CSS for the resume."},"value":{"type":"string","description":"The custom CSS to apply to the resume. This should be a valid CSS string."}},"required":["enabled","value"],"description":"Custom CSS to apply to the resume. Can be used to override the default styles of the template."},"page":{"type":"object","properties":{"gapX":{"type":"number","minimum":0,"description":"The horizontal gap between the sections of the page, defined in points (pt)."},"gapY":{"type":"number","minimum":0,"description":"The vertical gap between the sections of the page, defined in points (pt)."},"marginX":{"type":"number","minimum":0,"description":"The horizontal margin of the page, defined in points (pt)."},"marginY":{"type":"number","minimum":0,"description":"The vertical margin of the page, defined in points (pt)."},"format":{"enum":["a4","letter"],"description":"The format of the page. Can be 'a4' or 'letter'."},"locale":{"anyOf":[{"const":"af-ZA"},{"const":"am-ET"},{"const":"ar-SA"},{"const":"az-AZ"},{"const":"bg-BG"},{"const":"bn-BD"},{"const":"ca-ES"},{"const":"cs-CZ"},{"const":"da-DK"},{"const":"de-DE"},{"const":"el-GR"},{"const":"en-US"},{"const":"es-ES"},{"const":"fa-IR"},{"const":"fi-FI"},{"const":"fr-FR"},{"const":"he-IL"},{"const":"hi-IN"},{"const":"hu-HU"},{"const":"id-ID"},{"const":"it-IT"},{"const":"ja-JP"},{"const":"km-KH"},{"const":"kn-IN"},{"const":"ko-KR"},{"const":"lt-LT"},{"const":"lv-LV"},{"const":"ml-IN"},{"const":"mr-IN"},{"const":"ms-MY"},{"const":"ne-NP"},{"const":"nl-NL"},{"const":"no-NO"},{"const":"or-IN"},{"const":"pl-PL"},{"const":"pt-BR"},{"const":"pt-PT"},{"const":"ro-RO"},{"const":"ru-RU"},{"const":"sk-SK"},{"const":"sq-AL"},{"const":"sr-SP"},{"const":"sv-SE"},{"const":"ta-IN"},{"const":"te-IN"},{"const":"th-TH"},{"const":"tr-TR"},{"const":"uk-UA"},{"const":"uz-UZ"},{"const":"vi-VN"},{"const":"zh-CN"},{"const":"zh-TW"},{"const":"zu-ZA"}],"description":"The language used in the resume, used for displaying pre-translated section headings, if not overridden."}},"required":["gapX","gapY","marginX","marginY","format","locale"],"description":"The page settings of the resume. Determines the margins, format, and locale of the resume."},"design":{"type":"object","properties":{"level":{"type":"object","properties":{"icon":{"type":"string","description":"The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."},"type":{"enum":["hidden","circle","square","rectangle","rectangle-full","progress-bar","icon"],"description":"The type of the level design. 'hidden' will hide the level design, 'circle' will display a circle, 'square' will display a square, 'rectangle' will display a rectangle, 'rectangle-full' will display a full rectangle, 'progress-bar' will display a progress bar, and 'icon' will display an icon. If 'icon' is selected, the icon to display should be specified in the 'icon' field."}},"required":["icon","type"]},"colors":{"type":"object","properties":{"primary":{"type":"string","description":"The primary color of the design, defined as rgba(r, g, b, a)."},"text":{"type":"string","description":"The text color of the design, defined as rgba(r, g, b, a). Usually set to black: rgba(0, 0, 0, 1)."},"background":{"type":"string","description":"The background color of the design, defined as rgba(r, g, b, a). Usually set to white: rgba(255, 255, 255, 1)."}},"required":["primary","text","background"]}},"required":["level","colors"],"description":"The design settings of the resume. Determines the colors, level designs, and typography of the resume."},"typography":{"type":"object","properties":{"body":{"type":"object","properties":{"fontFamily":{"type":"string","description":"The family of the font to use. Must be a font that is available on Google Fonts."},"fontWeights":{"type":"array","items":{"enum":["100","200","300","400","500","600","700","800","900"]},"description":"The weight of the font, defined as a number between 100 and 900. Default to 400 when unsure if the weight is available in the font."},"fontSize":{"type":"number","minimum":6,"maximum":24,"description":"The size of the font to use, defined in points (pt)."},"lineHeight":{"type":"number","minimum":0.5,"maximum":4,"description":"The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x)."}},"required":["fontFamily","fontWeights","fontSize","lineHeight"],"description":"The typography for the body of the resume."},"heading":{"type":"object","properties":{"fontFamily":{"type":"string","description":"The family of the font to use. Must be a font that is available on Google Fonts."},"fontWeights":{"type":"array","items":{"enum":["100","200","300","400","500","600","700","800","900"]},"description":"The weight of the font, defined as a number between 100 and 900. Default to 400 when unsure if the weight is available in the font."},"fontSize":{"type":"number","minimum":6,"maximum":24,"description":"The size of the font to use, defined in points (pt)."},"lineHeight":{"type":"number","minimum":0.5,"maximum":4,"description":"The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x)."}},"required":["fontFamily","fontWeights","fontSize","lineHeight"],"description":"The typography for the headings of the resume."}},"required":["body","heading"],"description":"The typography settings of the resume. Determines the fonts and sizes of the body and headings of the resume."},"notes":{"type":"string","description":"Personal notes for the resume. Can be used to add any additional information or instructions for the resume. These notes are not displayed on the resume, they are only visible to the author of the resume when editing the resume. This should be a HTML-formatted string."}},"required":["template","layout","css","page","design","typography","notes"],"description":"Metadata for the resume, such as template, layout, typography, etc. This section describes the overall design and appearance of the resume."}},"required":["picture","basics","summary","sections","customSections","metadata"]},"isPublic":{"type":"boolean"},"isLocked":{"type":"boolean"},"hasPassword":{"type":"boolean"}},"required":["id","name","slug","tags","data","isPublic","isLocked","hasPassword"]}}}}}},"put":{"operationId":"resume.update","summary":"Update a resume","description":"Update a resume, along with its data, by its ID.","tags":["Resume"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"data":{"type":"object","properties":{"picture":{"type":"object","properties":{"hidden":{"type":"boolean","description":"Whether to hide the picture from the resume."},"url":{"type":"string","description":"The URL to the picture to display on the resume. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"size":{"type":"number","minimum":32,"maximum":512,"description":"The size of the picture to display on the resume, defined in points (pt)."},"rotation":{"type":"number","minimum":0,"maximum":360,"description":"The rotation of the picture to display on the resume, defined in degrees (°)."},"aspectRatio":{"type":"number","minimum":0.5,"maximum":2.5,"description":"The aspect ratio of the picture to display on the resume, defined as width / height (e.g. 1.5 for 1.5:1 or 0.5 for 1:2)."},"borderRadius":{"type":"number","minimum":0,"maximum":100,"description":"The border radius of the picture to display on the resume, defined in points (pt)."},"borderColor":{"type":"string","description":"The color of the border of the picture to display on the resume, defined as rgba(r, g, b, a)."},"borderWidth":{"type":"number","minimum":0,"description":"The width of the border of the picture to display on the resume, defined in points (pt)."},"shadowColor":{"type":"string","description":"The color of the shadow of the picture to display on the resume, defined as rgba(r, g, b, a)."},"shadowWidth":{"type":"number","minimum":0,"description":"The width of the shadow of the picture to display on the resume, defined in points (pt)."}},"required":["hidden","url","size","rotation","aspectRatio","borderRadius","borderColor","borderWidth","shadowColor","shadowWidth"],"description":"Configuration for photograph displayed on the resume"},"basics":{"type":"object","properties":{"name":{"type":"string","description":"The full name of the author of the resume."},"headline":{"type":"string","description":"The headline of the author of the resume."},"email":{"anyOf":[{"type":"string","format":"email"},{"const":""}],"description":"The email address of the author of the resume. Leave blank to hide."},"phone":{"type":"string","description":"The phone number of the author of the resume. Leave blank to hide."},"location":{"type":"string","description":"The location of the author of the resume."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The website of the author of the resume."},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the custom field. Usually generated as a UUID."},"icon":{"type":"string","description":"The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."},"text":{"type":"string","description":"The text to display for the custom field."}},"required":["id","icon","text"]},"description":"The custom fields to display on the resume."}},"required":["name","headline","email","phone","location","website","customFields"],"description":"Basic information about the author, such as name, email, phone, location, and website"},"summary":{"type":"object","properties":{"title":{"type":"string","description":"The title of the summary of the resume."},"columns":{"type":"number","description":"The number of columns the summary should span across."},"hidden":{"type":"boolean","description":"Whether to hide the summary from the resume."},"content":{"type":"string","description":"The content of the summary of the resume. This should be a HTML-formatted string. Leave blank to hide."}},"required":["title","columns","hidden","content"],"description":"Summary section of the resume, useful for a short bio or introduction"},"sections":{"type":"object","properties":{"profiles":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"icon":{"type":"string","description":"The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."},"network":{"type":"string","minLength":1,"description":"The name of the network or platform."},"username":{"type":"string","description":"The username of the author on the network or platform."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The link to the profile of the author on the network or platform, if any."}},"required":["id","hidden","icon","network","username","website"]},"description":"The items to display in the profiles section."}},"required":["title","columns","hidden","items"],"description":"The section to display the profiles of the author."},"experience":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"company":{"type":"string","minLength":1,"description":"The name of the company or organization."},"position":{"type":"string","description":"The position held at the company or organization."},"location":{"type":"string","description":"The location of the company or organization."},"period":{"type":"string","description":"The period of time the author was employed at the company or organization."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The website of the company or organization, if any."},"description":{"type":"string","description":"The description of the experience. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","company","position","location","period","website","description"]},"description":"The items to display in the experience section."}},"required":["title","columns","hidden","items"],"description":"The section to display the experience of the author."},"education":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"school":{"type":"string","minLength":1,"description":"The name of the school or institution."},"degree":{"type":"string","description":"The degree or qualification obtained."},"area":{"type":"string","description":"The area of study or specialization."},"grade":{"type":"string","description":"The grade or score achieved."},"location":{"type":"string","description":"The location of the school or institution."},"period":{"type":"string","description":"The period of time the education was obtained over."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The website of the school or institution, if any."},"description":{"type":"string","description":"The description of the education. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","school","degree","area","grade","location","period","website","description"]},"description":"The items to display in the education section."}},"required":["title","columns","hidden","items"],"description":"The section to display the education of the author."},"projects":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"name":{"type":"string","minLength":1,"description":"The name of the project."},"period":{"type":"string","description":"The period of time the project was worked on."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The link to the project, if any."},"description":{"type":"string","description":"The description of the project. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","name","period","website","description"]},"description":"The items to display in the projects section."}},"required":["title","columns","hidden","items"],"description":"The section to display the projects of the author."},"skills":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"icon":{"type":"string","description":"The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."},"name":{"type":"string","minLength":1,"description":"The name of the skill."},"proficiency":{"type":"string","description":"The proficiency level of the skill. Can be any text, such as 'Beginner', 'Intermediate', 'Advanced', etc."},"level":{"type":"number","minimum":0,"maximum":5,"description":"The proficiency level of the skill, defined as a number between 0 and 5. If set to 0, the icons displaying the level will be hidden."},"keywords":{"type":"array","items":{"type":"string"},"description":"The keywords associated with the skill, if any. These are displayed as tags below the name."}},"required":["id","hidden","icon","name","proficiency","level","keywords"]},"description":"The items to display in the skills section."}},"required":["title","columns","hidden","items"],"description":"The section to display the skills of the author."},"languages":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"language":{"type":"string","minLength":1,"description":"The name of the language the author knows."},"fluency":{"type":"string","description":"The fluency level of the language. Can be any text, such as 'Native', 'Fluent', 'Conversational', etc. or can also be a CEFR level (A1, A2, B1, B2, C1, C2)."},"level":{"type":"number","minimum":0,"maximum":5,"description":"The proficiency level of the language, defined as a number between 0 and 5. If set to 0, the icons displaying the level will be hidden."}},"required":["id","hidden","language","fluency","level"]},"description":"The items to display in the languages section."}},"required":["title","columns","hidden","items"],"description":"The section to display the languages of the author."},"interests":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"icon":{"type":"string","description":"The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."},"name":{"type":"string","minLength":1,"description":"The name of the interest/hobby."},"keywords":{"type":"array","items":{"type":"string"},"description":"The keywords associated with the interest/hobby, if any. These are displayed as tags below the name."}},"required":["id","hidden","icon","name","keywords"]},"description":"The items to display in the interests section."}},"required":["title","columns","hidden","items"],"description":"The section to display the interests of the author."},"awards":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"title":{"type":"string","minLength":1,"description":"The title of the award."},"awarder":{"type":"string","description":"The awarder of the award."},"date":{"type":"string","description":"The date when the award was received."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The website of the award, if any."},"description":{"type":"string","description":"The description of the award. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","title","awarder","date","website","description"]},"description":"The items to display in the awards section."}},"required":["title","columns","hidden","items"],"description":"The section to display the awards of the author."},"certifications":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"title":{"type":"string","minLength":1,"description":"The title of the certification."},"issuer":{"type":"string","description":"The issuer of the certification."},"date":{"type":"string","description":"The date when the certification was received."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The website of the certification, if any."},"description":{"type":"string","description":"The description of the certification. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","title","issuer","date","website","description"]},"description":"The items to display in the certifications section."}},"required":["title","columns","hidden","items"],"description":"The section to display the certifications of the author."},"publications":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"title":{"type":"string","minLength":1,"description":"The title of the publication."},"publisher":{"type":"string","description":"The publisher of the publication."},"date":{"type":"string","description":"The date when the publication was published."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The link to the publication, if any."},"description":{"type":"string","description":"The description of the publication. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","title","publisher","date","website","description"]},"description":"The items to display in the publications section."}},"required":["title","columns","hidden","items"],"description":"The section to display the publications of the author."},"volunteer":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"organization":{"type":"string","minLength":1,"description":"The name of the organization or company."},"location":{"type":"string","description":"The location of the organization or company."},"period":{"type":"string","description":"The period of time the author was volunteered at the organization or company."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The link to the organization or company, if any."},"description":{"type":"string","description":"The description of the volunteer experience. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","organization","location","period","website","description"]},"description":"The items to display in the volunteer section."}},"required":["title","columns","hidden","items"],"description":"The section to display the volunteer experience of the author."},"references":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"name":{"type":"string","minLength":1,"description":"The name of the reference, or a note such as 'Available upon request'."},"description":{"type":"string","description":"The description of the reference. Can be used to display a quote, a testimonial, etc. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","name","description"]},"description":"The items to display in the references section."}},"required":["title","columns","hidden","items"],"description":"The section to display the references of the author."}},"required":["profiles","experience","education","projects","skills","languages","interests","awards","certifications","publications","volunteer","references"],"description":"Various sections of the resume, such as experience, education, projects, etc."},"customSections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"id":{"type":"string","description":"The unique identifier for the custom section. Usually generated as a UUID."},"content":{"type":"string","description":"The content of the custom section. This should be a HTML-formatted string. Leave blank to hide."}},"required":["title","columns","hidden","id","content"]},"description":"Custom sections of the resume, such as a custom section for notes, etc."},"metadata":{"type":"object","properties":{"template":{"enum":["azurill","bronzor","chikorita","ditto","gengar","glalie","kakuna","lapras","leafish","onyx","pikachu","rhyhorn"],"description":"The template to use for the resume. Determines the overall design and appearance of the resume."},"layout":{"type":"object","properties":{"sidebarWidth":{"type":"number","minimum":10,"maximum":50,"description":"The width of the sidebar column, defined as a percentage of the page width."},"pages":{"type":"array","items":{"type":"object","properties":{"fullWidth":{"type":"boolean","description":"Whether the layout of the page should be full width. If true, the main column will span the entire width of the page. This means that there should be no items in the sidebar column."},"main":{"type":"array","items":{"type":"string"},"description":"The items to display in the main column of the page. A string array of section IDs (experience, education, projects, skills, languages, interests, awards, certifications, publications, volunteer, references, profiles, summary or UUIDs for custom sections)."},"sidebar":{"type":"array","items":{"type":"string"},"description":"The items to display in the sidebar column of the page. A string array of section IDs (experience, education, projects, skills, languages, interests, awards, certifications, publications, volunteer, references, profiles, summary or UUIDs for custom sections)."}},"required":["fullWidth","main","sidebar"]},"description":"The pages to display in the layout."}},"required":["sidebarWidth","pages"],"description":"The layout of the resume. Determines the structure and arrangement of the sections on the resume."},"css":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether to enable custom CSS for the resume."},"value":{"type":"string","description":"The custom CSS to apply to the resume. This should be a valid CSS string."}},"required":["enabled","value"],"description":"Custom CSS to apply to the resume. Can be used to override the default styles of the template."},"page":{"type":"object","properties":{"gapX":{"type":"number","minimum":0,"description":"The horizontal gap between the sections of the page, defined in points (pt)."},"gapY":{"type":"number","minimum":0,"description":"The vertical gap between the sections of the page, defined in points (pt)."},"marginX":{"type":"number","minimum":0,"description":"The horizontal margin of the page, defined in points (pt)."},"marginY":{"type":"number","minimum":0,"description":"The vertical margin of the page, defined in points (pt)."},"format":{"enum":["a4","letter"],"description":"The format of the page. Can be 'a4' or 'letter'."},"locale":{"anyOf":[{"const":"af-ZA"},{"const":"am-ET"},{"const":"ar-SA"},{"const":"az-AZ"},{"const":"bg-BG"},{"const":"bn-BD"},{"const":"ca-ES"},{"const":"cs-CZ"},{"const":"da-DK"},{"const":"de-DE"},{"const":"el-GR"},{"const":"en-US"},{"const":"es-ES"},{"const":"fa-IR"},{"const":"fi-FI"},{"const":"fr-FR"},{"const":"he-IL"},{"const":"hi-IN"},{"const":"hu-HU"},{"const":"id-ID"},{"const":"it-IT"},{"const":"ja-JP"},{"const":"km-KH"},{"const":"kn-IN"},{"const":"ko-KR"},{"const":"lt-LT"},{"const":"lv-LV"},{"const":"ml-IN"},{"const":"mr-IN"},{"const":"ms-MY"},{"const":"ne-NP"},{"const":"nl-NL"},{"const":"no-NO"},{"const":"or-IN"},{"const":"pl-PL"},{"const":"pt-BR"},{"const":"pt-PT"},{"const":"ro-RO"},{"const":"ru-RU"},{"const":"sk-SK"},{"const":"sq-AL"},{"const":"sr-SP"},{"const":"sv-SE"},{"const":"ta-IN"},{"const":"te-IN"},{"const":"th-TH"},{"const":"tr-TR"},{"const":"uk-UA"},{"const":"uz-UZ"},{"const":"vi-VN"},{"const":"zh-CN"},{"const":"zh-TW"},{"const":"zu-ZA"}],"description":"The language used in the resume, used for displaying pre-translated section headings, if not overridden."}},"required":["gapX","gapY","marginX","marginY","format","locale"],"description":"The page settings of the resume. Determines the margins, format, and locale of the resume."},"design":{"type":"object","properties":{"level":{"type":"object","properties":{"icon":{"type":"string","description":"The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."},"type":{"enum":["hidden","circle","square","rectangle","rectangle-full","progress-bar","icon"],"description":"The type of the level design. 'hidden' will hide the level design, 'circle' will display a circle, 'square' will display a square, 'rectangle' will display a rectangle, 'rectangle-full' will display a full rectangle, 'progress-bar' will display a progress bar, and 'icon' will display an icon. If 'icon' is selected, the icon to display should be specified in the 'icon' field."}},"required":["icon","type"]},"colors":{"type":"object","properties":{"primary":{"type":"string","description":"The primary color of the design, defined as rgba(r, g, b, a)."},"text":{"type":"string","description":"The text color of the design, defined as rgba(r, g, b, a). Usually set to black: rgba(0, 0, 0, 1)."},"background":{"type":"string","description":"The background color of the design, defined as rgba(r, g, b, a). Usually set to white: rgba(255, 255, 255, 1)."}},"required":["primary","text","background"]}},"required":["level","colors"],"description":"The design settings of the resume. Determines the colors, level designs, and typography of the resume."},"typography":{"type":"object","properties":{"body":{"type":"object","properties":{"fontFamily":{"type":"string","description":"The family of the font to use. Must be a font that is available on Google Fonts."},"fontWeights":{"type":"array","items":{"enum":["100","200","300","400","500","600","700","800","900"]},"description":"The weight of the font, defined as a number between 100 and 900. Default to 400 when unsure if the weight is available in the font."},"fontSize":{"type":"number","minimum":6,"maximum":24,"description":"The size of the font to use, defined in points (pt)."},"lineHeight":{"type":"number","minimum":0.5,"maximum":4,"description":"The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x)."}},"required":["fontFamily","fontWeights","fontSize","lineHeight"],"description":"The typography for the body of the resume."},"heading":{"type":"object","properties":{"fontFamily":{"type":"string","description":"The family of the font to use. Must be a font that is available on Google Fonts."},"fontWeights":{"type":"array","items":{"enum":["100","200","300","400","500","600","700","800","900"]},"description":"The weight of the font, defined as a number between 100 and 900. Default to 400 when unsure if the weight is available in the font."},"fontSize":{"type":"number","minimum":6,"maximum":24,"description":"The size of the font to use, defined in points (pt)."},"lineHeight":{"type":"number","minimum":0.5,"maximum":4,"description":"The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x)."}},"required":["fontFamily","fontWeights","fontSize","lineHeight"],"description":"The typography for the headings of the resume."}},"required":["body","heading"],"description":"The typography settings of the resume. Determines the fonts and sizes of the body and headings of the resume."},"notes":{"type":"string","description":"Personal notes for the resume. Can be used to add any additional information or instructions for the resume. These notes are not displayed on the resume, they are only visible to the author of the resume when editing the resume. This should be a HTML-formatted string."}},"required":["template","layout","css","page","design","typography","notes"],"description":"Metadata for the resume, such as template, layout, typography, etc. This section describes the overall design and appearance of the resume."}},"required":["picture","basics","summary","sections","customSections","metadata"]},"isPublic":{"type":"boolean"}},"required":[]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}},"delete":{"operationId":"resume.delete","summary":"Delete a resume","description":"Delete a resume, by its ID.","tags":["Resume"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/resume/{username}/{slug}":{"get":{"operationId":"resume.getBySlug","summary":"Get resume by username and slug","description":"Get a resume, along with its data, by its username and slug.","tags":["Resume"],"parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string"}},{"name":"slug","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"data":{"type":"object","properties":{"picture":{"type":"object","properties":{"hidden":{"type":"boolean","description":"Whether to hide the picture from the resume."},"url":{"type":"string","description":"The URL to the picture to display on the resume. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"size":{"type":"number","minimum":32,"maximum":512,"description":"The size of the picture to display on the resume, defined in points (pt)."},"rotation":{"type":"number","minimum":0,"maximum":360,"description":"The rotation of the picture to display on the resume, defined in degrees (°)."},"aspectRatio":{"type":"number","minimum":0.5,"maximum":2.5,"description":"The aspect ratio of the picture to display on the resume, defined as width / height (e.g. 1.5 for 1.5:1 or 0.5 for 1:2)."},"borderRadius":{"type":"number","minimum":0,"maximum":100,"description":"The border radius of the picture to display on the resume, defined in points (pt)."},"borderColor":{"type":"string","description":"The color of the border of the picture to display on the resume, defined as rgba(r, g, b, a)."},"borderWidth":{"type":"number","minimum":0,"description":"The width of the border of the picture to display on the resume, defined in points (pt)."},"shadowColor":{"type":"string","description":"The color of the shadow of the picture to display on the resume, defined as rgba(r, g, b, a)."},"shadowWidth":{"type":"number","minimum":0,"description":"The width of the shadow of the picture to display on the resume, defined in points (pt)."}},"required":["hidden","url","size","rotation","aspectRatio","borderRadius","borderColor","borderWidth","shadowColor","shadowWidth"],"description":"Configuration for photograph displayed on the resume"},"basics":{"type":"object","properties":{"name":{"type":"string","description":"The full name of the author of the resume."},"headline":{"type":"string","description":"The headline of the author of the resume."},"email":{"anyOf":[{"type":"string","format":"email"},{"const":""}],"description":"The email address of the author of the resume. Leave blank to hide."},"phone":{"type":"string","description":"The phone number of the author of the resume. Leave blank to hide."},"location":{"type":"string","description":"The location of the author of the resume."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The website of the author of the resume."},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the custom field. Usually generated as a UUID."},"icon":{"type":"string","description":"The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."},"text":{"type":"string","description":"The text to display for the custom field."}},"required":["id","icon","text"]},"description":"The custom fields to display on the resume."}},"required":["name","headline","email","phone","location","website","customFields"],"description":"Basic information about the author, such as name, email, phone, location, and website"},"summary":{"type":"object","properties":{"title":{"type":"string","description":"The title of the summary of the resume."},"columns":{"type":"number","description":"The number of columns the summary should span across."},"hidden":{"type":"boolean","description":"Whether to hide the summary from the resume."},"content":{"type":"string","description":"The content of the summary of the resume. This should be a HTML-formatted string. Leave blank to hide."}},"required":["title","columns","hidden","content"],"description":"Summary section of the resume, useful for a short bio or introduction"},"sections":{"type":"object","properties":{"profiles":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"icon":{"type":"string","description":"The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."},"network":{"type":"string","minLength":1,"description":"The name of the network or platform."},"username":{"type":"string","description":"The username of the author on the network or platform."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The link to the profile of the author on the network or platform, if any."}},"required":["id","hidden","icon","network","username","website"]},"description":"The items to display in the profiles section."}},"required":["title","columns","hidden","items"],"description":"The section to display the profiles of the author."},"experience":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"company":{"type":"string","minLength":1,"description":"The name of the company or organization."},"position":{"type":"string","description":"The position held at the company or organization."},"location":{"type":"string","description":"The location of the company or organization."},"period":{"type":"string","description":"The period of time the author was employed at the company or organization."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The website of the company or organization, if any."},"description":{"type":"string","description":"The description of the experience. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","company","position","location","period","website","description"]},"description":"The items to display in the experience section."}},"required":["title","columns","hidden","items"],"description":"The section to display the experience of the author."},"education":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"school":{"type":"string","minLength":1,"description":"The name of the school or institution."},"degree":{"type":"string","description":"The degree or qualification obtained."},"area":{"type":"string","description":"The area of study or specialization."},"grade":{"type":"string","description":"The grade or score achieved."},"location":{"type":"string","description":"The location of the school or institution."},"period":{"type":"string","description":"The period of time the education was obtained over."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The website of the school or institution, if any."},"description":{"type":"string","description":"The description of the education. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","school","degree","area","grade","location","period","website","description"]},"description":"The items to display in the education section."}},"required":["title","columns","hidden","items"],"description":"The section to display the education of the author."},"projects":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"name":{"type":"string","minLength":1,"description":"The name of the project."},"period":{"type":"string","description":"The period of time the project was worked on."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The link to the project, if any."},"description":{"type":"string","description":"The description of the project. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","name","period","website","description"]},"description":"The items to display in the projects section."}},"required":["title","columns","hidden","items"],"description":"The section to display the projects of the author."},"skills":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"icon":{"type":"string","description":"The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."},"name":{"type":"string","minLength":1,"description":"The name of the skill."},"proficiency":{"type":"string","description":"The proficiency level of the skill. Can be any text, such as 'Beginner', 'Intermediate', 'Advanced', etc."},"level":{"type":"number","minimum":0,"maximum":5,"description":"The proficiency level of the skill, defined as a number between 0 and 5. If set to 0, the icons displaying the level will be hidden."},"keywords":{"type":"array","items":{"type":"string"},"description":"The keywords associated with the skill, if any. These are displayed as tags below the name."}},"required":["id","hidden","icon","name","proficiency","level","keywords"]},"description":"The items to display in the skills section."}},"required":["title","columns","hidden","items"],"description":"The section to display the skills of the author."},"languages":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"language":{"type":"string","minLength":1,"description":"The name of the language the author knows."},"fluency":{"type":"string","description":"The fluency level of the language. Can be any text, such as 'Native', 'Fluent', 'Conversational', etc. or can also be a CEFR level (A1, A2, B1, B2, C1, C2)."},"level":{"type":"number","minimum":0,"maximum":5,"description":"The proficiency level of the language, defined as a number between 0 and 5. If set to 0, the icons displaying the level will be hidden."}},"required":["id","hidden","language","fluency","level"]},"description":"The items to display in the languages section."}},"required":["title","columns","hidden","items"],"description":"The section to display the languages of the author."},"interests":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"icon":{"type":"string","description":"The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."},"name":{"type":"string","minLength":1,"description":"The name of the interest/hobby."},"keywords":{"type":"array","items":{"type":"string"},"description":"The keywords associated with the interest/hobby, if any. These are displayed as tags below the name."}},"required":["id","hidden","icon","name","keywords"]},"description":"The items to display in the interests section."}},"required":["title","columns","hidden","items"],"description":"The section to display the interests of the author."},"awards":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"title":{"type":"string","minLength":1,"description":"The title of the award."},"awarder":{"type":"string","description":"The awarder of the award."},"date":{"type":"string","description":"The date when the award was received."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The website of the award, if any."},"description":{"type":"string","description":"The description of the award. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","title","awarder","date","website","description"]},"description":"The items to display in the awards section."}},"required":["title","columns","hidden","items"],"description":"The section to display the awards of the author."},"certifications":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"title":{"type":"string","minLength":1,"description":"The title of the certification."},"issuer":{"type":"string","description":"The issuer of the certification."},"date":{"type":"string","description":"The date when the certification was received."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The website of the certification, if any."},"description":{"type":"string","description":"The description of the certification. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","title","issuer","date","website","description"]},"description":"The items to display in the certifications section."}},"required":["title","columns","hidden","items"],"description":"The section to display the certifications of the author."},"publications":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"title":{"type":"string","minLength":1,"description":"The title of the publication."},"publisher":{"type":"string","description":"The publisher of the publication."},"date":{"type":"string","description":"The date when the publication was published."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The link to the publication, if any."},"description":{"type":"string","description":"The description of the publication. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","title","publisher","date","website","description"]},"description":"The items to display in the publications section."}},"required":["title","columns","hidden","items"],"description":"The section to display the publications of the author."},"volunteer":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"organization":{"type":"string","minLength":1,"description":"The name of the organization or company."},"location":{"type":"string","description":"The location of the organization or company."},"period":{"type":"string","description":"The period of time the author was volunteered at the organization or company."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The link to the organization or company, if any."},"description":{"type":"string","description":"The description of the volunteer experience. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","organization","location","period","website","description"]},"description":"The items to display in the volunteer section."}},"required":["title","columns","hidden","items"],"description":"The section to display the volunteer experience of the author."},"references":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"name":{"type":"string","minLength":1,"description":"The name of the reference, or a note such as 'Available upon request'."},"description":{"type":"string","description":"The description of the reference. Can be used to display a quote, a testimonial, etc. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","name","description"]},"description":"The items to display in the references section."}},"required":["title","columns","hidden","items"],"description":"The section to display the references of the author."}},"required":["profiles","experience","education","projects","skills","languages","interests","awards","certifications","publications","volunteer","references"],"description":"Various sections of the resume, such as experience, education, projects, etc."},"customSections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"id":{"type":"string","description":"The unique identifier for the custom section. Usually generated as a UUID."},"content":{"type":"string","description":"The content of the custom section. This should be a HTML-formatted string. Leave blank to hide."}},"required":["title","columns","hidden","id","content"]},"description":"Custom sections of the resume, such as a custom section for notes, etc."},"metadata":{"type":"object","properties":{"template":{"enum":["azurill","bronzor","chikorita","ditto","gengar","glalie","kakuna","lapras","leafish","onyx","pikachu","rhyhorn"],"description":"The template to use for the resume. Determines the overall design and appearance of the resume."},"layout":{"type":"object","properties":{"sidebarWidth":{"type":"number","minimum":10,"maximum":50,"description":"The width of the sidebar column, defined as a percentage of the page width."},"pages":{"type":"array","items":{"type":"object","properties":{"fullWidth":{"type":"boolean","description":"Whether the layout of the page should be full width. If true, the main column will span the entire width of the page. This means that there should be no items in the sidebar column."},"main":{"type":"array","items":{"type":"string"},"description":"The items to display in the main column of the page. A string array of section IDs (experience, education, projects, skills, languages, interests, awards, certifications, publications, volunteer, references, profiles, summary or UUIDs for custom sections)."},"sidebar":{"type":"array","items":{"type":"string"},"description":"The items to display in the sidebar column of the page. A string array of section IDs (experience, education, projects, skills, languages, interests, awards, certifications, publications, volunteer, references, profiles, summary or UUIDs for custom sections)."}},"required":["fullWidth","main","sidebar"]},"description":"The pages to display in the layout."}},"required":["sidebarWidth","pages"],"description":"The layout of the resume. Determines the structure and arrangement of the sections on the resume."},"css":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether to enable custom CSS for the resume."},"value":{"type":"string","description":"The custom CSS to apply to the resume. This should be a valid CSS string."}},"required":["enabled","value"],"description":"Custom CSS to apply to the resume. Can be used to override the default styles of the template."},"page":{"type":"object","properties":{"gapX":{"type":"number","minimum":0,"description":"The horizontal gap between the sections of the page, defined in points (pt)."},"gapY":{"type":"number","minimum":0,"description":"The vertical gap between the sections of the page, defined in points (pt)."},"marginX":{"type":"number","minimum":0,"description":"The horizontal margin of the page, defined in points (pt)."},"marginY":{"type":"number","minimum":0,"description":"The vertical margin of the page, defined in points (pt)."},"format":{"enum":["a4","letter"],"description":"The format of the page. Can be 'a4' or 'letter'."},"locale":{"anyOf":[{"const":"af-ZA"},{"const":"am-ET"},{"const":"ar-SA"},{"const":"az-AZ"},{"const":"bg-BG"},{"const":"bn-BD"},{"const":"ca-ES"},{"const":"cs-CZ"},{"const":"da-DK"},{"const":"de-DE"},{"const":"el-GR"},{"const":"en-US"},{"const":"es-ES"},{"const":"fa-IR"},{"const":"fi-FI"},{"const":"fr-FR"},{"const":"he-IL"},{"const":"hi-IN"},{"const":"hu-HU"},{"const":"id-ID"},{"const":"it-IT"},{"const":"ja-JP"},{"const":"km-KH"},{"const":"kn-IN"},{"const":"ko-KR"},{"const":"lt-LT"},{"const":"lv-LV"},{"const":"ml-IN"},{"const":"mr-IN"},{"const":"ms-MY"},{"const":"ne-NP"},{"const":"nl-NL"},{"const":"no-NO"},{"const":"or-IN"},{"const":"pl-PL"},{"const":"pt-BR"},{"const":"pt-PT"},{"const":"ro-RO"},{"const":"ru-RU"},{"const":"sk-SK"},{"const":"sq-AL"},{"const":"sr-SP"},{"const":"sv-SE"},{"const":"ta-IN"},{"const":"te-IN"},{"const":"th-TH"},{"const":"tr-TR"},{"const":"uk-UA"},{"const":"uz-UZ"},{"const":"vi-VN"},{"const":"zh-CN"},{"const":"zh-TW"},{"const":"zu-ZA"}],"description":"The language used in the resume, used for displaying pre-translated section headings, if not overridden."}},"required":["gapX","gapY","marginX","marginY","format","locale"],"description":"The page settings of the resume. Determines the margins, format, and locale of the resume."},"design":{"type":"object","properties":{"level":{"type":"object","properties":{"icon":{"type":"string","description":"The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."},"type":{"enum":["hidden","circle","square","rectangle","rectangle-full","progress-bar","icon"],"description":"The type of the level design. 'hidden' will hide the level design, 'circle' will display a circle, 'square' will display a square, 'rectangle' will display a rectangle, 'rectangle-full' will display a full rectangle, 'progress-bar' will display a progress bar, and 'icon' will display an icon. If 'icon' is selected, the icon to display should be specified in the 'icon' field."}},"required":["icon","type"]},"colors":{"type":"object","properties":{"primary":{"type":"string","description":"The primary color of the design, defined as rgba(r, g, b, a)."},"text":{"type":"string","description":"The text color of the design, defined as rgba(r, g, b, a). Usually set to black: rgba(0, 0, 0, 1)."},"background":{"type":"string","description":"The background color of the design, defined as rgba(r, g, b, a). Usually set to white: rgba(255, 255, 255, 1)."}},"required":["primary","text","background"]}},"required":["level","colors"],"description":"The design settings of the resume. Determines the colors, level designs, and typography of the resume."},"typography":{"type":"object","properties":{"body":{"type":"object","properties":{"fontFamily":{"type":"string","description":"The family of the font to use. Must be a font that is available on Google Fonts."},"fontWeights":{"type":"array","items":{"enum":["100","200","300","400","500","600","700","800","900"]},"description":"The weight of the font, defined as a number between 100 and 900. Default to 400 when unsure if the weight is available in the font."},"fontSize":{"type":"number","minimum":6,"maximum":24,"description":"The size of the font to use, defined in points (pt)."},"lineHeight":{"type":"number","minimum":0.5,"maximum":4,"description":"The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x)."}},"required":["fontFamily","fontWeights","fontSize","lineHeight"],"description":"The typography for the body of the resume."},"heading":{"type":"object","properties":{"fontFamily":{"type":"string","description":"The family of the font to use. Must be a font that is available on Google Fonts."},"fontWeights":{"type":"array","items":{"enum":["100","200","300","400","500","600","700","800","900"]},"description":"The weight of the font, defined as a number between 100 and 900. Default to 400 when unsure if the weight is available in the font."},"fontSize":{"type":"number","minimum":6,"maximum":24,"description":"The size of the font to use, defined in points (pt)."},"lineHeight":{"type":"number","minimum":0.5,"maximum":4,"description":"The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x)."}},"required":["fontFamily","fontWeights","fontSize","lineHeight"],"description":"The typography for the headings of the resume."}},"required":["body","heading"],"description":"The typography settings of the resume. Determines the fonts and sizes of the body and headings of the resume."},"notes":{"type":"string","description":"Personal notes for the resume. Can be used to add any additional information or instructions for the resume. These notes are not displayed on the resume, they are only visible to the author of the resume when editing the resume. This should be a HTML-formatted string."}},"required":["template","layout","css","page","design","typography","notes"],"description":"Metadata for the resume, such as template, layout, typography, etc. This section describes the overall design and appearance of the resume."}},"required":["picture","basics","summary","sections","customSections","metadata"]},"isPublic":{"type":"boolean"},"isLocked":{"type":"boolean"}},"required":["id","name","slug","tags","data","isPublic","isLocked"]}}}}}}},"/resume/create":{"post":{"operationId":"resume.create","summary":"Create a new resume","description":"Create a new resume, with the ability to initialize it with sample data.","tags":["Resume"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"slug":{"type":"string","minLength":1,"maxLength":64},"tags":{"type":"array","items":{"type":"string"}},"withSampleData":{"type":"boolean","default":false}},"required":["name","slug","tags"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","description":"The ID of the created resume."}}}}}}},"/resume/import":{"post":{"operationId":"resume.import","summary":"Import a resume","description":"Import a resume from a file.","tags":["Resume"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"picture":{"type":"object","properties":{"hidden":{"type":"boolean","description":"Whether to hide the picture from the resume."},"url":{"type":"string","description":"The URL to the picture to display on the resume. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"size":{"type":"number","minimum":32,"maximum":512,"description":"The size of the picture to display on the resume, defined in points (pt)."},"rotation":{"type":"number","minimum":0,"maximum":360,"description":"The rotation of the picture to display on the resume, defined in degrees (°)."},"aspectRatio":{"type":"number","minimum":0.5,"maximum":2.5,"description":"The aspect ratio of the picture to display on the resume, defined as width / height (e.g. 1.5 for 1.5:1 or 0.5 for 1:2)."},"borderRadius":{"type":"number","minimum":0,"maximum":100,"description":"The border radius of the picture to display on the resume, defined in points (pt)."},"borderColor":{"type":"string","description":"The color of the border of the picture to display on the resume, defined as rgba(r, g, b, a)."},"borderWidth":{"type":"number","minimum":0,"description":"The width of the border of the picture to display on the resume, defined in points (pt)."},"shadowColor":{"type":"string","description":"The color of the shadow of the picture to display on the resume, defined as rgba(r, g, b, a)."},"shadowWidth":{"type":"number","minimum":0,"description":"The width of the shadow of the picture to display on the resume, defined in points (pt)."}},"required":["hidden","url","size","rotation","aspectRatio","borderRadius","borderColor","borderWidth","shadowColor","shadowWidth"],"description":"Configuration for photograph displayed on the resume"},"basics":{"type":"object","properties":{"name":{"type":"string","description":"The full name of the author of the resume."},"headline":{"type":"string","description":"The headline of the author of the resume."},"email":{"anyOf":[{"type":"string","format":"email"},{"const":""}],"description":"The email address of the author of the resume. Leave blank to hide."},"phone":{"type":"string","description":"The phone number of the author of the resume. Leave blank to hide."},"location":{"type":"string","description":"The location of the author of the resume."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The website of the author of the resume."},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the custom field. Usually generated as a UUID."},"icon":{"type":"string","description":"The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."},"text":{"type":"string","description":"The text to display for the custom field."}},"required":["id","icon","text"]},"description":"The custom fields to display on the resume."}},"required":["name","headline","email","phone","location","website","customFields"],"description":"Basic information about the author, such as name, email, phone, location, and website"},"summary":{"type":"object","properties":{"title":{"type":"string","description":"The title of the summary of the resume."},"columns":{"type":"number","description":"The number of columns the summary should span across."},"hidden":{"type":"boolean","description":"Whether to hide the summary from the resume."},"content":{"type":"string","description":"The content of the summary of the resume. This should be a HTML-formatted string. Leave blank to hide."}},"required":["title","columns","hidden","content"],"description":"Summary section of the resume, useful for a short bio or introduction"},"sections":{"type":"object","properties":{"profiles":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"icon":{"type":"string","description":"The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."},"network":{"type":"string","minLength":1,"description":"The name of the network or platform."},"username":{"type":"string","description":"The username of the author on the network or platform."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The link to the profile of the author on the network or platform, if any."}},"required":["id","hidden","icon","network","username","website"]},"description":"The items to display in the profiles section."}},"required":["title","columns","hidden","items"],"description":"The section to display the profiles of the author."},"experience":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"company":{"type":"string","minLength":1,"description":"The name of the company or organization."},"position":{"type":"string","description":"The position held at the company or organization."},"location":{"type":"string","description":"The location of the company or organization."},"period":{"type":"string","description":"The period of time the author was employed at the company or organization."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The website of the company or organization, if any."},"description":{"type":"string","description":"The description of the experience. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","company","position","location","period","website","description"]},"description":"The items to display in the experience section."}},"required":["title","columns","hidden","items"],"description":"The section to display the experience of the author."},"education":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"school":{"type":"string","minLength":1,"description":"The name of the school or institution."},"degree":{"type":"string","description":"The degree or qualification obtained."},"area":{"type":"string","description":"The area of study or specialization."},"grade":{"type":"string","description":"The grade or score achieved."},"location":{"type":"string","description":"The location of the school or institution."},"period":{"type":"string","description":"The period of time the education was obtained over."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The website of the school or institution, if any."},"description":{"type":"string","description":"The description of the education. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","school","degree","area","grade","location","period","website","description"]},"description":"The items to display in the education section."}},"required":["title","columns","hidden","items"],"description":"The section to display the education of the author."},"projects":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"name":{"type":"string","minLength":1,"description":"The name of the project."},"period":{"type":"string","description":"The period of time the project was worked on."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The link to the project, if any."},"description":{"type":"string","description":"The description of the project. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","name","period","website","description"]},"description":"The items to display in the projects section."}},"required":["title","columns","hidden","items"],"description":"The section to display the projects of the author."},"skills":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"icon":{"type":"string","description":"The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."},"name":{"type":"string","minLength":1,"description":"The name of the skill."},"proficiency":{"type":"string","description":"The proficiency level of the skill. Can be any text, such as 'Beginner', 'Intermediate', 'Advanced', etc."},"level":{"type":"number","minimum":0,"maximum":5,"description":"The proficiency level of the skill, defined as a number between 0 and 5. If set to 0, the icons displaying the level will be hidden."},"keywords":{"type":"array","items":{"type":"string"},"description":"The keywords associated with the skill, if any. These are displayed as tags below the name."}},"required":["id","hidden","icon","name","proficiency","level","keywords"]},"description":"The items to display in the skills section."}},"required":["title","columns","hidden","items"],"description":"The section to display the skills of the author."},"languages":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"language":{"type":"string","minLength":1,"description":"The name of the language the author knows."},"fluency":{"type":"string","description":"The fluency level of the language. Can be any text, such as 'Native', 'Fluent', 'Conversational', etc. or can also be a CEFR level (A1, A2, B1, B2, C1, C2)."},"level":{"type":"number","minimum":0,"maximum":5,"description":"The proficiency level of the language, defined as a number between 0 and 5. If set to 0, the icons displaying the level will be hidden."}},"required":["id","hidden","language","fluency","level"]},"description":"The items to display in the languages section."}},"required":["title","columns","hidden","items"],"description":"The section to display the languages of the author."},"interests":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"icon":{"type":"string","description":"The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."},"name":{"type":"string","minLength":1,"description":"The name of the interest/hobby."},"keywords":{"type":"array","items":{"type":"string"},"description":"The keywords associated with the interest/hobby, if any. These are displayed as tags below the name."}},"required":["id","hidden","icon","name","keywords"]},"description":"The items to display in the interests section."}},"required":["title","columns","hidden","items"],"description":"The section to display the interests of the author."},"awards":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"title":{"type":"string","minLength":1,"description":"The title of the award."},"awarder":{"type":"string","description":"The awarder of the award."},"date":{"type":"string","description":"The date when the award was received."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The website of the award, if any."},"description":{"type":"string","description":"The description of the award. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","title","awarder","date","website","description"]},"description":"The items to display in the awards section."}},"required":["title","columns","hidden","items"],"description":"The section to display the awards of the author."},"certifications":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"title":{"type":"string","minLength":1,"description":"The title of the certification."},"issuer":{"type":"string","description":"The issuer of the certification."},"date":{"type":"string","description":"The date when the certification was received."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The website of the certification, if any."},"description":{"type":"string","description":"The description of the certification. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","title","issuer","date","website","description"]},"description":"The items to display in the certifications section."}},"required":["title","columns","hidden","items"],"description":"The section to display the certifications of the author."},"publications":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"title":{"type":"string","minLength":1,"description":"The title of the publication."},"publisher":{"type":"string","description":"The publisher of the publication."},"date":{"type":"string","description":"The date when the publication was published."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The link to the publication, if any."},"description":{"type":"string","description":"The description of the publication. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","title","publisher","date","website","description"]},"description":"The items to display in the publications section."}},"required":["title","columns","hidden","items"],"description":"The section to display the publications of the author."},"volunteer":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"organization":{"type":"string","minLength":1,"description":"The name of the organization or company."},"location":{"type":"string","description":"The location of the organization or company."},"period":{"type":"string","description":"The period of time the author was volunteered at the organization or company."},"website":{"type":"object","properties":{"url":{"type":"string","description":"The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). Leave blank to hide."},"label":{"type":"string","description":"The label to display for the URL. Leave blank to display the URL as-is."}},"required":["url","label"],"description":"The link to the organization or company, if any."},"description":{"type":"string","description":"The description of the volunteer experience. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","organization","location","period","website","description"]},"description":"The items to display in the volunteer section."}},"required":["title","columns","hidden","items"],"description":"The section to display the volunteer experience of the author."},"references":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item. Usually generated as a UUID."},"hidden":{"type":"boolean","description":"Whether to hide the item from the resume."},"name":{"type":"string","minLength":1,"description":"The name of the reference, or a note such as 'Available upon request'."},"description":{"type":"string","description":"The description of the reference. Can be used to display a quote, a testimonial, etc. This should be a HTML-formatted string. Leave blank to hide."}},"required":["id","hidden","name","description"]},"description":"The items to display in the references section."}},"required":["title","columns","hidden","items"],"description":"The section to display the references of the author."}},"required":["profiles","experience","education","projects","skills","languages","interests","awards","certifications","publications","volunteer","references"],"description":"Various sections of the resume, such as experience, education, projects, etc."},"customSections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","description":"The title of the section."},"columns":{"type":"number","description":"The number of columns the section should span across."},"hidden":{"type":"boolean","description":"Whether to hide the section from the resume."},"id":{"type":"string","description":"The unique identifier for the custom section. Usually generated as a UUID."},"content":{"type":"string","description":"The content of the custom section. This should be a HTML-formatted string. Leave blank to hide."}},"required":["title","columns","hidden","id","content"]},"description":"Custom sections of the resume, such as a custom section for notes, etc."},"metadata":{"type":"object","properties":{"template":{"enum":["azurill","bronzor","chikorita","ditto","gengar","glalie","kakuna","lapras","leafish","onyx","pikachu","rhyhorn"],"description":"The template to use for the resume. Determines the overall design and appearance of the resume."},"layout":{"type":"object","properties":{"sidebarWidth":{"type":"number","minimum":10,"maximum":50,"description":"The width of the sidebar column, defined as a percentage of the page width."},"pages":{"type":"array","items":{"type":"object","properties":{"fullWidth":{"type":"boolean","description":"Whether the layout of the page should be full width. If true, the main column will span the entire width of the page. This means that there should be no items in the sidebar column."},"main":{"type":"array","items":{"type":"string"},"description":"The items to display in the main column of the page. A string array of section IDs (experience, education, projects, skills, languages, interests, awards, certifications, publications, volunteer, references, profiles, summary or UUIDs for custom sections)."},"sidebar":{"type":"array","items":{"type":"string"},"description":"The items to display in the sidebar column of the page. A string array of section IDs (experience, education, projects, skills, languages, interests, awards, certifications, publications, volunteer, references, profiles, summary or UUIDs for custom sections)."}},"required":["fullWidth","main","sidebar"]},"description":"The pages to display in the layout."}},"required":["sidebarWidth","pages"],"description":"The layout of the resume. Determines the structure and arrangement of the sections on the resume."},"css":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether to enable custom CSS for the resume."},"value":{"type":"string","description":"The custom CSS to apply to the resume. This should be a valid CSS string."}},"required":["enabled","value"],"description":"Custom CSS to apply to the resume. Can be used to override the default styles of the template."},"page":{"type":"object","properties":{"gapX":{"type":"number","minimum":0,"description":"The horizontal gap between the sections of the page, defined in points (pt)."},"gapY":{"type":"number","minimum":0,"description":"The vertical gap between the sections of the page, defined in points (pt)."},"marginX":{"type":"number","minimum":0,"description":"The horizontal margin of the page, defined in points (pt)."},"marginY":{"type":"number","minimum":0,"description":"The vertical margin of the page, defined in points (pt)."},"format":{"enum":["a4","letter"],"description":"The format of the page. Can be 'a4' or 'letter'."},"locale":{"anyOf":[{"const":"af-ZA"},{"const":"am-ET"},{"const":"ar-SA"},{"const":"az-AZ"},{"const":"bg-BG"},{"const":"bn-BD"},{"const":"ca-ES"},{"const":"cs-CZ"},{"const":"da-DK"},{"const":"de-DE"},{"const":"el-GR"},{"const":"en-US"},{"const":"es-ES"},{"const":"fa-IR"},{"const":"fi-FI"},{"const":"fr-FR"},{"const":"he-IL"},{"const":"hi-IN"},{"const":"hu-HU"},{"const":"id-ID"},{"const":"it-IT"},{"const":"ja-JP"},{"const":"km-KH"},{"const":"kn-IN"},{"const":"ko-KR"},{"const":"lt-LT"},{"const":"lv-LV"},{"const":"ml-IN"},{"const":"mr-IN"},{"const":"ms-MY"},{"const":"ne-NP"},{"const":"nl-NL"},{"const":"no-NO"},{"const":"or-IN"},{"const":"pl-PL"},{"const":"pt-BR"},{"const":"pt-PT"},{"const":"ro-RO"},{"const":"ru-RU"},{"const":"sk-SK"},{"const":"sq-AL"},{"const":"sr-SP"},{"const":"sv-SE"},{"const":"ta-IN"},{"const":"te-IN"},{"const":"th-TH"},{"const":"tr-TR"},{"const":"uk-UA"},{"const":"uz-UZ"},{"const":"vi-VN"},{"const":"zh-CN"},{"const":"zh-TW"},{"const":"zu-ZA"}],"description":"The language used in the resume, used for displaying pre-translated section headings, if not overridden."}},"required":["gapX","gapY","marginX","marginY","format","locale"],"description":"The page settings of the resume. Determines the margins, format, and locale of the resume."},"design":{"type":"object","properties":{"level":{"type":"object","properties":{"icon":{"type":"string","description":"The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."},"type":{"enum":["hidden","circle","square","rectangle","rectangle-full","progress-bar","icon"],"description":"The type of the level design. 'hidden' will hide the level design, 'circle' will display a circle, 'square' will display a square, 'rectangle' will display a rectangle, 'rectangle-full' will display a full rectangle, 'progress-bar' will display a progress bar, and 'icon' will display an icon. If 'icon' is selected, the icon to display should be specified in the 'icon' field."}},"required":["icon","type"]},"colors":{"type":"object","properties":{"primary":{"type":"string","description":"The primary color of the design, defined as rgba(r, g, b, a)."},"text":{"type":"string","description":"The text color of the design, defined as rgba(r, g, b, a). Usually set to black: rgba(0, 0, 0, 1)."},"background":{"type":"string","description":"The background color of the design, defined as rgba(r, g, b, a). Usually set to white: rgba(255, 255, 255, 1)."}},"required":["primary","text","background"]}},"required":["level","colors"],"description":"The design settings of the resume. Determines the colors, level designs, and typography of the resume."},"typography":{"type":"object","properties":{"body":{"type":"object","properties":{"fontFamily":{"type":"string","description":"The family of the font to use. Must be a font that is available on Google Fonts."},"fontWeights":{"type":"array","items":{"enum":["100","200","300","400","500","600","700","800","900"]},"description":"The weight of the font, defined as a number between 100 and 900. Default to 400 when unsure if the weight is available in the font."},"fontSize":{"type":"number","minimum":6,"maximum":24,"description":"The size of the font to use, defined in points (pt)."},"lineHeight":{"type":"number","minimum":0.5,"maximum":4,"description":"The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x)."}},"required":["fontFamily","fontWeights","fontSize","lineHeight"],"description":"The typography for the body of the resume."},"heading":{"type":"object","properties":{"fontFamily":{"type":"string","description":"The family of the font to use. Must be a font that is available on Google Fonts."},"fontWeights":{"type":"array","items":{"enum":["100","200","300","400","500","600","700","800","900"]},"description":"The weight of the font, defined as a number between 100 and 900. Default to 400 when unsure if the weight is available in the font."},"fontSize":{"type":"number","minimum":6,"maximum":24,"description":"The size of the font to use, defined in points (pt)."},"lineHeight":{"type":"number","minimum":0.5,"maximum":4,"description":"The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x)."}},"required":["fontFamily","fontWeights","fontSize","lineHeight"],"description":"The typography for the headings of the resume."}},"required":["body","heading"],"description":"The typography settings of the resume. Determines the fonts and sizes of the body and headings of the resume."},"notes":{"type":"string","description":"Personal notes for the resume. Can be used to add any additional information or instructions for the resume. These notes are not displayed on the resume, they are only visible to the author of the resume when editing the resume. This should be a HTML-formatted string."}},"required":["template","layout","css","page","design","typography","notes"],"description":"Metadata for the resume, such as template, layout, typography, etc. This section describes the overall design and appearance of the resume."}},"required":["picture","basics","summary","sections","customSections","metadata"]}},"required":["data"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","description":"The ID of the imported resume."}}}}}}},"/resume/{id}/set-locked":{"post":{"operationId":"resume.setLocked","summary":"Set resume locked status","description":"Toggle the locked status of a resume, by its ID.","tags":["Resume"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"isLocked":{"type":"boolean"}},"required":["isLocked"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/resume/{id}/set-password":{"post":{"operationId":"resume.setPassword","summary":"Set password on a resume","description":"Set a password on a resume to protect it from unauthorized access when shared publicly.","tags":["Resume"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string","minLength":6,"maxLength":64}},"required":["password"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/resume/{id}/remove-password":{"post":{"operationId":"resume.removePassword","summary":"Remove password from a resume","description":"Remove password protection from a resume.","tags":["Resume"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/resume/{id}/duplicate":{"post":{"operationId":"resume.duplicate","summary":"Duplicate a resume","description":"Duplicate a resume, by its ID.","tags":["Resume"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}},"required":[]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","description":"The ID of the duplicated resume."}}}}}}},"/printer/resume/{id}/pdf":{"get":{"operationId":"printer.printResumeAsPDF","summary":"Export resume as PDF","description":"Export a resume as a PDF. Returns a URL to download the PDF.","tags":["Resume","Printer"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}},"required":["url"]}}}}}}},"/printer/resume/{id}/screenshot":{"get":{"operationId":"printer.getResumeScreenshot","summary":"Get resume screenshot","description":"Get a screenshot of a resume. Returns a URL to the screenshot image.","tags":["Resume","Printer"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}},"required":["url"]}}}}}}},"/statistics/user/count":{"get":{"operationId":"statistics.user.getCount","summary":"Get total number of users","description":"Get the total number of users for the Reactive Resume.","tags":["Statistics"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"number"}}}}}}},"/statistics/resume/count":{"get":{"operationId":"statistics.resume.getCount","summary":"Get total number of resumes","description":"Get the total number of resumes for the Reactive Resume.","tags":["Statistics"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"number"}}}}}}},"/statistics/github/stars":{"get":{"operationId":"statistics.github.getStarCount","summary":"Get GitHub Repository stargazers count","description":"Get the stargazers count for the Reactive Resume GitHub repository, at the time of writing.","tags":["Statistics"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"number"}}}}}}}}}