From 3d2baed7ab09206560bbf169760b59144bf8d031 Mon Sep 17 00:00:00 2001 From: "Christopher C. Wells" Date: Tue, 8 Aug 2023 05:07:40 -0700 Subject: [PATCH] Update API schema to reflect recent changes Fixes #696 --- openapi-schema.yml | 227 ++++++++++++++++++++++++++------------------- 1 file changed, 133 insertions(+), 94 deletions(-) diff --git a/openapi-schema.yml b/openapi-schema.yml index da27756d..25b46c4d 100644 --- a/openapi-schema.yml +++ b/openapi-schema.yml @@ -1,7 +1,8 @@ openapi: 3.0.2 info: title: Baby Buddy API - version: '' + version: 1 + description: API documentation for the Baby Buddy application paths: /api/bmi/: get: @@ -618,6 +619,12 @@ paths: description: The initial index from which to return the results. schema: type: integer + - name: id + required: false + in: query + description: id + schema: + type: string - name: first_name required: false in: query @@ -710,6 +717,12 @@ paths: description: '' schema: type: string + - name: id + required: false + in: query + description: id + schema: + type: string - name: first_name required: false in: query @@ -759,6 +772,12 @@ paths: description: '' schema: type: string + - name: id + required: false + in: query + description: id + schema: + type: string - name: first_name required: false in: query @@ -819,6 +838,12 @@ paths: description: '' schema: type: string + - name: id + required: false + in: query + description: id + schema: + type: string - name: first_name required: false in: query @@ -2009,22 +2034,40 @@ paths: description: child schema: type: string - - name: date + - name: end required: false in: query - description: DateTime + description: End DateTime schema: type: string - - name: date_max + - name: end_max required: false in: query - description: Max. DateTime + description: Max. End DateTime schema: type: string - - name: date_min + - name: end_min required: false in: query - description: Min. DateTime + description: Min. End DateTime + schema: + type: string + - name: start + required: false + in: query + description: Start DateTime + schema: + type: string + - name: start_max + required: false + in: query + description: Max. End DateTime + schema: + type: string + - name: start_min + required: false + in: query + description: Min. Start DateTime schema: type: string - name: ordering @@ -2101,22 +2144,40 @@ paths: description: child schema: type: string - - name: date + - name: end required: false in: query - description: DateTime + description: End DateTime schema: type: string - - name: date_max + - name: end_max required: false in: query - description: Max. DateTime + description: Max. End DateTime schema: type: string - - name: date_min + - name: end_min required: false in: query - description: Min. DateTime + description: Min. End DateTime + schema: + type: string + - name: start + required: false + in: query + description: Start DateTime + schema: + type: string + - name: start_max + required: false + in: query + description: Max. End DateTime + schema: + type: string + - name: start_min + required: false + in: query + description: Min. Start DateTime schema: type: string - name: ordering @@ -2150,22 +2211,40 @@ paths: description: child schema: type: string - - name: date + - name: end required: false in: query - description: DateTime + description: End DateTime schema: type: string - - name: date_max + - name: end_max required: false in: query - description: Max. DateTime + description: Max. End DateTime schema: type: string - - name: date_min + - name: end_min required: false in: query - description: Min. DateTime + description: Min. End DateTime + schema: + type: string + - name: start + required: false + in: query + description: Start DateTime + schema: + type: string + - name: start_max + required: false + in: query + description: Max. End DateTime + schema: + type: string + - name: start_min + required: false + in: query + description: Min. Start DateTime schema: type: string - name: ordering @@ -2210,22 +2289,40 @@ paths: description: child schema: type: string - - name: date + - name: end required: false in: query - description: DateTime + description: End DateTime schema: type: string - - name: date_max + - name: end_max required: false in: query - description: Max. DateTime + description: Max. End DateTime schema: type: string - - name: date_min + - name: end_min required: false in: query - description: Min. DateTime + description: Min. End DateTime + schema: + type: string + - name: start + required: false + in: query + description: Start DateTime + schema: + type: string + - name: start_max + required: false + in: query + description: Max. End DateTime + schema: + type: string + - name: start_min + required: false + in: query + description: Min. Start DateTime schema: type: string - name: ordering @@ -3087,12 +3184,6 @@ paths: description: The initial index from which to return the results. schema: type: integer - - name: active - required: false - in: query - description: active - schema: - type: string - name: child required: false in: query @@ -3209,12 +3300,6 @@ paths: description: A unique integer value identifying this Timer. schema: type: string - - name: active - required: false - in: query - description: active - schema: - type: string - name: child required: false in: query @@ -3288,12 +3373,6 @@ paths: description: A unique integer value identifying this Timer. schema: type: string - - name: active - required: false - in: query - description: active - schema: - type: string - name: child required: false in: query @@ -3378,12 +3457,6 @@ paths: description: A unique integer value identifying this Timer. schema: type: string - - name: active - required: false - in: query - description: active - schema: - type: string - name: child required: false in: query @@ -4041,37 +4114,6 @@ paths: description: '' tags: - api - /api/timers/{id}/stop/: - patch: - operationId: stopTimer - description: '' - parameters: - - name: id - in: path - required: true - description: A unique integer value identifying this Timer. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Timer' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/Timer' - multipart/form-data: - schema: - $ref: '#/components/schemas/Timer' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Timer' - description: '' - tags: - - api components: schemas: BMI: @@ -4291,9 +4333,16 @@ components: type: integer amount: type: number - time: + start: type: string format: date-time + end: + type: string + format: date-time + duration: + type: string + readOnly: true + nullable: true notes: type: string nullable: true @@ -4304,7 +4353,6 @@ components: required: - child - amount - - time Sleep: type: object properties: @@ -4333,8 +4381,8 @@ components: readOnly: true nullable: true nap: - type: string - readOnly: true + type: boolean + nullable: true notes: type: string nullable: true @@ -4401,18 +4449,9 @@ components: start: type: string format: date-time - end: - type: string - format: date-time - readOnly: true - nullable: true duration: type: string readOnly: true - nullable: true - active: - type: boolean - readOnly: true user: type: integer nullable: true @@ -4472,4 +4511,4 @@ components: type: string required: - child - - weight + - weight \ No newline at end of file