chore(docs): Generated API Reference (#2417)

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2022-10-11 16:11:11 +03:00
parent c4c83c9717
commit 10b9b0dc49
21 changed files with 2818 additions and 2166 deletions
--- a/docs/api/store/paths/customers_me.yaml
+++ b/docs/api/store/paths/customers_me.yaml
@@ -58,7 +58,7 @@ post:
            billing_address:
              description: The Address to be used for billing purposes.
              anyOf:
-                - $ref: ../components/schemas/address.yaml
+                - $ref: ../components/schemas/address_fields.yaml
                  description: The full billing address object
                - type: string
                  description: The ID of an existing billing address
--- a/docs/api/store/paths/customers_me_addresses.yaml
+++ b/docs/api/store/paths/customers_me_addresses.yaml
@@ -12,8 +12,16 @@ post:
          properties:
            address:
              description: The Address to add to the Customer.
-              anyOf:
-                - $ref: ../components/schemas/address.yaml
+              allOf:
+                - $ref: ../components/schemas/address_fields.yaml
+                - type: object
+                  required:
+                    - first_name
+                    - last_name
+                    - address_1
+                    - city
+                    - country_code
+                    - postal_code
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
--- a/docs/api/store/paths/customers_me_addresses_{address_id}.yaml
+++ b/docs/api/store/paths/customers_me_addresses_{address_id}.yaml
@@ -63,7 +63,7 @@ post:
      application/json:
        schema:
          anyOf:
-            - $ref: ../components/schemas/address.yaml
+            - $ref: ../components/schemas/address_fields.yaml
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
--- a/docs/api/store/paths/products.yaml
+++ b/docs/api/store/paths/products.yaml
@@ -155,7 +155,17 @@ get:
              products:
                type: array
                items:
-                  $ref: ../components/schemas/product.yaml
+                  allOf:
+                    - $ref: ../components/schemas/product.yaml
+                    - type: object
+                      properties:
+                        variants:
+                          type: array
+                          items:
+                            allOf:
+                              - $ref: ../components/schemas/product_variant.yaml
+                              - $ref: >-
+                                  ../components/schemas/product_variant_prices_fields.yaml
              count:
                type: integer
                description: The total number of items available
--- a/docs/api/store/paths/products_{id}.yaml
+++ b/docs/api/store/paths/products_{id}.yaml
@@ -52,7 +52,17 @@ get:
          schema:
            properties:
              product:
-                $ref: ../components/schemas/product.yaml
+                allOf:
+                  - $ref: ../components/schemas/product.yaml
+                  - type: object
+                    properties:
+                      variants:
+                        type: array
+                        items:
+                          allOf:
+                            - $ref: ../components/schemas/product_variant.yaml
+                            - $ref: >-
+                                ../components/schemas/product_variant_prices_fields.yaml
    '400':
      $ref: ../components/responses/400_error.yaml
    '404':
--- a/docs/api/store/paths/variants.yaml
+++ b/docs/api/store/paths/variants.yaml
@@ -79,7 +79,9 @@ get:
              variants:
                type: array
                items:
-                  $ref: ../components/schemas/product_variant.yaml
+                  allOf:
+                    - $ref: ../components/schemas/product_variant.yaml
+                    - $ref: ../components/schemas/product_variant_prices_fields.yaml
    '400':
      $ref: ../components/responses/400_error.yaml
    '404':
--- a/docs/api/store/paths/variants_{variant_id}.yaml
+++ b/docs/api/store/paths/variants_{variant_id}.yaml
@@ -44,7 +44,9 @@ get:
          schema:
            properties:
              variant:
-                $ref: ../components/schemas/product_variant.yaml
+                allOf:
+                  - $ref: ../components/schemas/product_variant.yaml
+                  - $ref: ../components/schemas/product_variant_prices_fields.yaml
    '400':
      $ref: ../components/responses/400_error.yaml
    '404':