Skip to content

Commit 18aead4

Browse files
Add openapi
1 parent 4dffae8 commit 18aead4

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

openapi.yaml

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -246,8 +246,8 @@ paths:
246246
summary: Get document types
247247
tags:
248248
- document-types
249-
description: Get document Types
250-
operationId: getDocumentTypes
249+
description: Get document type
250+
operationId: getDocumentType
251251
parameters:
252252
- name: filter[documentTypeName]
253253
in: query
@@ -267,6 +267,26 @@ paths:
267267
$ref: '#/components/responses/400'
268268
'500':
269269
$ref: '#/components/responses/500'
270+
/onbase-docs/document-types/{documentTypeId}:
271+
get:
272+
summary: Get document type by ID
273+
tags:
274+
- document-types
275+
description: Get document type by ID
276+
operationId: getDocumentTypeById
277+
parameters:
278+
- $ref: '#/components/parameters/documentTypeId'
279+
responses:
280+
'200':
281+
description: Document uploaded
282+
content:
283+
application/json:
284+
schema:
285+
$ref: '#/components/schemas/DocumentTypeResult'
286+
'404':
287+
$ref: '#/components/responses/404'
288+
'500':
289+
$ref: '#/components/responses/500'
270290
components:
271291
securitySchemes:
272292
OAuth2:
@@ -284,6 +304,13 @@ components:
284304
required: true
285305
schema:
286306
type: string
307+
documentTypeId:
308+
name: documentTypeId
309+
in: path
310+
description: The unique identifier of a document type
311+
required: true
312+
schema:
313+
type: string
287314
responses:
288315
'400':
289316
description: Bad request
@@ -442,6 +469,12 @@ components:
442469
$ref: '#/components/schemas/SelfLink'
443470
data:
444471
$ref: '#/components/schemas/KeywordsResource'
472+
DocumentTypeResult:
473+
properties:
474+
links:
475+
$ref: '#/components/schemas/SelfLink'
476+
data:
477+
$ref: '#/components/schemas/DocumentTypeResource'
445478
DocumentTypeSetResult:
446479
type: object
447480
properties:

0 commit comments

Comments
 (0)