diff options
| author | Stephen Finucane <stephen@that.guru> | 2018-10-26 21:48:54 +0100 |
|---|---|---|
| committer | Stephen Finucane <stephen@that.guru> | 2018-12-22 17:19:07 +0000 |
| commit | 0dd516c98cc3e329f7de161ae70dcfc424df196b (patch) | |
| tree | 9542f648ae71753cdbf4597ccd1c3775cf78e8cd /docs | |
| parent | 4dd58e1c206750311849e0c2a85ba51ec0412242 (diff) | |
| download | patchwork-0dd516c98cc3e329f7de161ae70dcfc424df196b.tar patchwork-0dd516c98cc3e329f7de161ae70dcfc424df196b.tar.gz | |
docs: Document the '/people' resource
This introduces our first use of embedded serializers, which are
separate models from the main ones. Other than that, this is pretty
standard.
Signed-off-by: Stephen Finucane <stephen@that.guru>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/schemas/patchwork.yaml | 132 |
1 files changed, 132 insertions, 0 deletions
diff --git a/docs/api/schemas/patchwork.yaml b/docs/api/schemas/patchwork.yaml index a0f6e78..495e93b 100644 --- a/docs/api/schemas/patchwork.yaml +++ b/docs/api/schemas/patchwork.yaml @@ -25,6 +25,74 @@ paths: $ref: '#/components/schemas/Index' tags: - api + /api/people/: + get: + description: List people. + operationId: people_list + security: + - basicAuth: [] + - apiKeyAuth: [] + parameters: + - $ref: '#/components/parameters/Page' + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/Order' + - $ref: '#/components/parameters/Search' + responses: + '200': + description: '' + headers: + Link: + $ref: '#/components/headers/Link' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Person' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - people + /api/people/{id}/: + get: + description: Show a person. + operationId: people_read + security: + - basicAuth: [] + - apiKeyAuth: [] + parameters: + - in: path + name: id + required: true + schema: + description: '' + title: '' + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/Person' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - people /api/users/: get: description: List users. @@ -277,6 +345,36 @@ components: type: string format: uri readOnly: true + Person: + type: object + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: URL + type: string + format: uri + readOnly: true + name: + title: Name + type: string + readOnly: true + minLength: 1 + maxLength: 255 + email: + title: Email + type: string + format: email + readOnly: true + minLength: 1 + maxLength: 255 + user: + type: object + nullable: true + allOf: + - $ref: '#/components/schemas/UserEmbedded' User: type: object properties: @@ -309,6 +407,40 @@ components: format: email readOnly: true minLength: 1 + UserEmbedded: + type: object + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: URL + type: string + format: uri + readOnly: true + username: + title: Username + type: string + readOnly: true + minLength: 1 + maxLength: 150 + first_name: + title: First name + type: string + maxLength: 30 + readOnly: true + last_name: + title: Last name + type: string + maxLength: 150 + readOnly: true + email: + title: Email address + type: string + format: email + readOnly: true + minLength: 1 Error: type: object properties: |