diff --git a/swagger.yaml b/swagger.yaml index d8727ed..c937c4d 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -1,4 +1,4 @@ -swagger: '2.0' +openapi: 3.0.0 info: title: Hausverwaltung version: "0.1" @@ -12,10 +12,12 @@ paths: responses: 200: description: Successful response. - schema: - type: array - items: - $ref: '#/definitions/Objekt' + content: + 'application/json': + schema: + type: array + items: + $ref: '#/components/schemas/Objekt' 404: description: No Objekte available 500: @@ -28,13 +30,16 @@ paths: parameters: - name: id in: path - type: integer required: true + schema: + type: integer responses: 200: description: Successful response. - schema: - $ref: '#/definitions/Objekt' + content: + 'application/json': + schema: + $ref: '#/components/schemas/Objekt' 404: description: Objekt not found 500: @@ -47,10 +52,12 @@ paths: responses: 200: description: Successful response. - schema: - type: array - items: - $ref: '#/definitions/Wohnung' + content: + 'application/json': + schema: + type: array + items: + $ref: '#/components/schemas/Wohnung' 404: description: No Wohnung available 500: @@ -63,15 +70,18 @@ paths: parameters: - name: id in: path - type: integer required: true + schema: + type: integer responses: 200: description: Successful response. - schema: - type: array - items: - $ref: '#/definitions/Wohnung' + content: + 'application/json': + schema: + type: array + items: + $ref: '#/components/schemas/Wohnung' 404: description: No Wohnung available 500: @@ -84,13 +94,16 @@ paths: parameters: - name: id in: path - type: integer required: true + schema: + type: integer responses: 200: description: Successful response. - schema: - $ref: '#/definitions/Wohnung' + content: + 'application/json': + schema: + $ref: '#/components/schemas/Wohnung' 404: description: Wohnung not found 500: @@ -103,10 +116,12 @@ paths: responses: 200: description: Successful response. - schema: - type: array - items: - $ref: '#/definitions/Mieter' + content: + 'application/json': + schema: + type: array + items: + $ref: '#/components/schemas/Mieter' 404: description: No Mieter available 500: @@ -119,13 +134,16 @@ paths: parameters: - name: id in: path - type: integer required: true + schema: + type: integer responses: 200: description: Successful response. - schema: - $ref: '#/definitions/Mieter' + content: + 'application/json': + schema: + $ref: '#/components/schemas/Mieter' 404: description: Mieter not found 500: @@ -138,13 +156,16 @@ paths: parameters: - name: id in: path - type: integer required: true + schema: + type: integer responses: 200: description: Successful response. - schema: - $ref: '#/definitions/Forderung' + content: + 'application/json': + schema: + $ref: '#/components/schemas/Forderung' 404: description: Forderung not found 500: @@ -157,15 +178,18 @@ paths: parameters: - name: mieter_id in: path - type: integer required: true + schema: + type: integer responses: 200: description: Successful response. - schema: - type: array - items: - $ref: '#/definitions/Forderung' + content: + 'application/json': + schema: + type: array + items: + $ref: '#/components/schemas/Forderung' 404: description: No Forderung available 500: @@ -178,13 +202,16 @@ paths: parameters: - name: id in: path - type: integer required: true + schema: + type: integer responses: 200: description: Successful response. - schema: - $ref: '#/definitions/Zahlung' + content: + 'application/json': + schema: + $ref: '#/components/schemas/Zahlung' 404: description: Zahlung not found 500: @@ -197,15 +224,18 @@ paths: parameters: - name: mieter_id in: path - type: integer required: true + schema: + type: integer responses: 200: description: Successful response. - schema: - type: array - items: - $ref: '#/definitions/Zahlung' + content: + 'application/json': + schema: + type: array + items: + $ref: '#/components/schemas/Zahlung' 404: description: No Zahlung available 500: @@ -218,19 +248,23 @@ paths: parameters: - name: mieter_id in: path - type: integer required: true + schema: + type: integer - name: year in: path - type: integer required: true + schema: + type: integer responses: 200: description: Successful response - schema: - type: array - items: - $ref: '#/definitions/ZahlungForderung' + content: + 'application/json': + schema: + type: array + items: + $ref: '#/components/schemas/ZahlungForderung' 404: description: No ZahlungForderung available 500: @@ -243,154 +277,159 @@ paths: parameters: - name: mieter_id in: path - type: integer required: true + schema: + type: integer - name: year in: path - type: integer required: true + schema: + type: integer responses: 200: description: Successful response - schema: - $ref: '#/definitions/Saldo' + content: + 'application/json': + schema: + $ref: '#/components/schemas/Saldo' 404: description: Neither Forderungen nor Zahlungen available 500: description: Some server error - /hv/zahlung: - post: - tags: [ "Zahlung" ] - operationId: ZahlungenForderungen.put_zahlung - summary: Inserts a new Zahlung - parameters: - - name: zahlung - in: body - schema: - $ref: '#/definitions/Zahlung' - responses: - 202: - description: Zahlung successfully inserted - 500: - description: Some server or database error +# /hv/zahlung: +# post: +# tags: [ "Zahlung" ] +# operationId: ZahlungenForderungen.put_zahlung +# summary: Inserts a new Zahlung +# parameters: +# - name: zahlung +# in: body +# schema: +# $ref: '#/components/schemas/Zahlung' +# responses: +# 202: +# description: Zahlung successfully inserted +# 500: +# description: Some server or database error -definitions: - Objekt: - description: Objekt type - type: object - properties: - id: - type: integer - shortname: - type: string - flaeche: - type: number - Wohnung: - description: Wohnung type - type: object - properties: - id: - type: integer - objekt: - type: integer - shortname: - type: string - flaeche: - type: number - objekt_shortname: - type: string - Mieter: - description: Mieter type - type: object - properties: - id: - type: integer - objekt: - type: integer - wohnung: - type: integer - wohnung_shortname: - type: string - objekt_shortname: - type: string - anrede: - type: string - vorname: - type: string - nachname: - type: string - strasse: - type: string - plz: - type: string - ort: - type: string - telefon: - type: string - einzug: - type: string - auszug: - type: string - Forderung: - description: Forderung type - type: object - properties: - id: - type: integer - mieter: - type: integer - datum: - type: string - betrag: - type: number - kommentar: - type: string - ref_wohnung: - type: number - Zahlung: - description: Zahlung type - type: object - properties: - id: - type: integer - mieter: - type: integer - datum_ist: - type: string - datum_soll: - type: string - betrag: - type: number - kommentar: - type: string - ZahlungForderung: - description: ZahlungForderung type - type: object - properties: - zf_type: - type: string - id: - type: integer - datum_soll: - type: string - datum_ist: - type: string - betrag_zahlung: - type: number - betrag_forderung: - type: number - kommentar: - type: string - mieter: - type: number - Saldo: - description: Saldo type - type: object - properties: - forderungen: - type: number - zahlungen: - type: number - saldo: - type: number +components: + schemas: + Objekt: + description: Objekt type + type: object + properties: + id: + type: integer + shortname: + type: string + flaeche: + type: number + Wohnung: + description: Wohnung type + type: object + properties: + id: + type: integer + objekt: + type: integer + shortname: + type: string + flaeche: + type: number + objekt_shortname: + type: string + Mieter: + description: Mieter type + type: object + properties: + id: + type: integer + objekt: + type: integer + wohnung: + type: integer + wohnung_shortname: + type: string + objekt_shortname: + type: string + anrede: + type: string + vorname: + type: string + nachname: + type: string + strasse: + type: string + plz: + type: string + ort: + type: string + telefon: + type: string + einzug: + type: string + auszug: + type: string + Forderung: + description: Forderung type + type: object + properties: + id: + type: integer + mieter: + type: integer + datum: + type: string + betrag: + type: number + kommentar: + type: string + ref_wohnung: + type: number + Zahlung: + description: Zahlung type + type: object + properties: + id: + type: integer + mieter: + type: integer + datum_ist: + type: string + datum_soll: + type: string + betrag: + type: number + kommentar: + type: string + ZahlungForderung: + description: ZahlungForderung type + type: object + properties: + zf_type: + type: string + id: + type: integer + datum_soll: + type: string + datum_ist: + type: string + betrag_zahlung: + type: number + betrag_forderung: + type: number + kommentar: + type: string + mieter: + type: number + Saldo: + description: Saldo type + type: object + properties: + forderungen: + type: number + zahlungen: + type: number + saldo: + type: number