docs: clarify ISO format for province codes (#12282)

* docs: clarify ISO format for province codes

* regenerate
This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-04-24 15:44:35 +03:00
1 parent cb16f79b8f
commit 97daa5a41c
39 files changed
+14830 -14654

No files matched your search

@@ -60,7 +60,11 @@
* province:
* type: string
* title: province
* description: The delivery address's province.
* description: The delivery address's ISO 3166-2 province code. Must be lower-case.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
@@ -14,7 +14,11 @@
* province_code:
* type: string
* title: province_code
* description: The tax region's province code.
* description: The tax region's ISO 3166-2 province code. Must be lower-case.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* parent_id:
* type: string
* title: parent_id
@@ -75,7 +75,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's lower-case ISO 3166-2 province code.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
@@ -60,7 +60,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's lower-case ISO 3166-2 province code.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
@@ -33,7 +33,11 @@
* province_code:
* type: string
* title: province_code
* description: The geo zone's province code.
* description: The geo zone's lower-case ISO 3166-2 province code.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* city:
* type: string
* title: city
@@ -55,7 +55,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's lower-case ISO 3166-2 province code.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
@@ -40,7 +40,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's lower-case ISO 3166-2 province code.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* required:
* - id
* - address_1
@@ -29,7 +29,11 @@
* province_code:
* type: string
* title: province_code
* description: The tax region's province code.
* description: The tax region's lower-case ISO 3166-2 province code.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* metadata:
* type: object
* description: The tax region's metadata, can hold custom key-value pairs.
@@ -49,7 +49,11 @@
* province:
* type: string
* title: province
* description: The shipping address's province.
* description: The shipping address's ISO 3166-2 province code. Must be lower-case.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
@@ -97,7 +101,11 @@
* province:
* type: string
* title: province
* description: The billing address's province.
* description: The billing address's ISO 3166-2 province code. Must be lower-case.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
@@ -49,7 +49,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's ISO 3166-2 province code. Must be lower-case.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
@@ -97,7 +101,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's ISO 3166-2 province code. Must be lower-case.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
@@ -47,7 +47,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's ISO 3166-2 province code. Must be lower-case.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* address_id:
* type: string
* title: address_id
@@ -7,7 +7,11 @@
* province_code:
* type: string
* title: province_code
* description: The tax region's province code.
* description: The tax region's ISO 3166-2 province code. Must be lower-case.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* metadata:
* type: object
* description: The tax region's metadata, can hold custom key-value pairs.
@@ -39,7 +39,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's ISO 3166-2 province code. Must be lower-case.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
*
*/
@@ -53,7 +53,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's lower-case ISO 3166-2 province code.
* example: "US-CA"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
@@ -40,7 +40,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's ISO 3166-2 province code. Must be lower-case.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
@@ -52,7 +52,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's lower-case ISO 3166-2 province code.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
@@ -52,7 +52,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's lower-case ISO 3166-2 province code.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
@@ -75,7 +75,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's lower-case ISO 3166-2 province code.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
@@ -55,7 +55,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's lower-case ISO 3166-2 province code.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
@@ -46,7 +46,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's ISO 3166-2 province code. Must be lower-case.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code