oas: [4/n] improve oas schemas (#9064)

Improve oas schemas [4/n]
This commit is contained in:
Shahed Nasser
2024-09-09 18:52:49 +00:00
committed by GitHub
parent dfb095e2ea
commit abb5f0c2fe
20 changed files with 143 additions and 143 deletions
@@ -1,7 +1,7 @@
/**
* @schema AdminFulfillmentAddress
* type: object
* description: The fulfillment's delivery address.
* description: An address's details.
* x-schemaName: AdminFulfillmentAddress
* required:
* - id
@@ -24,69 +24,69 @@
* id:
* type: string
* title: id
* description: The delivery address's ID.
* description: The address's ID.
* fulfillment_id:
* type: string
* title: fulfillment_id
* description: The delivery address's fulfillment id.
* description: The ID of the fulfillment that the address belongs to.
* company:
* type: string
* title: company
* description: The delivery address's company.
* description: The address's company.
* first_name:
* type: string
* title: first_name
* description: The delivery address's first name.
* description: The address's first name.
* last_name:
* type: string
* title: last_name
* description: The delivery address's last name.
* description: The address's last name.
* address_1:
* type: string
* title: address_1
* description: The delivery address's address 1.
* description: The address's first line.
* address_2:
* type: string
* title: address_2
* description: The delivery address's address 2.
* description: The address's second line.
* city:
* type: string
* title: city
* description: The delivery address's city.
* description: The address's city.
* country_code:
* type: string
* title: country_code
* description: The delivery address's country code.
* description: The address's country code.
* province:
* type: string
* title: province
* description: The delivery address's province.
* description: The address's province.
* postal_code:
* type: string
* title: postal_code
* description: The delivery address's postal code.
* description: The address's postal code.
* phone:
* type: string
* title: phone
* description: The delivery address's phone.
* description: The address's phone.
* metadata:
* type: object
* description: The delivery address's metadata.
* description: The address's metadata, can hold custom key-value pairs.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The delivery address's created at.
* description: The date the address was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The delivery address's updated at.
* description: The date the address was updated.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The delivery address's deleted at.
* description: The date the address was deleted.
*
*/