generate endpoint for all foreign key relationships
This commit is contained in:
292
api/openapi.yaml
292
api/openapi.yaml
@ -191,6 +191,28 @@ paths:
|
||||
$ref: '#/components/schemas/tenant'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/tenants/account/{accountId}:
|
||||
get:
|
||||
tags: [ "tenant", "account" ]
|
||||
summary: Return tenant by $account
|
||||
operationId: methods.get_tenant_by_account
|
||||
parameters:
|
||||
- name: accountId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
description: tenant response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/tenant'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/premises:
|
||||
get:
|
||||
tags: [ "premise" ]
|
||||
@ -363,6 +385,28 @@ paths:
|
||||
$ref: '#/components/schemas/flat'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/flats/premise/{premiseId}:
|
||||
get:
|
||||
tags: [ "flat", "premise" ]
|
||||
summary: Return flat by $premise
|
||||
operationId: methods.get_flat_by_premise
|
||||
parameters:
|
||||
- name: premiseId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
description: flat response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/flat'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/overhead_advances:
|
||||
get:
|
||||
tags: [ "overhead_advance" ]
|
||||
@ -508,6 +552,50 @@ paths:
|
||||
$ref: '#/components/schemas/overhead_advance_flat_mapping'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/overhead_advance_flat_mappings/overhead_advance/{overhead_advanceId}:
|
||||
get:
|
||||
tags: [ "overhead_advance_flat_mapping", "overhead_advance" ]
|
||||
summary: Return overhead_advance_flat_mapping by $overhead_advance
|
||||
operationId: methods.get_overhead_advance_flat_mapping_by_overhead_advance
|
||||
parameters:
|
||||
- name: overhead_advanceId
|
||||
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/overhead_advance_flat_mappings/flat/{flatId}:
|
||||
get:
|
||||
tags: [ "overhead_advance_flat_mapping", "flat" ]
|
||||
summary: Return overhead_advance_flat_mapping by $flat
|
||||
operationId: methods.get_overhead_advance_flat_mapping_by_flat
|
||||
parameters:
|
||||
- name: flatId
|
||||
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" ]
|
||||
@ -594,6 +682,28 @@ paths:
|
||||
$ref: '#/components/schemas/parking'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/parkings/premise/{premiseId}:
|
||||
get:
|
||||
tags: [ "parking", "premise" ]
|
||||
summary: Return parking by $premise
|
||||
operationId: methods.get_parking_by_premise
|
||||
parameters:
|
||||
- name: premiseId
|
||||
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" ]
|
||||
@ -680,6 +790,28 @@ paths:
|
||||
$ref: '#/components/schemas/commercial_premise'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/commercial_premises/premise/{premiseId}:
|
||||
get:
|
||||
tags: [ "commercial_premise", "premise" ]
|
||||
summary: Return commercial_premise by $premise
|
||||
operationId: methods.get_commercial_premise_by_premise
|
||||
parameters:
|
||||
- name: 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" ]
|
||||
@ -766,6 +898,94 @@ paths:
|
||||
$ref: '#/components/schemas/tenancy'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/tenancys/tenant/{tenantId}:
|
||||
get:
|
||||
tags: [ "tenancy", "tenant" ]
|
||||
summary: Return tenancy by $tenant
|
||||
operationId: methods.get_tenancy_by_tenant
|
||||
parameters:
|
||||
- name: tenantId
|
||||
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/tenancys/flat/{flatId}:
|
||||
get:
|
||||
tags: [ "tenancy", "flat" ]
|
||||
summary: Return tenancy by $flat
|
||||
operationId: methods.get_tenancy_by_flat
|
||||
parameters:
|
||||
- name: flatId
|
||||
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/tenancys/parking/{parkingId}:
|
||||
get:
|
||||
tags: [ "tenancy", "parking" ]
|
||||
summary: Return tenancy by $parking
|
||||
operationId: methods.get_tenancy_by_parking
|
||||
parameters:
|
||||
- name: parkingId
|
||||
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/tenancys/commercial_premise/{commercial_premiseId}:
|
||||
get:
|
||||
tags: [ "tenancy", "commercial_premise" ]
|
||||
summary: Return tenancy by $commercial_premise
|
||||
operationId: methods.get_tenancy_by_commercial_premise
|
||||
parameters:
|
||||
- name: commercial_premiseId
|
||||
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" ]
|
||||
@ -911,6 +1131,50 @@ paths:
|
||||
$ref: '#/components/schemas/tenancy_fee_mapping'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
/v1/tenancy_fee_mappings/tenancy/{tenancyId}:
|
||||
get:
|
||||
tags: [ "tenancy_fee_mapping", "tenancy" ]
|
||||
summary: Return tenancy_fee_mapping by $tenancy
|
||||
operationId: methods.get_tenancy_fee_mapping_by_tenancy
|
||||
parameters:
|
||||
- name: tenancyId
|
||||
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/tenancy_fee_mappings/fee/{feeId}:
|
||||
get:
|
||||
tags: [ "tenancy_fee_mapping", "fee" ]
|
||||
summary: Return tenancy_fee_mapping by $fee
|
||||
operationId: methods.get_tenancy_fee_mapping_by_fee
|
||||
parameters:
|
||||
- name: feeId
|
||||
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" ]
|
||||
@ -970,37 +1234,35 @@ paths:
|
||||
$ref: '#/components/schemas/account_entry'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
|
||||
# -------------------------------------------------------------------
|
||||
# ATTENTION: This file will not be parsed by Cheetah
|
||||
# Use plain openapi/yaml syntax, no Cheetah
|
||||
# escaping
|
||||
# -------------------------------------------------------------------
|
||||
|
||||
|
||||
/v1/overhead_advance_flat_mappings/flat/{flatId}:
|
||||
/v1/account_entrys/account/{accountId}:
|
||||
get:
|
||||
tags: [ "overhead_advance_flat_mapping", "flat" ]
|
||||
summary: Returns all overhead advance mappings for a given flat
|
||||
operationId: additional_methods.get_overhead_advance_flat_mapping_by_flat
|
||||
tags: [ "account_entry", "account" ]
|
||||
summary: Return account_entry by $account
|
||||
operationId: methods.get_account_entry_by_account
|
||||
parameters:
|
||||
- name: flatId
|
||||
- name: accountId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
description: $table.name response
|
||||
description: account_entry response
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/overhead_advance_flat_mapping'
|
||||
$ref: '#/components/schemas/account_entry'
|
||||
security:
|
||||
- jwt: ['secret']
|
||||
|
||||
# -------------------------------------------------------------------
|
||||
# ATTENTION: This file will not be parsed by Cheetah
|
||||
# Use plain openapi/yaml syntax, no Cheetah
|
||||
# escaping
|
||||
# -------------------------------------------------------------------
|
||||
|
||||
components:
|
||||
securitySchemes:
|
||||
jwt:
|
||||
|
||||
Reference in New Issue
Block a user