Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update send Swagger API docs #3840

Merged
merged 1 commit into from
Oct 24, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions api.planx.uk/modules/send/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,47 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/SessionPayload"
/idox/{localAuthority}:
post:
summary: Submits an application to Idox Nexus (TEST)
description: |
<b>Test only endpoint - not live</b>
<br/><br/>
Submits an application to Idox Nexus
tags:
- send
parameters:
- $ref: "#/components/parameters/localAuthority"
security:
- hasuraAuth: []
requestBody:
description: |

This endpoint is only called via Hasura's scheduled event webhook, so body is wrapped in a `payload` key
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/SessionPayload"
/upload-submission/{localAuthority}:
post:
summary: Submits an application to AWS S3 bucket
description: Submits the application payload (JSON) to a AWS S3 bucket. From there it can be processed by other integrations, such as PowerAutomate, as long as the integration has an API key
tags:
- send
parameters:
- $ref: "#/components/parameters/localAuthority"
security:
- hasuraAuth: []
requestBody:
description: |

This endpoint is only called via Hasura's scheduled event webhook, so body is wrapped in a `payload` key
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/SessionPayload"
/create-send-events/{sessionId}:
post:
summary: Create send events
Expand All @@ -90,6 +131,10 @@ paths:
$ref: "#/components/schemas/EventSchema"
uniform:
$ref: "#/components/schemas/EventSchema"
s3:
$ref: "#/components/schemas/EventSchema"
idox:
$ref: "#/components/schemas/EventSchema"
required:
- email
- bops
Expand Down
Loading