This repository has been archived by the owner on May 6, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
86 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
openapi: 3.0.3 | ||
info: | ||
version: 0.0.1 | ||
title: Masterdata microservice | ||
description: | | ||
Masterdata microservice | ||
servers: | ||
- url: https://my.example.com/md | ||
security: | ||
- ApiKeyAuth: [] | ||
paths: | ||
'/': | ||
get: | ||
summary: 'List `Masterdata` objects.' | ||
description: | | ||
Fetches list of masterdata of all items we carry | ||
# This is an array of GET operation parameters: | ||
responses: | ||
'200': | ||
description: Successful response | ||
content: | ||
application/json: | ||
schema: | ||
type: object | ||
properties: | ||
persons: | ||
type: array | ||
items: | ||
$ref: '#/components/schemas/ListOfMasterdata' | ||
nextPageToken: | ||
description: | | ||
A token which can be sent as `pageToken` | ||
to retrieve the next page. | ||
type: string | ||
'/{name}': | ||
get: | ||
description: 'Retrieve a single Person object.' | ||
parameters: | ||
- name: name | ||
in: path | ||
description: | | ||
Unique identifier of the desired person object. | ||
required: true | ||
schema: | ||
type: string | ||
responses: | ||
'200': | ||
description: Successful response | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '#/components/schemas/Masterdata' | ||
'404': | ||
description: 'Item was not found' | ||
components: | ||
securitySchemes: | ||
ApiKeyAuth: | ||
type: apiKey | ||
in: header | ||
name: X-API-KEY | ||
schemas: | ||
ListOfMasterdata: | ||
title: List of Masterdata | ||
type: array | ||
items: | ||
$ref: '#/components/schemas/Masterdata' | ||
Masterdata: | ||
title: Masterdata | ||
type: object | ||
properties: | ||
name: | ||
description: | | ||
name of the item | ||
Format: `persons/{personId}` | ||
type: string | ||
example: "md/a353-x51d" | ||
pattern: 'md\/[a-z0-9-]+' | ||
desc: | ||
description: 'the description of the item' | ||
type: string | ||
imgUrl: | ||
description: 'the url to the image' | ||
type: string | ||
id: | ||
description: 'uuid of the item in question (internal only)' | ||
type: string |