chore(oas): [12/n] improve oas schemas (#9200)

- improve OAS schemas [12/n]
- Support ignoring properties in type if it has the `@ignore` jsdoc tag.
This commit is contained in:
Shahed Nasser
2024-09-19 14:25:16 +00:00
committed by GitHub
parent 89928dfdf3
commit 4923a6e823
20 changed files with 287 additions and 149 deletions
@@ -1,7 +1,7 @@
/**
* @schema AdminServiceZoneDeleteResponse
* type: object
* description: SUMMARY
* description: The details of the service zone deletion.
* x-schemaName: AdminServiceZoneDeleteResponse
* required:
* - id
@@ -11,15 +11,16 @@
* id:
* type: string
* title: id
* description: The fulfillment set's ID.
* description: The service zone's ID.
* object:
* type: string
* title: object
* description: The name of the deleted object.
* default: "service_zone"
* deleted:
* type: boolean
* title: deleted
* description: Whether the Fulfillment Set was deleted.
* description: Whether the service zone was deleted.
* parent:
* $ref: "#/components/schemas/AdminFulfillmentSet"
*