Marmelator/persistence-service
1
0
Fork 0
Code Issues Pull Requests 17 Actions Packages Projects Releases 1.1k Wiki Activity

RedactManager API Specs for BASF - removed X-tenant-ID header and added some description

Browse Source
This commit is contained in:
Kresnadi Budisantoso 2024-04-28 15:47:12 +02:00
parent c431f98842
commit 224def920e
1 changed files with 5 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
persistence-service-v1/persistence-service-external-api-v2/src/main/resources/api/redactmanager.yaml
View File

@ -747,7 +747,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/DownloadStatusList' $ref: '#/components/schemas/DownloadStatusList'
description: TODO description: List of all downloads of the current users successfully retrieved.
"400": "400":
$ref: '#/components/responses/400' $ref: '#/components/responses/400'
"401": "401":
@ -774,7 +774,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/DownloadStatus' $ref: '#/components/schemas/DownloadStatus'
description: TODO description: Status of the download successfully retrieved.
"400": "400":
$ref: '#/components/responses/400' $ref: '#/components/responses/400'
"401": "401":
@ -824,7 +824,7 @@ paths:
- $ref: '#/components/parameters/downloadId' - $ref: '#/components/parameters/downloadId'
responses: responses:
"200": # TODO: complete response "200": # TODO: complete response
description: TODO description: Successfully downloading the file. (TODO rephrase?)
"400": "400":
$ref: '#/components/responses/400' $ref: '#/components/responses/400'
"401": "401":
@ -851,7 +851,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/UserList' $ref: '#/components/schemas/UserList'
description: TODO description: List of users successfully retrieved.
"400": "400":
$ref: '#/components/responses/400' $ref: '#/components/responses/400'
"401": "401":
@ -876,7 +876,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/User' $ref: '#/components/schemas/User'
description: TODO description: User successfully retrieved.
"400": "400":
$ref: '#/components/responses/400' $ref: '#/components/responses/400'
"401": "401":
@ -925,12 +925,6 @@ paths:
$ref: '#/components/responses/500' $ref: '#/components/responses/500'
components: components:
headers: headers:
X-Tenant-ID:
description: Tenant identifier, also known as the *Workspace ID* in the application.
required: true
schema:
type: string
example: 'my-workspace'
Authorization: Authorization:
description: JWT token for authorization. Format should be `Bearer {JWT_TOKEN}`. description: JWT token for authorization. Format should be `Bearer {JWT_TOKEN}`.
required: true required: true