ufh/docs/openapi.yml

115 lines
2.5 KiB
YAML

openapi: 3.0.1
info:
title: MyS3
version: v0.0.0
servers:
- url: http://localhost:3210/
- url: https://localhost:3210/
paths:
/things:
get:
parameters:
- name: query
in: query
required: true
schema:
type: string
- name: after
in: query
schema:
type: string
- name: timeout
in: query
schema:
type: number
post:
responses:
201:
description: created the object
content: {}
202:
description: received the object and will process/derived in the background
content: {}
400:
description: bad request
content: {}
security:
- token: []
/things/{ref}:
get:
parameters:
- name: ref
in: path
required: true
schema:
type: string
responses:
200:
description: 200 response
headers:
Content-Length:
schema:
type: string
Content-Type:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Empty'
application/octet-stream:
schema:
$ref: '#/components/schemas/Empty'
400:
description: 400 response
content: {}
500:
description: 500 response
content: {}
security:
- token: []
/things/query:
post:
requestBody:
content:
'*/*': {}
required: true
responses:
200:
description: 200 response
headers:
Content-Length:
schema:
type: string
Content-Type:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/QueryInit'
400:
description: 400 response
content: {}
500:
description: 500 response
content: {}
security:
- token: []
x-codegen-request-body-name: item
components:
schemas:
Empty:
title: Empty Schema
type: object
QueryInit:
title: QueryInit
type: object
properties:
query:
type: string
securitySchemes:
token:
type: apiKey
name: Authorization
in: header