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"
|
2021-06-17 12:52:05 +02:00
|
|
|
description: "REST-API for the Nober Grundbesitz GbR Hausverwaltungs-Software"
|
2021-06-17 12:30:07 +02:00
|
|
|
termsOfService: "https://home.hottis.de/dokuwiki/doku.php?id=hv2pub:termsofuse"
|
2021-06-17 12:32:30 +02:00
|
|
|
contact:
|
|
|
|
|
name: "Wolfgang Hottgenroth"
|
|
|
|
|
email: "wolfgang.hottgenroth@icloud.com"
|
2021-06-17 12:30:07 +02:00
|
|
|
externalDocs:
|
2021-06-17 12:52:05 +02:00
|
|
|
description: "Find more details here"
|
2021-06-17 12:30:07 +02:00
|
|
|
url: "https://home.hottis.de/dokuwiki/doku.php?id=hv2pub:externaldocs"
|
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:
|
2021-06-17 19:01:12 +02:00
|
|
|
'application/json':
|
2021-06-17 11:52:13 +02:00
|
|
|
schema:
|
2021-06-17 19:01:12 +02:00
|
|
|
$ref: '#/components/schemas/TestOutput'
|
2021-06-17 11:52:13 +02:00
|
|
|
security:
|
|
|
|
|
- jwt: ['secret']
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
components:
|
|
|
|
|
securitySchemes:
|
|
|
|
|
jwt:
|
|
|
|
|
type: http
|
|
|
|
|
scheme: bearer
|
|
|
|
|
bearerFormat: JWT
|
|
|
|
|
x-bearerInfoFunc: auth.decodeToken
|
2021-06-17 19:01:12 +02:00
|
|
|
schemas:
|
|
|
|
|
TestOutput:
|
|
|
|
|
description: Test Output
|
|
|
|
|
type: object
|
|
|
|
|
properties:
|
|
|
|
|
message:
|
|
|
|
|
type: string
|
|
|
|
|
details:
|
2021-06-17 19:05:35 +02:00
|
|
|
type: string
|
