Update OpenAPI schema

This commit is contained in:
Christopher C. Wells 2022-04-04 15:38:34 -07:00
parent a20df4664c
commit 7804fe8f2d
1 changed files with 245 additions and 0 deletions

View File

@ -3844,6 +3844,229 @@ paths:
description: ''
tags:
- api
/api/tags/:
get:
operationId: listTags
description: ''
parameters:
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: last_used
required: false
in: query
description: last_used
schema:
type: string
- name: name
required: false
in: query
description: name
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
tags:
- api
post:
operationId: createTag
description: ''
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Tag'
multipart/form-data:
schema:
$ref: '#/components/schemas/Tag'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
description: ''
tags:
- api
/api/tags/{slug}/:
get:
operationId: retrieveTag
description: ''
parameters:
- name: slug
in: path
required: true
description: ''
schema:
type: string
- name: last_used
required: false
in: query
description: last_used
schema:
type: string
- name: name
required: false
in: query
description: name
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
description: ''
tags:
- api
put:
operationId: updateTag
description: ''
parameters:
- name: slug
in: path
required: true
description: ''
schema:
type: string
- name: last_used
required: false
in: query
description: last_used
schema:
type: string
- name: name
required: false
in: query
description: name
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Tag'
multipart/form-data:
schema:
$ref: '#/components/schemas/Tag'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
description: ''
tags:
- api
patch:
operationId: partialUpdateTag
description: ''
parameters:
- name: slug
in: path
required: true
description: ''
schema:
type: string
- name: last_used
required: false
in: query
description: last_used
schema:
type: string
- name: name
required: false
in: query
description: name
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Tag'
multipart/form-data:
schema:
$ref: '#/components/schemas/Tag'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
description: ''
tags:
- api
delete:
operationId: destroyTag
description: ''
parameters:
- name: slug
in: path
required: true
description: ''
schema:
type: string
- name: last_used
required: false
in: query
description: last_used
schema:
type: string
- name: name
required: false
in: query
description: name
schema:
type: string
responses:
'204':
description: ''
tags:
- api
/api/timers/{id}/restart/:
patch:
operationId: restartTimer
@ -4023,6 +4246,8 @@ components:
time:
type: string
format: date-time
tags:
type: string
required:
- child
- note
@ -4200,3 +4425,23 @@ components:
- child
- bmi
- date
Tag:
type: object
properties:
slug:
type: string
readOnly: true
pattern: ^[-a-zA-Z0-9_]+$
name:
type: string
maxLength: 100
color:
type: string
pattern: ^#[0-9a-fA-F]{6}$
maxLength: 32
last_used:
type: string
format: date-time
readOnly: true
required:
- name