Skip to content

Commit

Permalink
chore: sync openapi specs🔄
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jan 7, 2025
1 parent f41c5c6 commit dcd87de
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/.last_updated
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Mon Jan 6 20:16:21 UTC 2025
Tue Jan 7 18:16:41 UTC 2025
42 changes: 42 additions & 0 deletions docs/history-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,15 @@ servers:
- url: /api/v1
description: Production server

tags:
- name: Clinical Histories
description: Operations related to clinical histories

paths:
/histories:
get:
tags:
- Clinical Histories
summary: Get all clinical histories
security:
- jwt: []
Expand All @@ -27,6 +33,8 @@ paths:
'500':
description: Error retrieving clinical histories
post:
tags:
- Clinical Histories
summary: Create a new clinical history
security:
- jwt: []
Expand All @@ -49,6 +57,8 @@ paths:
description: Error creating clinical history
/histories/{id}:
get:
tags:
- Clinical Histories
summary: Get a clinical history by its ID
security:
- jwt: []
Expand All @@ -74,6 +84,8 @@ paths:
'500':
description: Error retrieving clinical history
delete:
tags:
- Clinical Histories
summary: Delete a clinical history by its ID
security:
- jwt: []
Expand All @@ -92,6 +104,8 @@ paths:
description: Error deleting clinical history
/histories/{id}/report:
get:
tags:
- Clinical Histories
summary: Get a clinical history report by its ID
security:
- jwt: []
Expand Down Expand Up @@ -119,6 +133,8 @@ paths:
description: Error generating clinical history report
/histories/patient/{patientId}:
get:
tags:
- Clinical Histories
summary: Get a clinical history by patient ID
security:
- jwt: []
Expand All @@ -144,6 +160,8 @@ paths:
'500':
description: Error retrieving clinical history for patient
delete:
tags:
- Clinical Histories
summary: Delete a clinical history by patient ID
security:
- jwt: []
Expand All @@ -162,6 +180,8 @@ paths:
description: Error deleting clinical history for patient
/histories/{id}/allergy:
post:
tags:
- Clinical Histories
summary: Add an allergy to a clinical history
description: Adds an allergy to the allergies set in a specific clinical history.
security:
Expand Down Expand Up @@ -228,6 +248,8 @@ paths:
type: string
/histories/{id}/allergy/{allergy}:
delete:
tags:
- Clinical Histories
summary: Remove an allergy from a clinical history
description: Removes an allergy from the allergies set in a specific clinical history.
security:
Expand Down Expand Up @@ -288,6 +310,8 @@ paths:
type: string
/histories/{id}/treatment:
post:
tags:
- Clinical Histories
summary: Add a new treatment to a clinical history
security:
- jwt: []
Expand Down Expand Up @@ -318,6 +342,8 @@ paths:
description: Error adding treatment
/histories/{id}/treatment/{treatmentId}:
delete:
tags:
- Clinical Histories
summary: Delete a treatment from a clinical history
security:
- jwt: []
Expand Down Expand Up @@ -346,6 +372,8 @@ paths:
'500':
description: Error deleting treatment
put:
tags:
- Clinical Histories
summary: Update a treatment in a clinical history
security:
- jwt: []
Expand Down Expand Up @@ -381,6 +409,8 @@ paths:
description: Error updating treatment
/histories/{id}/condition:
post:
tags:
- Clinical Histories
summary: Add a new current condition to a clinical history
security:
- jwt: []
Expand Down Expand Up @@ -411,6 +441,8 @@ paths:
description: Error adding current condition
/histories/{id}/condition/{currentConditionId}:
delete:
tags:
- Clinical Histories
summary: Delete a current condition from a clinical history
security:
- jwt: []
Expand Down Expand Up @@ -439,6 +471,8 @@ paths:
'500':
description: Error deleting current condition
put:
tags:
- Clinical Histories
summary: Update a current condition in a clinical history
security:
- jwt: []
Expand Down Expand Up @@ -474,6 +508,8 @@ paths:
description: Error updating current condition
/histories/{id}/image:
post:
tags:
- Clinical Histories
summary: Upload an image to a clinical history record
description: Allows uploading an image to an existing clinical history record.
security:
Expand Down Expand Up @@ -542,6 +578,8 @@ paths:
example: Internal server error occurred.
/histories/{id}/image/{imageId}:
delete:
tags:
- Clinical Histories
summary: Delete an image from a clinical history record
description: Deletes a specific image associated with a clinical history record by its ID. Also removes the file from Azure Blob Storage.
security:
Expand Down Expand Up @@ -605,6 +643,8 @@ paths:
example: Detailed error message.
/histories/{id}/analytic:
post:
tags:
- Clinical Histories
summary: Upload an analytic to a clinical history record
description: Allows uploading an analytic to an existing clinical history record.
security:
Expand Down Expand Up @@ -673,6 +713,8 @@ paths:
example: Internal server error occurred.
/histories/{id}/analytic/{analyticId}:
delete:
tags:
- Clinical Histories
summary: Delete an analytic from a clinical history record
description: Deletes a specific analytic associated with a clinical history record by its ID. Also removes the file from Azure Blob Storage.
security:
Expand Down

0 comments on commit dcd87de

Please sign in to comment.