Skip to content

Commit

Permalink
Write docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Zaptoss committed Jul 22, 2024
1 parent 83b14d4 commit 1d773e1
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 9 deletions.
3 changes: 2 additions & 1 deletion docs/spec/components/schemas/FormStatus.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ allOf:
properties:
status:
type: string
enum: [ accepted, processed ]
enum: [ created, accepted, processed ]
description: |
Created - the empty form was created and now user can't use legacy submit
Accepted - the data was saved by the service for further processing
Processed - the data is processed and stored
created_at:
Expand Down
16 changes: 8 additions & 8 deletions docs/spec/paths/integrations@forms-svc@[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,11 @@ post:
- User form
summary: Submit lightweight user answers
description: |
Send user answers and return their current status.
Sending the filled form. Requires created empty form
linked to the name of the file with the photo.
Return form current status.
The image is a link to s3 storage
Only a user with a confirmed passport can send the form ('verified: true' in JWT).
There is a configurable delay before the same user
can submit another form.
The image is a link to s3 storage
operationId: lightweightSubmitForm
security:
- BearerAuth: []
Expand All @@ -34,11 +32,13 @@ post:
$ref: '#/components/responses/invalidParameter'
401:
$ref: '#/components/responses/invalidAuth'
429:
description: "It is necessary to wait some time before sending the next form"
403:
description: "Empty form absent for user, but already exists processed or accepted forms"
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
404:
$ref: '#/components/responses/notFound'
500:
$ref: '#/components/responses/internalError'
1 change: 1 addition & 0 deletions docs/spec/paths/integrations@forms-svc@[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ post:
in S3 Storage. The name is generated on the server side.
'verified: true' must be specified in the JWT.
The cooldown of this endpoint is the same as in the submit form.
This endpoint creates an empty form that can be submitted on `/form`
operationId: uploadImage
security:
- BearerAuth: []
Expand Down

0 comments on commit 1d773e1

Please sign in to comment.