generated
This commit is contained in:
577
openapi.yaml
577
openapi.yaml
@ -1,3 +1,6 @@
|
||||
|
||||
|
||||
|
||||
openapi: 3.0.0
|
||||
info:
|
||||
title: hv2-api
|
||||
@ -12,25 +15,11 @@ externalDocs:
|
||||
url: "https://home.hottis.de/dokuwiki/doku.php?id=hv2pub:externaldocs"
|
||||
|
||||
paths:
|
||||
/v1/test:
|
||||
get:
|
||||
tags: [ "Test" ]
|
||||
summary: Return secret string
|
||||
operationId: auth.testToken
|
||||
responses:
|
||||
'200':
|
||||
description: secret response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
$ref: '#/components/schemas/TestOutput'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/accounts:
|
||||
get:
|
||||
tags: [ "Account" ]
|
||||
tags: [ "account" ]
|
||||
summary: Return all normalized accounts
|
||||
operationId: account.getAccounts
|
||||
operationId: methods.get_accounts
|
||||
responses:
|
||||
'200':
|
||||
description: accounts response
|
||||
@ -39,14 +28,14 @@ paths:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Account'
|
||||
$ref: '#/components/schemas/account'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/accounts/{accountId}:
|
||||
get:
|
||||
tags: [ "Account" ]
|
||||
tags: [ "account" ]
|
||||
summary: Return the normalized account with given id
|
||||
operationId: account.getAccount
|
||||
operationId: methods.get_account
|
||||
parameters:
|
||||
- name: accountId
|
||||
in: path
|
||||
@ -55,42 +44,20 @@ paths:
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
description: accounts response
|
||||
description: account response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Account'
|
||||
$ref: '#/components/schemas/account'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/tenants:
|
||||
get:
|
||||
tags: [ "Tenant" ]
|
||||
tags: [ "tenant" ]
|
||||
summary: Return all normalized tenants
|
||||
operationId: tenant.getTenants
|
||||
responses:
|
||||
'200':
|
||||
description: tenant response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Tenant'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/tenants/{tenantId}:
|
||||
get:
|
||||
tags: [ "Tenant" ]
|
||||
summary: Return the normalized tenant with given id
|
||||
operationId: tenant.getTenant
|
||||
parameters:
|
||||
- name: tenantId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
operationId: methods.get_tenants
|
||||
responses:
|
||||
'200':
|
||||
description: tenants response
|
||||
@ -99,106 +66,90 @@ paths:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Tenant'
|
||||
$ref: '#/components/schemas/tenant'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/commercialPremises:
|
||||
/v1/tenants/{tenantId}:
|
||||
get:
|
||||
tags: [ "CommercialPremise" ]
|
||||
summary: Return all normalized commercial premises
|
||||
operationId: rentalObjects.getCommercialPremises
|
||||
responses:
|
||||
'200':
|
||||
description: commercial premise response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/CommercialPremise'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/commercialPremises/{commercialPremiseId}:
|
||||
get:
|
||||
tags: [ "CommercialPremise" ]
|
||||
summary: Return the normalized commercial premise with given id
|
||||
operationId: rentalObjects.getCommercialPremise
|
||||
tags: [ "tenant" ]
|
||||
summary: Return the normalized tenant with given id
|
||||
operationId: methods.get_tenant
|
||||
parameters:
|
||||
- name: commercialPremiseId
|
||||
- name: tenantId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
description: commercial premise response
|
||||
description: tenant response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/CommercialPremise'
|
||||
$ref: '#/components/schemas/tenant'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/parkings:
|
||||
/v1/premises:
|
||||
get:
|
||||
tags: [ "Parking" ]
|
||||
summary: Return all normalized parkings
|
||||
operationId: rentalObjects.getParkings
|
||||
tags: [ "premise" ]
|
||||
summary: Return all normalized premises
|
||||
operationId: methods.get_premises
|
||||
responses:
|
||||
'200':
|
||||
description: parkings response
|
||||
description: premises response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Parking'
|
||||
$ref: '#/components/schemas/premise'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/parkings/{parkingId}:
|
||||
/v1/premises/{premiseId}:
|
||||
get:
|
||||
tags: [ "Parking" ]
|
||||
summary: Return the normalized parking with given id
|
||||
operationId: rentalObjects.getParking
|
||||
tags: [ "premise" ]
|
||||
summary: Return the normalized premise with given id
|
||||
operationId: methods.get_premise
|
||||
parameters:
|
||||
- name: parkingId
|
||||
- name: premiseId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
description: parking response
|
||||
description: premise response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Parking'
|
||||
$ref: '#/components/schemas/premise'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/flats:
|
||||
get:
|
||||
tags: [ "Flat" ]
|
||||
tags: [ "flat" ]
|
||||
summary: Return all normalized flats
|
||||
operationId: rentalObjects.getFlats
|
||||
operationId: methods.get_flats
|
||||
responses:
|
||||
'200':
|
||||
description: flat response
|
||||
description: flats response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Flat'
|
||||
$ref: '#/components/schemas/flat'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/flats/{flatId}:
|
||||
get:
|
||||
tags: [ "Flat" ]
|
||||
tags: [ "flat" ]
|
||||
summary: Return the normalized flat with given id
|
||||
operationId: rentalObjects.getFlat
|
||||
operationId: methods.get_flat
|
||||
parameters:
|
||||
- name: flatId
|
||||
in: path
|
||||
@ -213,7 +164,311 @@ paths:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Flat'
|
||||
$ref: '#/components/schemas/flat'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/overhead_advances:
|
||||
get:
|
||||
tags: [ "overhead_advance" ]
|
||||
summary: Return all normalized overhead_advances
|
||||
operationId: methods.get_overhead_advances
|
||||
responses:
|
||||
'200':
|
||||
description: overhead_advances response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/overhead_advance'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/overhead_advances/{overhead_advanceId}:
|
||||
get:
|
||||
tags: [ "overhead_advance" ]
|
||||
summary: Return the normalized overhead_advance with given id
|
||||
operationId: methods.get_overhead_advance
|
||||
parameters:
|
||||
- name: overhead_advanceId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
description: overhead_advance response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/overhead_advance'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/overhead_advance_flat_mappings:
|
||||
get:
|
||||
tags: [ "overhead_advance_flat_mapping" ]
|
||||
summary: Return all normalized overhead_advance_flat_mappings
|
||||
operationId: methods.get_overhead_advance_flat_mappings
|
||||
responses:
|
||||
'200':
|
||||
description: overhead_advance_flat_mappings response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/overhead_advance_flat_mapping'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/overhead_advance_flat_mappings/{overhead_advance_flat_mappingId}:
|
||||
get:
|
||||
tags: [ "overhead_advance_flat_mapping" ]
|
||||
summary: Return the normalized overhead_advance_flat_mapping with given id
|
||||
operationId: methods.get_overhead_advance_flat_mapping
|
||||
parameters:
|
||||
- name: overhead_advance_flat_mappingId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
description: overhead_advance_flat_mapping response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/overhead_advance_flat_mapping'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/parkings:
|
||||
get:
|
||||
tags: [ "parking" ]
|
||||
summary: Return all normalized parkings
|
||||
operationId: methods.get_parkings
|
||||
responses:
|
||||
'200':
|
||||
description: parkings response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/parking'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/parkings/{parkingId}:
|
||||
get:
|
||||
tags: [ "parking" ]
|
||||
summary: Return the normalized parking with given id
|
||||
operationId: methods.get_parking
|
||||
parameters:
|
||||
- name: parkingId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
description: parking response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/parking'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/commercial_premises:
|
||||
get:
|
||||
tags: [ "commercial_premise" ]
|
||||
summary: Return all normalized commercial_premises
|
||||
operationId: methods.get_commercial_premises
|
||||
responses:
|
||||
'200':
|
||||
description: commercial_premises response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/commercial_premise'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/commercial_premises/{commercial_premiseId}:
|
||||
get:
|
||||
tags: [ "commercial_premise" ]
|
||||
summary: Return the normalized commercial_premise with given id
|
||||
operationId: methods.get_commercial_premise
|
||||
parameters:
|
||||
- name: commercial_premiseId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
description: commercial_premise response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/commercial_premise'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/tenancys:
|
||||
get:
|
||||
tags: [ "tenancy" ]
|
||||
summary: Return all normalized tenancys
|
||||
operationId: methods.get_tenancys
|
||||
responses:
|
||||
'200':
|
||||
description: tenancys response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/tenancy'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/tenancys/{tenancyId}:
|
||||
get:
|
||||
tags: [ "tenancy" ]
|
||||
summary: Return the normalized tenancy with given id
|
||||
operationId: methods.get_tenancy
|
||||
parameters:
|
||||
- name: tenancyId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
description: tenancy response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/tenancy'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/fees:
|
||||
get:
|
||||
tags: [ "fee" ]
|
||||
summary: Return all normalized fees
|
||||
operationId: methods.get_fees
|
||||
responses:
|
||||
'200':
|
||||
description: fees response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/fee'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/fees/{feeId}:
|
||||
get:
|
||||
tags: [ "fee" ]
|
||||
summary: Return the normalized fee with given id
|
||||
operationId: methods.get_fee
|
||||
parameters:
|
||||
- name: feeId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
description: fee response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/fee'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/tenancy_fee_mappings:
|
||||
get:
|
||||
tags: [ "tenancy_fee_mapping" ]
|
||||
summary: Return all normalized tenancy_fee_mappings
|
||||
operationId: methods.get_tenancy_fee_mappings
|
||||
responses:
|
||||
'200':
|
||||
description: tenancy_fee_mappings response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/tenancy_fee_mapping'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/tenancy_fee_mappings/{tenancy_fee_mappingId}:
|
||||
get:
|
||||
tags: [ "tenancy_fee_mapping" ]
|
||||
summary: Return the normalized tenancy_fee_mapping with given id
|
||||
operationId: methods.get_tenancy_fee_mapping
|
||||
parameters:
|
||||
- name: tenancy_fee_mappingId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
description: tenancy_fee_mapping response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/tenancy_fee_mapping'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/account_entrys:
|
||||
get:
|
||||
tags: [ "account_entry" ]
|
||||
summary: Return all normalized account_entrys
|
||||
operationId: methods.get_account_entrys
|
||||
responses:
|
||||
'200':
|
||||
description: account_entrys response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/account_entry'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/account_entrys/{account_entryId}:
|
||||
get:
|
||||
tags: [ "account_entry" ]
|
||||
summary: Return the normalized account_entry with given id
|
||||
operationId: methods.get_account_entry
|
||||
parameters:
|
||||
- name: account_entryId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
description: account_entry response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/account_entry'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
|
||||
@ -225,24 +480,16 @@ components:
|
||||
bearerFormat: JWT
|
||||
x-bearerInfoFunc: auth.decodeToken
|
||||
schemas:
|
||||
TestOutput:
|
||||
description: Test Output
|
||||
type: object
|
||||
properties:
|
||||
message:
|
||||
type: string
|
||||
details:
|
||||
type: string
|
||||
Account:
|
||||
description: Account
|
||||
account:
|
||||
description: account
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
description:
|
||||
type: string
|
||||
Tenant:
|
||||
description: Tenant
|
||||
tenant:
|
||||
description: tenant
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
@ -271,28 +518,22 @@ components:
|
||||
type: string
|
||||
account:
|
||||
type: integer
|
||||
CommercialPremise:
|
||||
description: CommercialPremise
|
||||
premise:
|
||||
description: premise
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
description:
|
||||
type: string
|
||||
premise:
|
||||
type: integer
|
||||
Parking:
|
||||
description: Parking
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
description:
|
||||
street:
|
||||
type: string
|
||||
premise:
|
||||
type: integer
|
||||
Flat:
|
||||
description: Flat
|
||||
zip:
|
||||
type: string
|
||||
city:
|
||||
type: string
|
||||
flat:
|
||||
description: flat
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
@ -305,3 +546,107 @@ components:
|
||||
type: number
|
||||
flat_no:
|
||||
type: integer
|
||||
overhead_advance:
|
||||
description: overhead_advance
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
description:
|
||||
type: string
|
||||
amount:
|
||||
type: number
|
||||
startdate:
|
||||
type: string
|
||||
enddate:
|
||||
type: string
|
||||
overhead_advance_flat_mapping:
|
||||
description: overhead_advance_flat_mapping
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
overhead_advance:
|
||||
type: integer
|
||||
flat:
|
||||
type: integer
|
||||
parking:
|
||||
description: parking
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
description:
|
||||
type: string
|
||||
premise:
|
||||
type: integer
|
||||
commercial_premise:
|
||||
description: commercial_premise
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
description:
|
||||
type: string
|
||||
premise:
|
||||
type: integer
|
||||
tenancy:
|
||||
description: tenancy
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
description:
|
||||
type: string
|
||||
tenant:
|
||||
type: integer
|
||||
flat:
|
||||
type: integer
|
||||
parking:
|
||||
type: integer
|
||||
commercial_premise:
|
||||
type: integer
|
||||
startdate:
|
||||
type: string
|
||||
enddate:
|
||||
type: string
|
||||
fee:
|
||||
description: fee
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
description:
|
||||
type: string
|
||||
amount:
|
||||
type: number
|
||||
fee_type:
|
||||
type: string
|
||||
startdate:
|
||||
type: string
|
||||
enddate:
|
||||
type: string
|
||||
tenancy_fee_mapping:
|
||||
description: tenancy_fee_mapping
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
tenancy:
|
||||
type: integer
|
||||
fee:
|
||||
type: integer
|
||||
account_entry:
|
||||
description: account_entry
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
description:
|
||||
type: string
|
||||
account:
|
||||
type: integer
|
||||
created_at:
|
||||
type: string
|
||||
amount:
|
||||
type: number
|
||||
|
||||
Reference in New Issue
Block a user