Skip to content

Commit

Permalink
docs(openapi): update examples in OpenAPI specification
Browse files Browse the repository at this point in the history
  • Loading branch information
Icikowski committed Dec 30, 2022
1 parent 58f90a3 commit e5f76e0
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions api/spec_adminapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ components:
name: payloadId
schema:
type: string
example: 17af9631-acc8-4867-b07e-02c97d14ae82
example: HZvAT9NnMir41sm5Ke2d1
required: true
description: Single payload ID (version 4 UUID string)

Expand Down Expand Up @@ -412,11 +412,11 @@ paths:
additionalProperties:
$ref: "#/components/schemas/Payload"
example:
17af9631-acc8-4867-b07e-02c97d14ae82:
HZvAT9NnMir41sm5Ke2d1:
filename: document.pdf
size: 121457
timestamp: 2022-11-02T21:24:59.104242267Z
faddedaa-2a6b-4930-93da-760874cc1666:
cuv8EUWzSxsR41QQ-mZ0E:
filename: image.jpg
size: 1964529
timestamp: 2022-11-02T21:24:59.103929567Z
Expand All @@ -427,11 +427,11 @@ paths:
additionalProperties:
$ref: "#/components/schemas/Payload"
example:
17af9631-acc8-4867-b07e-02c97d14ae82:
HZvAT9NnMir41sm5Ke2d1:
filename: document.pdf
size: 121457
timestamp: 2022-11-02T21:24:59.104242267Z
faddedaa-2a6b-4930-93da-760874cc1666:
cuv8EUWzSxsR41QQ-mZ0E:
filename: image.jpg
size: 1964529
timestamp: 2022-11-02T21:24:59.103929567Z
Expand Down Expand Up @@ -462,16 +462,16 @@ paths:
$ref: "#/components/schemas/BatchUploadResponse"
example:
ids:
document.pdf: 17af9631-acc8-4867-b07e-02c97d14ae82
image.jpg: faddedaa-2a6b-4930-93da-760874cc1666
document.pdf: HZvAT9NnMir41sm5Ke2d1
image.jpg: cuv8EUWzSxsR41QQ-mZ0E
errors: {}
text/yaml:
schema:
$ref: "#/components/schemas/BatchUploadResponse"
example:
ids:
document.pdf: 17af9631-acc8-4867-b07e-02c97d14ae82
image.jpg: faddedaa-2a6b-4930-93da-760874cc1666
document.pdf: HZvAT9NnMir41sm5Ke2d1
image.jpg: cuv8EUWzSxsR41QQ-mZ0E
errors: {}
'400':
description: No files attached
Expand Down Expand Up @@ -542,14 +542,14 @@ paths:
example:
status: 404
message: resource does not exist
details: 'payload with given ID does not exist: 17af9631-acc8-4867-b07e-02c97d14ae82'
details: 'payload with given ID does not exist: HZvAT9NnMir41sm5Ke2d1'
text/yaml:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
status: 404
message: resource does not exist
details: 'payload with given ID does not exist: 17af9631-acc8-4867-b07e-02c97d14ae82'
details: 'payload with given ID does not exist: HZvAT9NnMir41sm5Ke2d1'
post:
operationId: updateSinglePayload
summary: Update single stored payload
Expand Down Expand Up @@ -580,14 +580,14 @@ paths:
example:
status: 404
message: resource does not exist
details: 'payload with given ID does not exist: 17af9631-acc8-4867-b07e-02c97d14ae82'
details: 'payload with given ID does not exist: HZvAT9NnMir41sm5Ke2d1'
text/yaml:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
status: 404
message: resource does not exist
details: 'payload with given ID does not exist: 17af9631-acc8-4867-b07e-02c97d14ae82'
details: 'payload with given ID does not exist: HZvAT9NnMir41sm5Ke2d1'
'400':
description: Unable to update payload
content:
Expand Down Expand Up @@ -623,14 +623,14 @@ paths:
example:
status: 404
message: resource does not exist
details: 'payload with given ID does not exist: 17af9631-acc8-4867-b07e-02c97d14ae82'
details: 'payload with given ID does not exist: HZvAT9NnMir41sm5Ke2d1'
text/yaml:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
status: 404
message: resource does not exist
details: 'payload with given ID does not exist: 17af9631-acc8-4867-b07e-02c97d14ae82'
details: 'payload with given ID does not exist: HZvAT9NnMir41sm5Ke2d1'
'400':
description: Unable to delete payload
content:
Expand Down Expand Up @@ -672,14 +672,14 @@ paths:
example:
status: 404
message: resource does not exist
details: 'payload with given ID does not exist: 17af9631-acc8-4867-b07e-02c97d14ae82'
details: 'payload with given ID does not exist: HZvAT9NnMir41sm5Ke2d1'
text/yaml:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
status: 404
message: resource does not exist
details: 'payload with given ID does not exist: 17af9631-acc8-4867-b07e-02c97d14ae82'
details: 'payload with given ID does not exist: HZvAT9NnMir41sm5Ke2d1'
'400':
description: Unable to download payload
content:
Expand Down

0 comments on commit e5f76e0

Please sign in to comment.