hv2-api/openapi.yaml

38 lines
928 B
YAML
Raw Permalink Normal View History

2021-06-17 11:52:13 +02:00
openapi: 3.0.0
info:
title: hv2-api
2021-06-17 12:30:07 +02:00
version: "1"
description: "REST-API for the nober.de Hausverwaltungs-Software"
termsOfService: "https://home.hottis.de/dokuwiki/doku.php?id=hv2pub:termsofuse"
contact: "Wolfgang Hottgenroth <wolfgang.hottgenroth@icloud.com>"
externalDocs:
description: "Find more details on this API here"
url: "https://home.hottis.de/dokuwiki/doku.php?id=hv2pub:externaldocs"
server:
url: "https://api.hv.nober.de/v1"
2021-06-17 11:52:13 +02:00
paths:
2021-06-17 12:30:07 +02:00
/v1/test:
2021-06-17 11:52:13 +02:00
get:
tags: [ "Test" ]
summary: Return secret string
operationId: auth.testToken
responses:
'200':
description: secret response
content:
'text/plain':
schema:
type: string
security:
- jwt: ['secret']
components:
securitySchemes:
jwt:
type: http
scheme: bearer
bearerFormat: JWT
x-bearerInfoFunc: auth.decodeToken