T231 api-doc appended
This commit is contained in:
70
api-doc.yaml
70
api-doc.yaml
@@ -57,7 +57,6 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- "MockedMessage"
|
- "MockedMessage"
|
||||||
description: Adds new item or modifies existing
|
description: Adds new item or modifies existing
|
||||||
|
|
||||||
requestBody:
|
requestBody:
|
||||||
required: true
|
required: true
|
||||||
description: json format describing MockedMessage object
|
description: json format describing MockedMessage object
|
||||||
@@ -69,6 +68,49 @@ paths:
|
|||||||
'200':
|
'200':
|
||||||
description: message has been updated
|
description: message has been updated
|
||||||
|
|
||||||
|
/mock/json/{uuid}/{id}:
|
||||||
|
delete:
|
||||||
|
tags:
|
||||||
|
- "MockedMessage"
|
||||||
|
description: Deletes message of given id assigned to given uuid
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: uuid
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
example: '9bfddcc1-ef89-4c53-84e8-c88f13ecc7ec'
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
example: 1
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: message has been deleted
|
||||||
|
|
||||||
|
/api/event:
|
||||||
|
post:
|
||||||
|
tags:
|
||||||
|
- "MessageHistory"
|
||||||
|
description: returns history of responses for given uuid
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
description: json format describing Event query
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/EventRequest'
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: history of given uuid
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/EventEntry'
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
components:
|
components:
|
||||||
schemas:
|
schemas:
|
||||||
@@ -96,3 +138,29 @@ components:
|
|||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: string
|
type: string
|
||||||
|
|
||||||
|
EventRequest:
|
||||||
|
description: Model containing data about Event query
|
||||||
|
properties:
|
||||||
|
clientUUID:
|
||||||
|
type: string
|
||||||
|
example: '9bfddcc1-ef89-4c53-84e8-c88f13ecc7ec'
|
||||||
|
localDateTimeFrom:
|
||||||
|
type: string
|
||||||
|
example: '2021-01-01T01:01:01'
|
||||||
|
localDateTimeTo:
|
||||||
|
type: string
|
||||||
|
example: '2021-01-01T23:59:59'
|
||||||
|
mockedResponseId:
|
||||||
|
type: integer
|
||||||
|
example: 1
|
||||||
|
|
||||||
|
EventEntry:
|
||||||
|
description: Model containing data about Event entry
|
||||||
|
properties:
|
||||||
|
dateTimeStamp:
|
||||||
|
type: string
|
||||||
|
example: '2021-01-01T01:01:01'
|
||||||
|
interfaceName:
|
||||||
|
type: string
|
||||||
|
example: 'MockedMessage - request'
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user