1 Commits

Author SHA1 Message Date
4f4b959e9e successfully moved to openapi 3.0.0 2021-01-24 23:24:20 +01:00

View File

@ -1,4 +1,4 @@
swagger: '2.0' openapi: 3.0.0
info: info:
title: Hausverwaltung title: Hausverwaltung
version: "0.1" version: "0.1"
@ -12,10 +12,12 @@ paths:
responses: responses:
200: 200:
description: Successful response. description: Successful response.
content:
'application/json':
schema: schema:
type: array type: array
items: items:
$ref: '#/definitions/Objekt' $ref: '#/components/schemas/Objekt'
404: 404:
description: No Objekte available description: No Objekte available
500: 500:
@ -28,13 +30,16 @@ paths:
parameters: parameters:
- name: id - name: id
in: path in: path
type: integer
required: true required: true
schema:
type: integer
responses: responses:
200: 200:
description: Successful response. description: Successful response.
content:
'application/json':
schema: schema:
$ref: '#/definitions/Objekt' $ref: '#/components/schemas/Objekt'
404: 404:
description: Objekt not found description: Objekt not found
500: 500:
@ -47,10 +52,12 @@ paths:
responses: responses:
200: 200:
description: Successful response. description: Successful response.
content:
'application/json':
schema: schema:
type: array type: array
items: items:
$ref: '#/definitions/Wohnung' $ref: '#/components/schemas/Wohnung'
404: 404:
description: No Wohnung available description: No Wohnung available
500: 500:
@ -63,15 +70,18 @@ paths:
parameters: parameters:
- name: id - name: id
in: path in: path
type: integer
required: true required: true
schema:
type: integer
responses: responses:
200: 200:
description: Successful response. description: Successful response.
content:
'application/json':
schema: schema:
type: array type: array
items: items:
$ref: '#/definitions/Wohnung' $ref: '#/components/schemas/Wohnung'
404: 404:
description: No Wohnung available description: No Wohnung available
500: 500:
@ -84,13 +94,16 @@ paths:
parameters: parameters:
- name: id - name: id
in: path in: path
type: integer
required: true required: true
schema:
type: integer
responses: responses:
200: 200:
description: Successful response. description: Successful response.
content:
'application/json':
schema: schema:
$ref: '#/definitions/Wohnung' $ref: '#/components/schemas/Wohnung'
404: 404:
description: Wohnung not found description: Wohnung not found
500: 500:
@ -103,10 +116,12 @@ paths:
responses: responses:
200: 200:
description: Successful response. description: Successful response.
content:
'application/json':
schema: schema:
type: array type: array
items: items:
$ref: '#/definitions/Mieter' $ref: '#/components/schemas/Mieter'
404: 404:
description: No Mieter available description: No Mieter available
500: 500:
@ -119,13 +134,16 @@ paths:
parameters: parameters:
- name: id - name: id
in: path in: path
type: integer
required: true required: true
schema:
type: integer
responses: responses:
200: 200:
description: Successful response. description: Successful response.
content:
'application/json':
schema: schema:
$ref: '#/definitions/Mieter' $ref: '#/components/schemas/Mieter'
404: 404:
description: Mieter not found description: Mieter not found
500: 500:
@ -138,13 +156,16 @@ paths:
parameters: parameters:
- name: id - name: id
in: path in: path
type: integer
required: true required: true
schema:
type: integer
responses: responses:
200: 200:
description: Successful response. description: Successful response.
content:
'application/json':
schema: schema:
$ref: '#/definitions/Forderung' $ref: '#/components/schemas/Forderung'
404: 404:
description: Forderung not found description: Forderung not found
500: 500:
@ -157,15 +178,18 @@ paths:
parameters: parameters:
- name: mieter_id - name: mieter_id
in: path in: path
type: integer
required: true required: true
schema:
type: integer
responses: responses:
200: 200:
description: Successful response. description: Successful response.
content:
'application/json':
schema: schema:
type: array type: array
items: items:
$ref: '#/definitions/Forderung' $ref: '#/components/schemas/Forderung'
404: 404:
description: No Forderung available description: No Forderung available
500: 500:
@ -178,13 +202,16 @@ paths:
parameters: parameters:
- name: id - name: id
in: path in: path
type: integer
required: true required: true
schema:
type: integer
responses: responses:
200: 200:
description: Successful response. description: Successful response.
content:
'application/json':
schema: schema:
$ref: '#/definitions/Zahlung' $ref: '#/components/schemas/Zahlung'
404: 404:
description: Zahlung not found description: Zahlung not found
500: 500:
@ -197,15 +224,18 @@ paths:
parameters: parameters:
- name: mieter_id - name: mieter_id
in: path in: path
type: integer
required: true required: true
schema:
type: integer
responses: responses:
200: 200:
description: Successful response. description: Successful response.
content:
'application/json':
schema: schema:
type: array type: array
items: items:
$ref: '#/definitions/Zahlung' $ref: '#/components/schemas/Zahlung'
404: 404:
description: No Zahlung available description: No Zahlung available
500: 500:
@ -218,19 +248,23 @@ paths:
parameters: parameters:
- name: mieter_id - name: mieter_id
in: path in: path
type: integer
required: true required: true
schema:
type: integer
- name: year - name: year
in: path in: path
type: integer
required: true required: true
schema:
type: integer
responses: responses:
200: 200:
description: Successful response description: Successful response
content:
'application/json':
schema: schema:
type: array type: array
items: items:
$ref: '#/definitions/ZahlungForderung' $ref: '#/components/schemas/ZahlungForderung'
404: 404:
description: No ZahlungForderung available description: No ZahlungForderung available
500: 500:
@ -243,39 +277,44 @@ paths:
parameters: parameters:
- name: mieter_id - name: mieter_id
in: path in: path
type: integer
required: true required: true
schema:
type: integer
- name: year - name: year
in: path in: path
type: integer
required: true required: true
schema:
type: integer
responses: responses:
200: 200:
description: Successful response description: Successful response
content:
'application/json':
schema: schema:
$ref: '#/definitions/Saldo' $ref: '#/components/schemas/Saldo'
404: 404:
description: Neither Forderungen nor Zahlungen available description: Neither Forderungen nor Zahlungen available
500: 500:
description: Some server error description: Some server error
/hv/zahlung: # /hv/zahlung:
post: # post:
tags: [ "Zahlung" ] # tags: [ "Zahlung" ]
operationId: ZahlungenForderungen.put_zahlung # operationId: ZahlungenForderungen.put_zahlung
summary: Inserts a new Zahlung # summary: Inserts a new Zahlung
parameters: # parameters:
- name: zahlung # - name: zahlung
in: body # in: body
schema: # schema:
$ref: '#/definitions/Zahlung' # $ref: '#/components/schemas/Zahlung'
responses: # responses:
202: # 202:
description: Zahlung successfully inserted # description: Zahlung successfully inserted
500: # 500:
description: Some server or database error # description: Some server or database error
definitions: components:
schemas:
Objekt: Objekt:
description: Objekt type description: Objekt type
type: object type: object