mybuddy/openapi-schema.yml

2803 lines
66 KiB
YAML
Raw Normal View History

openapi: 3.0.2
info:
title: Baby Buddy API
version: 1
description: API documentation for the Baby Buddy application
paths:
/api/children/:
get:
operationId: listChilds
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: first_name
required: false
in: query
description: first_name
schema:
type: string
- name: last_name
required: false
in: query
description: last_name
schema:
type: string
- name: slug
required: false
in: query
description: slug
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: birth_date
required: false
in: query
description: birth_date
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
2021-10-31 20:21:04 +00:00
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
2021-10-31 20:21:04 +00:00
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Child'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
post:
operationId: createChild
description: ''
parameters: []
requestBody:
content:
application/json:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Child'
application/x-www-form-urlencoded:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Child'
multipart/form-data:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Child'
responses:
2021-10-31 20:21:04 +00:00
'201':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Child'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
/api/children/{slug}/:
get:
operationId: retrieveChild
description: ''
parameters:
- name: slug
in: path
required: true
description: ''
schema:
type: string
- name: first_name
required: false
in: query
description: first_name
schema:
type: string
- name: last_name
required: false
in: query
description: last_name
schema:
type: string
- name: slug
required: false
in: query
description: slug
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: birth_date
required: false
in: query
2021-10-31 20:21:04 +00:00
description: birth_date
schema:
type: string
responses:
'200':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Child'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
patch:
2021-10-31 20:21:04 +00:00
operationId: partialUpdateChild
description: ''
parameters:
- name: slug
in: path
required: true
description: ''
schema:
type: string
- name: first_name
required: false
in: query
description: first_name
schema:
type: string
- name: last_name
required: false
in: query
description: last_name
schema:
type: string
- name: slug
required: false
in: query
description: slug
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: birth_date
required: false
in: query
description: birth_date
schema:
type: string
requestBody:
content:
application/json:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Child'
application/x-www-form-urlencoded:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Child'
multipart/form-data:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Child'
responses:
'200':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Child'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
delete:
operationId: destroyChild
description: ''
parameters:
- name: slug
in: path
required: true
description: ''
schema:
type: string
- name: first_name
required: false
in: query
description: first_name
schema:
type: string
- name: last_name
required: false
in: query
description: last_name
schema:
type: string
- name: slug
required: false
in: query
description: slug
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: birth_date
required: false
in: query
description: birth_date
schema:
type: string
responses:
'204':
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
/api/changes/:
get:
operationId: listDiaperChanges
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: child
required: false
in: query
description: child
schema:
type: string
- name: wet
required: false
in: query
description: wet
schema:
type: string
- name: solid
required: false
in: query
description: solid
schema:
type: string
- name: color
required: false
in: query
description: color
schema:
type: string
enum:
- black
- brown
- green
- yellow
- name: amount
required: false
in: query
description: amount
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: date
required: false
in: query
description: Date
schema:
type: string
- name: date_min
required: false
in: query
description: Min. Date
schema:
type: string
- name: date_max
required: false
in: query
description: Max. Date
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
2021-10-31 20:21:04 +00:00
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
2021-10-31 20:21:04 +00:00
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/DiaperChange'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
post:
operationId: createDiaperChange
description: ''
parameters: []
requestBody:
content:
application/json:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/DiaperChange'
application/x-www-form-urlencoded:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/DiaperChange'
multipart/form-data:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/DiaperChange'
responses:
2021-10-31 20:21:04 +00:00
'201':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/DiaperChange'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
/api/changes/{id}/:
get:
operationId: retrieveDiaperChange
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Diaper Change.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
- name: wet
required: false
in: query
description: wet
schema:
type: string
- name: solid
required: false
in: query
description: solid
schema:
type: string
- name: color
required: false
in: query
description: color
schema:
type: string
enum:
- black
- brown
- green
- yellow
- name: amount
required: false
in: query
description: amount
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: date
required: false
in: query
2021-10-31 20:21:04 +00:00
description: Date
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: date_min
required: false
in: query
2021-10-31 20:21:04 +00:00
description: Min. Date
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: date_max
required: false
in: query
2021-10-31 20:21:04 +00:00
description: Max. Date
schema:
type: string
responses:
'200':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/DiaperChange'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
patch:
2021-10-31 20:21:04 +00:00
operationId: partialUpdateDiaperChange
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Diaper Change.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
- name: wet
required: false
in: query
description: wet
schema:
type: string
- name: solid
required: false
in: query
description: solid
schema:
type: string
- name: color
required: false
in: query
description: color
schema:
type: string
enum:
- black
- brown
- green
- yellow
- name: amount
required: false
in: query
description: amount
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: date
required: false
in: query
description: Date
schema:
type: string
- name: date_min
required: false
in: query
description: Min. Date
schema:
type: string
- name: date_max
required: false
in: query
description: Max. Date
schema:
type: string
requestBody:
content:
application/json:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/DiaperChange'
application/x-www-form-urlencoded:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/DiaperChange'
multipart/form-data:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/DiaperChange'
responses:
'200':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/DiaperChange'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
delete:
operationId: destroyDiaperChange
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Diaper Change.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
- name: wet
required: false
in: query
description: wet
schema:
type: string
- name: solid
required: false
in: query
description: solid
schema:
type: string
- name: color
required: false
in: query
description: color
schema:
type: string
enum:
- black
- brown
- green
- yellow
- name: amount
required: false
in: query
description: amount
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: date
required: false
in: query
description: Date
schema:
type: string
- name: date_min
required: false
in: query
description: Min. Date
schema:
type: string
- name: date_max
required: false
in: query
description: Max. Date
schema:
type: string
responses:
'204':
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
/api/feedings/:
get:
operationId: listFeedings
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: child
required: false
in: query
description: child
schema:
type: string
- name: type
required: false
in: query
description: type
schema:
type: string
enum:
- breast milk
- formula
- fortified breast milk
2021-10-31 20:21:04 +00:00
- solid food
- name: method
required: false
in: query
description: method
schema:
type: string
enum:
- bottle
- left breast
- right breast
- both breasts
2021-10-31 20:21:04 +00:00
- parent fed
- self fed
- name: end
required: false
in: query
description: End Date
schema:
type: string
- name: end_min
required: false
in: query
description: Min. End Date
schema:
type: string
- name: end_max
required: false
in: query
description: Max. End Date
schema:
type: string
- name: start
required: false
in: query
description: Start Date
schema:
type: string
- name: start_min
required: false
in: query
description: Min. Start Date
schema:
type: string
- name: start_end
required: false
in: query
description: Max. End Date
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
2021-10-31 20:21:04 +00:00
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
2021-10-31 20:21:04 +00:00
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Feeding'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
post:
operationId: createFeeding
description: ''
parameters: []
requestBody:
content:
application/json:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Feeding'
application/x-www-form-urlencoded:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Feeding'
multipart/form-data:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Feeding'
responses:
2021-10-31 20:21:04 +00:00
'201':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Feeding'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
/api/feedings/{id}/:
get:
operationId: retrieveFeeding
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Feeding.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
- name: type
required: false
in: query
description: type
schema:
type: string
enum:
- breast milk
- formula
- fortified breast milk
2021-10-31 20:21:04 +00:00
- solid food
- name: method
required: false
in: query
description: method
schema:
type: string
enum:
- bottle
- left breast
- right breast
- both breasts
2021-10-31 20:21:04 +00:00
- parent fed
- self fed
- name: end
required: false
in: query
description: End Date
schema:
type: string
- name: end_min
required: false
in: query
description: Min. End Date
schema:
type: string
- name: end_max
required: false
in: query
description: Max. End Date
schema:
type: string
- name: start
required: false
in: query
description: Start Date
schema:
type: string
- name: start_min
required: false
in: query
description: Min. Start Date
schema:
type: string
- name: start_end
required: false
in: query
description: Max. End Date
schema:
type: string
responses:
'200':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Feeding'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
patch:
operationId: partialUpdateFeeding
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Feeding.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
- name: type
required: false
in: query
description: type
schema:
type: string
enum:
- breast milk
- formula
- fortified breast milk
2021-10-31 20:21:04 +00:00
- solid food
- name: method
required: false
in: query
description: method
schema:
type: string
enum:
- bottle
- left breast
- right breast
- both breasts
2021-10-31 20:21:04 +00:00
- parent fed
- self fed
- name: end
required: false
in: query
description: End Date
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: end_min
required: false
in: query
2021-10-31 20:21:04 +00:00
description: Min. End Date
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: end_max
required: false
in: query
2021-10-31 20:21:04 +00:00
description: Max. End Date
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: start
required: false
in: query
2021-10-31 20:21:04 +00:00
description: Start Date
schema:
type: string
- name: start_min
required: false
in: query
description: Min. Start Date
schema:
type: string
- name: start_end
required: false
in: query
description: Max. End Date
schema:
type: string
requestBody:
content:
application/json:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Feeding'
application/x-www-form-urlencoded:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Feeding'
multipart/form-data:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Feeding'
responses:
'200':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Feeding'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
delete:
operationId: destroyFeeding
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Feeding.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
- name: type
required: false
in: query
description: type
schema:
type: string
enum:
- breast milk
- formula
- fortified breast milk
2021-10-31 20:21:04 +00:00
- solid food
- name: method
required: false
in: query
description: method
schema:
type: string
enum:
- bottle
- left breast
- right breast
- both breasts
2021-10-31 20:21:04 +00:00
- parent fed
- self fed
- name: end
required: false
in: query
description: End Date
schema:
type: string
- name: end_min
required: false
in: query
description: Min. End Date
schema:
type: string
- name: end_max
required: false
in: query
description: Max. End Date
schema:
type: string
- name: start
required: false
in: query
description: Start Date
schema:
type: string
- name: start_min
required: false
in: query
description: Min. Start Date
schema:
type: string
- name: start_end
required: false
in: query
description: Max. End Date
schema:
type: string
responses:
'204':
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
/api/notes/:
get:
operationId: listNotes
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: child
required: false
in: query
description: child
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: date
required: false
in: query
description: Date
schema:
type: string
- name: date_min
required: false
in: query
description: Min. Date
schema:
type: string
- name: date_max
required: false
in: query
description: Max. Date
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
2021-10-31 20:21:04 +00:00
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
2021-10-31 20:21:04 +00:00
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Note'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
post:
operationId: createNote
description: ''
parameters: []
requestBody:
content:
application/json:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Note'
application/x-www-form-urlencoded:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Note'
multipart/form-data:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Note'
responses:
2021-10-31 20:21:04 +00:00
'201':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Note'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
/api/notes/{id}/:
get:
operationId: retrieveNote
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Note.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: date
required: false
in: query
description: Date
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: date_min
required: false
in: query
2021-10-31 20:21:04 +00:00
description: Min. Date
schema:
type: string
- name: date_max
required: false
in: query
description: Max. Date
schema:
type: string
responses:
'200':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Note'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
patch:
2021-10-31 20:21:04 +00:00
operationId: partialUpdateNote
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Note.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: date
required: false
in: query
description: Date
schema:
type: string
- name: date_min
required: false
in: query
description: Min. Date
schema:
type: string
- name: date_max
required: false
in: query
description: Max. Date
schema:
type: string
requestBody:
content:
application/json:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Note'
application/x-www-form-urlencoded:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Note'
multipart/form-data:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Note'
responses:
'200':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Note'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
delete:
operationId: destroyNote
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Note.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: date
required: false
in: query
description: Date
schema:
type: string
- name: date_min
required: false
in: query
description: Min. Date
schema:
type: string
- name: date_max
required: false
in: query
description: Max. Date
schema:
type: string
responses:
'204':
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
/api/sleep/:
get:
operationId: listSleeps
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: child
required: false
in: query
description: child
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: end
required: false
in: query
description: End Date
schema:
type: string
- name: end_min
required: false
in: query
description: Min. End Date
schema:
type: string
- name: end_max
required: false
in: query
description: Max. End Date
schema:
type: string
- name: start
required: false
in: query
description: Start Date
schema:
type: string
- name: start_min
required: false
in: query
description: Min. Start Date
schema:
type: string
- name: start_end
required: false
in: query
description: Max. End Date
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
2021-10-31 20:21:04 +00:00
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
2021-10-31 20:21:04 +00:00
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Sleep'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
post:
operationId: createSleep
description: ''
parameters: []
requestBody:
content:
application/json:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Sleep'
application/x-www-form-urlencoded:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Sleep'
multipart/form-data:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Sleep'
responses:
2021-10-31 20:21:04 +00:00
'201':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Sleep'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
/api/sleep/{id}/:
get:
operationId: retrieveSleep
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Sleep.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: end
required: false
in: query
description: End Date
schema:
type: string
- name: end_min
required: false
in: query
description: Min. End Date
schema:
type: string
- name: end_max
required: false
in: query
description: Max. End Date
schema:
type: string
- name: start
required: false
in: query
description: Start Date
schema:
type: string
- name: start_min
required: false
in: query
description: Min. Start Date
schema:
type: string
- name: start_end
required: false
in: query
description: Max. End Date
schema:
type: string
responses:
'200':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Sleep'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
patch:
operationId: partialUpdateSleep
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Sleep.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: end
required: false
in: query
description: End Date
schema:
type: string
- name: end_min
required: false
in: query
description: Min. End Date
schema:
type: string
- name: end_max
required: false
in: query
description: Max. End Date
schema:
type: string
- name: start
required: false
in: query
description: Start Date
schema:
type: string
- name: start_min
required: false
in: query
description: Min. Start Date
schema:
type: string
- name: start_end
required: false
in: query
description: Max. End Date
schema:
type: string
requestBody:
content:
application/json:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Sleep'
application/x-www-form-urlencoded:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Sleep'
multipart/form-data:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Sleep'
responses:
'200':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Sleep'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
delete:
operationId: destroySleep
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Sleep.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: end
required: false
in: query
description: End Date
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: end_min
required: false
in: query
2021-10-31 20:21:04 +00:00
description: Min. End Date
schema:
type: string
- name: end_max
required: false
in: query
description: Max. End Date
schema:
type: string
- name: start
required: false
in: query
description: Start Date
schema:
type: string
- name: start_min
required: false
in: query
description: Min. Start Date
schema:
type: string
- name: start_end
required: false
in: query
description: Max. End Date
schema:
type: string
responses:
'204':
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
/api/temperature/:
get:
operationId: listTemperatures
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: child
required: false
in: query
description: child
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: date
required: false
in: query
description: Date
schema:
type: string
- name: date_min
required: false
in: query
description: Min. Date
schema:
type: string
- name: date_max
required: false
in: query
description: Max. Date
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
2021-10-31 20:21:04 +00:00
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
2021-10-31 20:21:04 +00:00
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Temperature'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
post:
operationId: createTemperature
description: ''
parameters: []
requestBody:
content:
application/json:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Temperature'
application/x-www-form-urlencoded:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Temperature'
multipart/form-data:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Temperature'
responses:
2021-10-31 20:21:04 +00:00
'201':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Temperature'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
/api/temperature/{id}/:
get:
operationId: retrieveTemperature
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Temperature.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: date
required: false
in: query
description: Date
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: date_min
required: false
in: query
2021-10-31 20:21:04 +00:00
description: Min. Date
schema:
type: string
- name: date_max
required: false
in: query
description: Max. Date
schema:
type: string
responses:
'200':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Temperature'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
patch:
2021-10-31 20:21:04 +00:00
operationId: partialUpdateTemperature
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Temperature.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: date
required: false
in: query
description: Date
schema:
type: string
- name: date_min
required: false
in: query
description: Min. Date
schema:
type: string
- name: date_max
required: false
in: query
description: Max. Date
schema:
type: string
requestBody:
content:
application/json:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Temperature'
application/x-www-form-urlencoded:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Temperature'
multipart/form-data:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Temperature'
responses:
'200':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Temperature'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
delete:
operationId: destroyTemperature
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Temperature.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: date
required: false
in: query
description: Date
schema:
type: string
- name: date_min
required: false
in: query
description: Min. Date
schema:
type: string
- name: date_max
required: false
in: query
description: Max. Date
schema:
type: string
responses:
'204':
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
/api/timers/:
get:
operationId: listTimers
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: child
required: false
in: query
description: child
schema:
type: string
- name: active
required: false
in: query
description: active
schema:
type: string
- name: user
required: false
in: query
description: user
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: end
required: false
in: query
description: End Date
schema:
type: string
- name: end_min
required: false
in: query
description: Min. End Date
schema:
type: string
- name: end_max
required: false
in: query
description: Max. End Date
schema:
type: string
- name: start
required: false
in: query
description: Start Date
schema:
type: string
- name: start_min
required: false
in: query
description: Min. Start Date
schema:
type: string
- name: start_end
required: false
in: query
description: Max. End Date
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
2021-10-31 20:21:04 +00:00
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
2021-10-31 20:21:04 +00:00
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Timer'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
post:
operationId: createTimer
description: ''
parameters: []
requestBody:
content:
application/json:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Timer'
application/x-www-form-urlencoded:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Timer'
multipart/form-data:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Timer'
responses:
2021-10-31 20:21:04 +00:00
'201':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Timer'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
/api/timers/{id}/:
get:
operationId: retrieveTimer
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Timer.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
- name: active
required: false
in: query
description: active
schema:
type: string
- name: user
required: false
in: query
description: user
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: end
required: false
in: query
description: End Date
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: end_min
required: false
in: query
2021-10-31 20:21:04 +00:00
description: Min. End Date
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: end_max
required: false
in: query
2021-10-31 20:21:04 +00:00
description: Max. End Date
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: start
required: false
in: query
2021-10-31 20:21:04 +00:00
description: Start Date
schema:
type: string
- name: start_min
required: false
in: query
description: Min. Start Date
schema:
type: string
- name: start_end
required: false
in: query
description: Max. End Date
schema:
type: string
responses:
'200':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Timer'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
patch:
2021-10-31 20:21:04 +00:00
operationId: partialUpdateTimer
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Timer.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
- name: active
required: false
in: query
description: active
schema:
type: string
- name: user
required: false
in: query
description: user
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: end
required: false
in: query
description: End Date
schema:
type: string
- name: end_min
required: false
in: query
description: Min. End Date
schema:
type: string
- name: end_max
required: false
in: query
description: Max. End Date
schema:
type: string
- name: start
required: false
in: query
description: Start Date
schema:
type: string
- name: start_min
required: false
in: query
description: Min. Start Date
schema:
type: string
- name: start_end
required: false
in: query
description: Max. End Date
schema:
type: string
requestBody:
content:
application/json:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Timer'
application/x-www-form-urlencoded:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Timer'
multipart/form-data:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Timer'
responses:
'200':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Timer'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
delete:
operationId: destroyTimer
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Timer.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
- name: active
required: false
in: query
description: active
schema:
type: string
- name: user
required: false
in: query
description: user
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: end
required: false
in: query
description: End Date
schema:
type: string
- name: end_min
required: false
in: query
description: Min. End Date
schema:
type: string
- name: end_max
required: false
in: query
description: Max. End Date
schema:
type: string
- name: start
required: false
in: query
description: Start Date
schema:
type: string
- name: start_min
required: false
in: query
description: Min. Start Date
schema:
type: string
- name: start_end
required: false
in: query
description: Max. End Date
schema:
type: string
responses:
'204':
description: ''
tags:
- api
/api/tummy-times/:
get:
operationId: listTummyTimes
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: child
required: false
in: query
description: child
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: end
required: false
in: query
description: End Date
schema:
type: string
- name: end_min
required: false
in: query
description: Min. End Date
schema:
type: string
- name: end_max
required: false
in: query
description: Max. End Date
schema:
type: string
- name: start
required: false
in: query
description: Start Date
schema:
type: string
- name: start_min
required: false
in: query
description: Min. Start Date
schema:
type: string
- name: start_end
required: false
in: query
description: Max. End Date
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
2021-10-31 20:21:04 +00:00
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
2021-10-31 20:21:04 +00:00
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/TummyTime'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
post:
operationId: createTummyTime
description: ''
parameters: []
requestBody:
content:
application/json:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/TummyTime'
application/x-www-form-urlencoded:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/TummyTime'
multipart/form-data:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/TummyTime'
responses:
2021-10-31 20:21:04 +00:00
'201':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/TummyTime'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
/api/tummy-times/{id}/:
get:
operationId: retrieveTummyTime
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Tummy Time.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: end
required: false
in: query
description: End Date
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: end_min
required: false
in: query
2021-10-31 20:21:04 +00:00
description: Min. End Date
schema:
type: string
- name: end_max
required: false
in: query
description: Max. End Date
schema:
type: string
- name: start
required: false
in: query
description: Start Date
schema:
type: string
- name: start_min
required: false
in: query
description: Min. Start Date
schema:
type: string
- name: start_end
required: false
in: query
description: Max. End Date
schema:
type: string
responses:
'200':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/TummyTime'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
patch:
2021-10-31 20:21:04 +00:00
operationId: partialUpdateTummyTime
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Tummy Time.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: end
required: false
in: query
description: End Date
schema:
type: string
- name: end_min
required: false
in: query
description: Min. End Date
schema:
type: string
- name: end_max
required: false
in: query
description: Max. End Date
schema:
type: string
- name: start
required: false
in: query
description: Start Date
schema:
type: string
- name: start_min
required: false
in: query
description: Min. Start Date
schema:
type: string
- name: start_end
required: false
in: query
description: Max. End Date
schema:
type: string
requestBody:
content:
application/json:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/TummyTime'
application/x-www-form-urlencoded:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/TummyTime'
multipart/form-data:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/TummyTime'
responses:
'200':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/TummyTime'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
delete:
operationId: destroyTummyTime
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Tummy Time.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: end
required: false
in: query
description: End Date
schema:
type: string
- name: end_min
required: false
in: query
description: Min. End Date
schema:
type: string
- name: end_max
required: false
in: query
description: Max. End Date
schema:
type: string
- name: start
required: false
in: query
description: Start Date
schema:
type: string
- name: start_min
required: false
in: query
description: Min. Start Date
schema:
type: string
- name: start_end
required: false
in: query
description: Max. End Date
schema:
type: string
responses:
'204':
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
/api/weight/:
get:
operationId: listWeights
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: child
required: false
in: query
description: child
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: date
required: false
in: query
description: date
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
2021-10-31 20:21:04 +00:00
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
2021-10-31 20:21:04 +00:00
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Weight'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
post:
operationId: createWeight
description: ''
parameters: []
requestBody:
content:
application/json:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Weight'
application/x-www-form-urlencoded:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Weight'
multipart/form-data:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Weight'
responses:
2021-10-31 20:21:04 +00:00
'201':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Weight'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
/api/weight/{id}/:
get:
operationId: retrieveWeight
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Weight.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: date
required: false
in: query
2021-10-31 20:21:04 +00:00
description: date
schema:
type: string
responses:
'200':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Weight'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
patch:
2021-10-31 20:21:04 +00:00
operationId: partialUpdateWeight
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Weight.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: date
required: false
in: query
description: date
schema:
type: string
requestBody:
content:
application/json:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Weight'
application/x-www-form-urlencoded:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Weight'
multipart/form-data:
2021-10-31 20:21:04 +00:00
schema:
$ref: '#/components/schemas/Weight'
responses:
'200':
content:
application/json:
schema:
2021-10-31 20:21:04 +00:00
$ref: '#/components/schemas/Weight'
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
delete:
operationId: destroyWeight
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Weight.
schema:
type: string
- name: child
required: false
in: query
description: child
schema:
type: string
2021-10-31 20:21:04 +00:00
- name: date
required: false
in: query
description: date
schema:
type: string
responses:
'204':
description: ''
2021-10-31 20:21:04 +00:00
tags:
- api
components:
schemas:
Child:
type: object
properties:
id:
type: integer
readOnly: true
first_name:
type: string
maxLength: 255
last_name:
type: string
maxLength: 255
birth_date:
type: string
format: date
slug:
type: string
readOnly: true
pattern: ^[-\w]+\z
picture:
type: string
format: binary
nullable: true
required:
- first_name
- last_name
- birth_date
DiaperChange:
type: object
properties:
id:
type: integer
readOnly: true
child:
type: integer
time:
type: string
format: date-time
wet:
type: boolean
solid:
type: boolean
color:
enum:
- black
- brown
- green
- yellow
type: string
amount:
type: number
nullable: true
notes:
type: string
nullable: true
required:
- child
- time
- wet
- solid
Feeding:
type: object
properties:
id:
type: integer
readOnly: true
child:
type: integer
nullable: true
start:
type: string
format: date-time
end:
type: string
format: date-time
duration:
type: string
readOnly: true
type:
enum:
- breast milk
- formula
- fortified breast milk
- solid food
type: string
method:
enum:
- bottle
- left breast
- right breast
- both breasts
- parent fed
- self fed
type: string
amount:
type: number
nullable: true
notes:
type: string
nullable: true
required:
- type
- method
Note:
type: object
properties:
id:
type: integer
readOnly: true
child:
type: integer
note:
type: string
time:
type: string
format: date-time
required:
- child
- note
Sleep:
type: object
properties:
id:
type: integer
readOnly: true
child:
type: integer
nullable: true
start:
type: string
format: date-time
end:
type: string
format: date-time
duration:
type: string
readOnly: true
nap:
type: string
readOnly: true
notes:
type: string
nullable: true
Temperature:
type: object
properties:
id:
type: integer
readOnly: true
child:
type: integer
temperature:
type: number
time:
type: string
format: date-time
notes:
type: string
nullable: true
required:
- child
- temperature
- time
Timer:
type: object
properties:
id:
type: integer
readOnly: true
child:
type: integer
nullable: true
name:
type: string
nullable: true
maxLength: 255
start:
type: string
format: date-time
end:
type: string
format: date-time
readOnly: true
duration:
type: string
readOnly: true
active:
type: boolean
readOnly: true
user:
type: integer
nullable: true
TummyTime:
type: object
properties:
id:
type: integer
readOnly: true
child:
type: integer
nullable: true
start:
type: string
format: date-time
end:
type: string
format: date-time
duration:
type: string
readOnly: true
milestone:
type: string
maxLength: 255
Weight:
type: object
properties:
id:
type: integer
readOnly: true
child:
type: integer
weight:
type: number
date:
type: string
format: date
notes:
type: string
nullable: true
required:
- child
- weight
- date