oas: [5/n] improve oas schemas (#9066)

Improve oas schemas [5/n]
2024-09-10 12:03:18 +00:00
parent a944226025
commit 5eafa5a184
15 changed files with 124 additions and 77 deletions
@@ -1,8 +1,61 @@
 /**
 * @schema AdminGeoZone
 * type: object
- * description: The geo zone's geo zones.
+ * description: The geo zone's details.
 * x-schemaName: AdminGeoZone
+ * required:
+ *   - id
+ *   - type
+ *   - country_code
+ *   - province_code
+ *   - city
+ *   - postal_expression
+ *   - created_at
+ *   - updated_at
+ *   - deleted_at
+ * properties:
+ *   id:
+ *     type: string
+ *     title: id
+ *     description: The geo zone's ID.
+ *   type:
+ *     type: string
+ *     description: The geo zone's type.
+ *     enum:
+ *       - country
+ *       - province
+ *       - city
+ *       - zip
+ *   country_code:
+ *     type: string
+ *     title: country_code
+ *     description: The geo zone's country code.
+ *   province_code:
+ *     type: string
+ *     title: province_code
+ *     description: The geo zone's province code.
+ *   city:
+ *     type: string
+ *     title: city
+ *     description: The geo zone's city.
+ *   postal_expression:
+ *     type: object
+ *     description: The geo zone's postal expression.
+ *   created_at:
+ *     type: string
+ *     format: date-time
+ *     title: created_at
+ *     description: The date the geo zone was created.
+ *   updated_at:
+ *     type: string
+ *     format: date-time
+ *     title: updated_at
+ *     description: The date the geo zone was update.
+ *   deleted_at:
+ *     type: string
+ *     format: date-time
+ *     title: deleted_at
+ *     description: The date the geo zone was deleted.
 * 
 */