oas: [3/n] improve oas schemas (#9042)

Improve oas schemas [3/n]
2024-09-07 06:16:00 +00:00
parent a7180e29b8
commit 4b8d9cc735
20 changed files with 285 additions and 97 deletions
@@ -1,8 +1,42 @@
 /**
 * @schema AdminCustomerGroup
 * type: object
- * description: The group's groups.
+ * description: The customer group's details.
 * x-schemaName: AdminCustomerGroup
+ * required:
+ *   - id
+ *   - name
+ *   - customers
+ *   - metadata
+ *   - created_at
+ *   - updated_at
+ * properties:
+ *   id:
+ *     type: string
+ *     title: id
+ *     description: The customer group's ID.
+ *   name:
+ *     type: string
+ *     title: name
+ *     description: The customer group's name.
+ *   customers:
+ *     type: array
+ *     description: The customer group's customers.
+ *     items:
+ *       $ref: "#/components/schemas/BaseCustomer"
+ *   metadata:
+ *     type: object
+ *     description: The customer group's metadata, used to store custom key-value pairs.
+ *   created_at:
+ *     type: string
+ *     format: date-time
+ *     title: created_at
+ *     description: The customer group's creation date.
+ *   updated_at:
+ *     type: string
+ *     format: date-time
+ *     title: updated_at
+ *     description: The customer group's update date.
 * 
 */