docs: generate OAS with events (#12394)

* docs: generate OAS with events * small change
2025-05-07 14:57:03 +03:00
parent 262064fe96
commit a3bdb3e383
515 changed files with 3808 additions and 189 deletions
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml
@@ -58,7 +58,11 @@ properties:
      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
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml
@@ -12,7 +12,11 @@ properties:
  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
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerAddress.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerAddress.yaml
@@ -73,7 +73,11 @@ properties:
  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
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentAddress.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentAddress.yaml
@@ -58,7 +58,11 @@ properties:
  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
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminGeoZone.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminGeoZone.yaml
@@ -31,7 +31,11 @@ properties:
  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
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderAddress.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderAddress.yaml
@@ -53,7 +53,11 @@ properties:
  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
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationAddress.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationAddress.yaml
@@ -38,7 +38,11 @@ properties:
  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
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml
@@ -27,7 +27,11 @@ properties:
  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.
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateDraftOrder.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateDraftOrder.yaml
@@ -47,7 +47,11 @@ properties:
      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
@@ -95,7 +99,11 @@ properties:
      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
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml
@@ -47,7 +47,11 @@ properties:
      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
@@ -95,7 +99,11 @@ properties:
      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
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml
@@ -47,7 +47,11 @@ properties:
      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
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRegion.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRegion.yaml
@@ -5,7 +5,11 @@ properties:
  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.
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpsertStockLocationAddress.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpsertStockLocationAddress.yaml
@@ -37,4 +37,8 @@ properties:
  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
--- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml
@@ -51,7 +51,11 @@ properties:
  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
--- a/www/apps/api-reference/specs/admin/components/schemas/CreateAddress.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/CreateAddress.yaml
@@ -38,7 +38,11 @@ properties:
  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
--- a/www/apps/api-reference/specs/admin/components/schemas/OrderAddress.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/OrderAddress.yaml
@@ -50,7 +50,11 @@ properties:
  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
--- a/www/apps/api-reference/specs/admin/components/schemas/StoreCartAddress.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCartAddress.yaml
@@ -50,7 +50,11 @@ properties:
  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
--- a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddress.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddress.yaml
@@ -73,7 +73,11 @@ properties:
  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
--- a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderAddress.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderAddress.yaml
@@ -53,7 +53,11 @@ properties:
  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
--- a/www/apps/api-reference/specs/admin/components/schemas/UpdateAddress.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/UpdateAddress.yaml
@@ -44,7 +44,11 @@ properties:
  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