Skip to content

Commit 1d16ffc

Browse files
momentirismomentiris
committed
idk why we still have the old docs for these
1 parent 0ada931 commit 1d16ffc

File tree

3 files changed

+35
-44
lines changed
  • apps/property-tree/src/services/api/core/generated
  • core/src/services/lease-service
  • services/leasing/src/services/lease-service/routes

3 files changed

+35
-44
lines changed

‎apps/property-tree/src/services/api/core/generated/api-types.ts‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1254,14 +1254,10 @@ export interface paths {
12541254
get: {
12551255
parameters: {
12561256
query?: {
1257-
/** @description Whether to include upcoming leases in the response */
1258-
includeUpcomingLeases?: boolean;
1259-
/** @description Whether to include terminated leases in the response */
1260-
includeTerminatedLeases?: boolean;
1257+
/** @description Comma-separated list of statuses to filter by. Valid values are current, upcoming, about-to-end, ended. Default is all statuses. */
1258+
status?: string;
12611259
/** @description Whether to include contact information in the response */
12621260
includeContacts?: boolean;
1263-
/** @description Whether to include rent information in the response */
1264-
includeRentInfo?: boolean;
12651261
};
12661262
path: {
12671263
/** @description Rental object code of the building/residence to fetch leases for. */
@@ -1294,10 +1290,10 @@ export interface paths {
12941290
get: {
12951291
parameters: {
12961292
query?: {
1297-
/** @description Whether to include upcoming leases in the response */
1298-
includeUpcomingLeases?: boolean;
1299-
/** @description Whether to include terminated leases in the response */
1300-
includeTerminatedLeases?: boolean;
1293+
/** @description Comma-separated list of statuses to filter by. Valid values are current, upcoming, about-to-end, ended. Default is all statuses. */
1294+
status?: string;
1295+
/** @description Whether to include contact information in the response */
1296+
includeContacts?: boolean;
13011297
};
13021298
path: {
13031299
/** @description Personal Number (PNR) of the individual to fetch leases for. */
@@ -1324,10 +1320,10 @@ export interface paths {
13241320
get: {
13251321
parameters: {
13261322
query?: {
1327-
/** @description Whether to include upcoming leases in the response */
1328-
includeUpcomingLeases?: boolean;
1329-
/** @description Whether to include terminated leases in the response */
1330-
status?: boolean;
1323+
/** @description Comma-separated list of statuses to filter by. Valid values are current, upcoming, about-to-end, ended. Default is all statuses. */
1324+
status?: string;
1325+
/** @description Whether to include contact information in the response */
1326+
includeContacts?: boolean;
13311327
};
13321328
path: {
13331329
/** @description Contact code of the individual to fetch leases for. */
@@ -1353,6 +1349,10 @@ export interface paths {
13531349
*/
13541350
get: {
13551351
parameters: {
1352+
query?: {
1353+
/** @description Whether to include contact information in the response */
1354+
includeContacts?: boolean;
1355+
};
13561356
path: {
13571357
/** @description The ID of the lease to retrieve. */
13581358
id: string;

‎core/src/services/lease-service/leases.ts‎

Lines changed: 19 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -244,29 +244,16 @@ export const routes = (router: KoaRouter) => {
244244
* type: string
245245
* description: Rental object code of the building/residence to fetch leases for.
246246
* - in: query
247-
* name: includeUpcomingLeases
248-
* schema:
249-
* type: boolean
250-
* default: false
251-
* description: Whether to include upcoming leases in the response
252-
* - in: query
253-
* name: includeTerminatedLeases
247+
* name: status
254248
* schema:
255-
* type: boolean
256-
* default: false
257-
* description: Whether to include terminated leases in the response
249+
* type: string
250+
* description: Comma-separated list of statuses to filter by. Valid values are current, upcoming, about-to-end, ended. Default is all statuses.
258251
* - in: query
259252
* name: includeContacts
260253
* schema:
261254
* type: boolean
262255
* default: false
263256
* description: Whether to include contact information in the response
264-
* - in: query
265-
* name: includeRentInfo
266-
* schema:
267-
* type: boolean
268-
* default: true
269-
* description: Whether to include rent information in the response
270257
* responses:
271258
* '200':
272259
* description: Successful response with leases and related entities
@@ -354,17 +341,16 @@ export const routes = (router: KoaRouter) => {
354341
* type: string
355342
* description: Personal Number (PNR) of the individual to fetch leases for.
356343
* - in: query
357-
* name: includeUpcomingLeases
344+
* name: status
358345
* schema:
359-
* type: boolean
360-
* default: false
361-
* description: Whether to include upcoming leases in the response
346+
* type: string
347+
* description: Comma-separated list of statuses to filter by. Valid values are current, upcoming, about-to-end, ended. Default is all statuses.
362348
* - in: query
363-
* name: includeTerminatedLeases
349+
* name: includeContacts
364350
* schema:
365351
* type: boolean
366352
* default: false
367-
* description: Whether to include terminated leases in the response
353+
* description: Whether to include contact information in the response
368354
* responses:
369355
* '200':
370356
* description: Successful response with leases and related entities
@@ -445,17 +431,16 @@ export const routes = (router: KoaRouter) => {
445431
* type: string
446432
* description: Contact code of the individual to fetch leases for.
447433
* - in: query
448-
* name: includeUpcomingLeases
434+
* name: status
449435
* schema:
450-
* type: boolean
451-
* default: false
452-
* description: Whether to include upcoming leases in the response
436+
* type: string
437+
* description: Comma-separated list of statuses to filter by. Valid values are current, upcoming, about-to-end, ended. Default is all statuses.
453438
* - in: query
454-
* name: status
439+
* name: includeContacts
455440
* schema:
456441
* type: boolean
457442
* default: false
458-
* description: Whether to include terminated leases in the response
443+
* description: Whether to include contact information in the response
459444
* responses:
460445
* '200':
461446
* description: Successful response with leases and related entities
@@ -562,6 +547,12 @@ export const routes = (router: KoaRouter) => {
562547
* schema:
563548
* type: string
564549
* description: The ID of the lease to retrieve.
550+
* - in: query
551+
* name: includeContacts
552+
* schema:
553+
* type: boolean
554+
* default: false
555+
* description: Whether to include contact information in the response
565556
* responses:
566557
* '200':
567558
* description: Successful response with the requested lease and related entities

‎services/leasing/src/services/lease-service/routes/leases.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ export const routes = (router: KoaRouter) => {
303303
* name: status
304304
* schema:
305305
* type: string
306-
* description: The status of the leases to include.
306+
* description: Comma-separated list of statuses to filter by. Valid values are current, upcoming, about-to-end, ended. Default is all statuses.
307307
* responses:
308308
* 200:
309309
* description: Successfully retrieved leases.
@@ -398,7 +398,7 @@ export const routes = (router: KoaRouter) => {
398398
* name: status
399399
* schema:
400400
* type: string
401-
* description: The status of the leases to include.
401+
* description: Comma-separated list of statuses to filter by. Valid values are current, upcoming, about-to-end, ended. Default is all statuses.
402402
* responses:
403403
* 200:
404404
* description: Successfully retrieved leases.

0 commit comments

Comments
 (0)