hv/hv-service
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Compare commits

merge into: hv:jwt-experiments
Branches Tags
hv:master hv:jwt-experiments-2 hv:openapi3 hv:jwt-experiments
hv:1.1.1 hv:1.1.0 hv:1.0.1 hv:1.0.0
...
pull from: hv:openapi3
Branches Tags
hv:master hv:jwt-experiments-2 hv:openapi3 hv:jwt-experiments
hv:1.1.1 hv:1.1.0 hv:1.0.1 hv:1.0.0

1 Commits
jwt-experi ... openapi3

Author SHA1 Message Date
Wolfgang Hottgenroth
4f4b959e9e successfully moved to openapi 3.0.0 2021-01-24 23:24:20 +01:00
1 changed files with 226 additions and 187 deletions
Expand all files Collapse all files

413
swagger.yaml
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.
schema: content:
type: array 'application/json':
items: schema:
$ref: '#/definitions/Objekt' type: array
items:
$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.
schema: content:
$ref: '#/definitions/Objekt' 'application/json':
schema:
$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.
schema: content:
type: array 'application/json':
items: schema:
$ref: '#/definitions/Wohnung' type: array
items:
$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.
schema: content:
type: array 'application/json':
items: schema:
$ref: '#/definitions/Wohnung' type: array
items:
$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.
schema: content:
$ref: '#/definitions/Wohnung' 'application/json':
schema:
$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.
schema: content:
type: array 'application/json':
items: schema:
$ref: '#/definitions/Mieter' type: array
items:
$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.
schema: content:
$ref: '#/definitions/Mieter' 'application/json':
schema:
$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.
schema: content:
$ref: '#/definitions/Forderung' 'application/json':
schema:
$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.
schema: content:
type: array 'application/json':
items: schema:
$ref: '#/definitions/Forderung' type: array
items:
$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.
schema: content:
$ref: '#/definitions/Zahlung' 'application/json':
schema:
$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.
schema: content:
type: array 'application/json':
items: schema:
$ref: '#/definitions/Zahlung' type: array
items:
$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
schema: content:
type: array 'application/json':
items: schema:
$ref: '#/definitions/ZahlungForderung' type: array
items:
$ref: '#/components/schemas/ZahlungForderung'
404: 404:
description: No ZahlungForderung available description: No ZahlungForderung available
500: 500:
@ -243,154 +277,159 @@ 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
schema: content:
$ref: '#/definitions/Saldo' 'application/json':
schema:
$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:
Objekt: schemas:
description: Objekt type Objekt:
type: object description: Objekt type
properties: type: object
id: properties:
type: integer id:
shortname: type: integer
type: string shortname:
flaeche: type: string
type: number flaeche:
Wohnung: type: number
description: Wohnung type Wohnung:
type: object description: Wohnung type
properties: type: object
id: properties:
type: integer id:
objekt: type: integer
type: integer objekt:
shortname: type: integer
type: string shortname:
flaeche: type: string
type: number flaeche:
objekt_shortname: type: number
type: string objekt_shortname:
Mieter: type: string
description: Mieter type Mieter:
type: object description: Mieter type
properties: type: object
id: properties:
type: integer id:
objekt: type: integer
type: integer objekt:
wohnung: type: integer
type: integer wohnung:
wohnung_shortname: type: integer
type: string wohnung_shortname:
objekt_shortname: type: string
type: string objekt_shortname:
anrede: type: string
type: string anrede:
vorname: type: string
type: string vorname:
nachname: type: string
type: string nachname:
strasse: type: string
type: string strasse:
plz: type: string
type: string plz:
ort: type: string
type: string ort:
telefon: type: string
type: string telefon:
einzug: type: string
type: string einzug:
auszug: type: string
type: string auszug:
Forderung: type: string
description: Forderung type Forderung:
type: object description: Forderung type
properties: type: object
id: properties:
type: integer id:
mieter: type: integer
type: integer mieter:
datum: type: integer
type: string datum:
betrag: type: string
type: number betrag:
kommentar: type: number
type: string kommentar:
ref_wohnung: type: string
type: number ref_wohnung:
Zahlung: type: number
description: Zahlung type Zahlung:
type: object description: Zahlung type
properties: type: object
id: properties:
type: integer id:
mieter: type: integer
type: integer mieter:
datum_ist: type: integer
type: string datum_ist:
datum_soll: type: string
type: string datum_soll:
betrag: type: string
type: number betrag:
kommentar: type: number
type: string kommentar:
ZahlungForderung: type: string
description: ZahlungForderung type ZahlungForderung:
type: object description: ZahlungForderung type
properties: type: object
zf_type: properties:
type: string zf_type:
id: type: string
type: integer id:
datum_soll: type: integer
type: string datum_soll:
datum_ist: type: string
type: string datum_ist:
betrag_zahlung: type: string
type: number betrag_zahlung:
betrag_forderung: type: number
type: number betrag_forderung:
kommentar: type: number
type: string kommentar:
mieter: type: string
type: number mieter:
Saldo: type: number
description: Saldo type Saldo:
type: object description: Saldo type
properties: type: object
forderungen: properties:
type: number forderungen:
zahlungen: type: number
type: number zahlungen:
saldo: type: number
type: number saldo:
type: number