Last active
March 18, 2020 14:57
-
-
Save a0viedo/e11253a13c9f23b065f55c99011f6b13 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
openapi: 3.0.1 | |
info: | |
title: Job Seekers | |
contact: | |
email: federico.aguirre@adp.com | |
license: | |
name: Apache 2.0 | |
url: http://www.apache.org/licenses/LICENSE-2.0.html | |
version: 1.0.0 | |
servers: | |
- url: https://localhost/job-seekers | |
tags: | |
- name: jobseekers | |
description: Everything about your jobseekerss | |
externalDocs: | |
description: Find out more | |
url: http://swagger.io | |
paths: | |
/profile/{id}: | |
put: | |
tags: | |
- jobseekers | |
summary: Update one | |
parameters: | |
- name: id | |
in: path | |
required: true | |
schema: | |
type: integer | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/JobSeekerRequestPayload' | |
required: true | |
responses: | |
200: | |
description: Was able to update the given skill | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/JobSeekerResponsePayload' | |
example: | |
$ref: '#/components/schemas/JobSeekerRequestPayload' | |
404: | |
description: An skill with the specified ID was not found. | |
content: {} | |
x-codegen-request-body-name: Body | |
delete: | |
tags: | |
- jobseekers | |
summary: Delete One | |
parameters: | |
- name: id | |
in: path | |
required: true | |
schema: | |
type: integer | |
responses: | |
200: | |
description: Found and delete the given profile by ID | |
content: | |
application/json: | |
example: | |
schema: | |
$ref: '#/components/schemas/JobSeekerResponsePayload' | |
404: | |
description: A profile with the specified ID was not found. | |
content: {} | |
/profile/{id}/cover_letters: | |
get: | |
tags: | |
- jobseekers | |
summary: Get One | |
parameters: | |
- name: id | |
in: path | |
required: true | |
schema: | |
type: integer | |
responses: | |
200: | |
description: Found the given profile by ID | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/JobSeekerResponsePayload' | |
404: | |
description: A profile with the specified ID was not found. | |
content: {} | |
post: | |
tags: | |
- jobseekers | |
summary: Upsert cover letters | |
parameters: | |
- name: id | |
in: path | |
required: true | |
schema: | |
type: integer | |
requestBody: | |
content: | |
multipart/form-data: | |
schema: | |
properties: | |
additionalMetadata: | |
type: string | |
description: Additional data to pass to server | |
file: | |
type: string | |
description: file to upload | |
format: binary | |
responses: | |
200: | |
description: Found the given profile by ID | |
content: | |
application/json: | |
example: | |
schema: | |
$ref: '#/components/schemas/JobSeekerResponsePayload' | |
404: | |
description: A profile with the specified ID was not found. | |
content: {} | |
/profiles: | |
get: | |
tags: | |
- jobseekers | |
summary: Get All | |
responses: | |
200: | |
description: Endpoint return the profiles that matches the filter criteria | |
content: {} | |
x-codegen-request-body-name: Body | |
components: | |
schemas: | |
FilterCriteria: | |
type: object | |
properties: | |
zip_code: | |
type: number | |
example: 94110.0 | |
JobSeekerResponsePayload: | |
type: object | |
properties: | |
id: | |
type: integer | |
example: 362 | |
first_name: | |
type: string | |
example: John | |
middle_name: | |
type: string | |
example: Joe | |
last_name: | |
type: string | |
example: Doe | |
dob: | |
type: string | |
example: 1989-04-23 | |
location: | |
type: object | |
properties: {} | |
example: | |
zip_code: 91764 | |
city: Ontario | |
state: California | |
lat: 33.44 | |
long: 89.53 | |
email: | |
type: string | |
example: nick@adp.com | |
password: | |
type: string | |
example: 2Q9z5qpv#3 | |
primary_phone_number: | |
type: string | |
example: (415) 312-6573 | |
mobile_phone_number: | |
type: string | |
example: (415) 412-6572 | |
is_volunteer: | |
type: boolean | |
cover_letter: | |
type: array | |
items: | |
type: string | |
experience: | |
type: object | |
properties: {} | |
education: | |
type: object | |
properties: {} | |
skills: | |
type: array | |
items: | |
type: string | |
preferred_contact_method: | |
type: string | |
preferred_contact_frequency: | |
type: string | |
is_profile_hidden: | |
type: boolean | |
allow_direct_contact: | |
type: boolean | |
is_remote: | |
type: boolean | |
JobSeekerRequestPayload: | |
type: object | |
ManyRequest: | |
type: array | |
items: | |
type: object | |
properties: {} | |
example: {} | |
ManyResponse: | |
type: array | |
items: | |
type: object | |
properties: {} | |
DeleteManyRequest: | |
type: array | |
items: | |
type: integer |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment