Files
release11-tools-mocked-serv…/api-doc.yaml
2021-03-25 15:52:32 +01:00

99 lines
2.3 KiB
YAML

openapi: 3.0.0
info:
version: 0.0.1
title: Mocked Service
description: Service for creating your own mocked endpoints
tags:
- name: "MockedMessage"
- name: "MessageHistory"
paths:
/mock/json/{uuid}:
get:
tags:
- "MockedMessage"
description: Generates new uuid and default message
parameters:
- in: path
name: uuid
required: true
description: If not given, server will create and return new one
schema:
type: string
example: '9bfddcc1-ef89-4c53-84e8-c88f13ecc7ec'
responses:
'200':
description: Message list sent
content:
application/json:
schema:
$ref: '#/components/schemas/MockedMessage'
/mock/json:
get:
tags:
- "MockedMessage"
description: Generates new uuid and default message
responses:
'200':
description: Message list sent
content:
application/json:
schema:
$ref: '#/components/schemas/MockedMessage'
post:
tags:
- "MockedMessage"
description: creates new message in the list
responses:
'200':
description: message has been created
put:
tags:
- "MockedMessage"
description: Adds new item or modifies existing
requestBody:
required: true
description: json format describing MockedMessage object
content:
application/json:
schema:
$ref: '#/components/schemas/MockedMessage'
responses:
'200':
description: message has been updated
components:
schemas:
MockedMessage:
description: Model containing data about created response
properties:
mockedResponseId:
type: integer
example: 1
clientUUID:
type: string
example: '9bfddcc1-ef89-4c53-84e8-c88f13ecc7ec'
mediaType:
type: string
example: 'application/xml'
messageBody:
type: string
example: '<root><element>Hello World</element></root>'
httpStatus:
type: integer
example: 200
httpHeaders:
type: object
additionalProperties:
type: string