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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

docs/api/store/paths/auth.yaml

@@ -5,6 +5,15 @@ post:
     Logs a Customer in and authorizes them to view their details. Successful
     authentication will set a session cookie in the Customer's browser.
   parameters: []
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/auth/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/auth/postundefined
   tags:
     - Auth
   responses:
@@ -16,6 +25,18 @@ post:
             properties:
               customer:
                 $ref: ../components/schemas/customer.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '401':
+      $ref: ../components/responses/incorrect_credentials.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml
   requestBody:
     content:
       application/json:
@@ -35,16 +56,47 @@ delete:
   operationId: DeleteAuth
   summary: Log out
   description: Destroys a Customer's authenticated session.
+  x-authenticated: true
+  x-codeSamples:
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/auth/deleteundefined
+  security:
+    - cookie_auth: []
   tags:
     - Auth
   responses:
     '200':
       description: OK
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '401':
+      $ref: ../components/responses/unauthorized.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml
 get:
   operationId: GetAuth
   summary: Get Session
   description: Gets the currently logged in Customer.
   x-authenticated: true
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/auth/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/auth/getundefined
+  security:
+    - cookie_auth: []
   tags:
     - Auth
   responses:
@@ -56,5 +108,15 @@ get:
             properties:
               customer:
                 $ref: ../components/schemas/customer.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
     '401':
-      description: Unauthorized
+      $ref: ../components/responses/unauthorized.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/auth_{email}.yaml

@@ -10,6 +10,15 @@ get:
         format: email
       required: true
       description: The email to check if exists.
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/auth_{email}/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/auth_{email}/getundefined
   tags:
     - Auth
   responses:
@@ -22,3 +31,13 @@ get:
               exists:
                 type: boolean
                 description: Whether email exists or not.
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/carts.yaml

@@ -52,6 +52,15 @@ post:
               example:
                 ip: '::1'
                 user_agent: Chrome
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/carts/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/carts/postundefined
   tags:
     - Cart
   responses:
@@ -63,3 +72,13 @@ post:
             properties:
               cart:
                 $ref: ../components/schemas/cart.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/carts_{id}.yaml

@@ -9,6 +9,15 @@ get:
       description: The id of the Cart.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/carts_{id}/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/carts_{id}/getundefined
   tags:
     - Cart
   responses:
@@ -20,6 +29,16 @@ get:
             properties:
               cart:
                 $ref: ../components/schemas/cart.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml
 post:
   operationId: PostCartsCart
   summary: Update a Cart
@@ -96,6 +115,15 @@ post:
               example:
                 ip: '::1'
                 user_agent: Chrome
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/carts_{id}/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/carts_{id}/postundefined
   tags:
     - Cart
   responses:
@@ -107,3 +135,13 @@ post:
             properties:
               cart:
                 $ref: ../components/schemas/cart.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/carts_{id}_complete.yaml

@@ -15,6 +15,15 @@ post:
       description: The Cart id.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/carts_{id}_complete/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/carts_{id}_complete/postundefined
   tags:
     - Cart
   responses:
@@ -62,3 +71,13 @@ post:
                     properties:
                       cart:
                         $ref: ../components/schemas/swap.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/carts_{id}_discounts_{code}.yaml

@@ -15,6 +15,15 @@ delete:
       description: The unique Discount code.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/carts_{id}_discounts_{code}/deleteundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/carts_{id}_discounts_{code}/deleteundefined
   tags:
     - Cart
   responses:
@@ -26,3 +35,13 @@ delete:
             properties:
               cart:
                 $ref: ../components/schemas/cart.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/carts_{id}_line-items.yaml

@@ -9,6 +9,15 @@ post:
       description: The id of the Cart to add the Line Item to.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/carts_{id}_line-items/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/carts_{id}_line-items/postundefined
   tags:
     - Cart
   responses:
@@ -20,6 +29,16 @@ post:
             properties:
               cart:
                 $ref: ../components/schemas/cart.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml
   requestBody:
     content:
       application/json:

docs/api/store/paths/carts_{id}_line-items_{line_id}.yaml

@@ -15,6 +15,16 @@ delete:
       description: The id of the Line Item.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: >-
+          ../code_samples/JavaScript/carts_{id}_line-items_{line_id}/deleteundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/carts_{id}_line-items_{line_id}/deleteundefined
   tags:
     - Cart
   responses:
@@ -26,6 +36,16 @@ delete:
             properties:
               cart:
                 $ref: ../components/schemas/cart.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml
 post:
   operationId: PostCartsCartLineItemsItem
   summary: Update a Line Item
@@ -43,6 +63,16 @@ post:
       description: The id of the Line Item.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: >-
+          ../code_samples/JavaScript/carts_{id}_line-items_{line_id}/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/carts_{id}_line-items_{line_id}/postundefined
   tags:
     - Cart
   responses:
@@ -54,6 +84,16 @@ post:
             properties:
               cart:
                 $ref: ../components/schemas/cart.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml
   requestBody:
     content:
       application/json:

docs/api/store/paths/carts_{id}_payment-session.yaml

@@ -11,6 +11,15 @@ post:
       description: The ID of the Cart.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/carts_{id}_payment-session/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/carts_{id}_payment-session/postundefined
   tags:
     - Cart
   responses:
@@ -22,6 +31,16 @@ post:
             properties:
               cart:
                 $ref: ../components/schemas/cart.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml
   requestBody:
     content:
       application/json:

docs/api/store/paths/carts_{id}_payment-sessions.yaml

@@ -11,6 +11,15 @@ post:
       description: The id of the Cart.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/carts_{id}_payment-sessions/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/carts_{id}_payment-sessions/postundefined
   tags:
     - Cart
   responses:
@@ -22,3 +31,13 @@ post:
             properties:
               cart:
                 $ref: ../components/schemas/cart.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/carts_{id}_payment-sessions_{provider_id}.yaml

@@ -17,6 +17,17 @@ delete:
         deleted.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: >-
+          ../code_samples/JavaScript/carts_{id}_payment-sessions_{provider_id}/deleteundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: >-
+          ../code_samples/Shell/carts_{id}_payment-sessions_{provider_id}/deleteundefined
   tags:
     - Cart
   responses:
@@ -28,6 +39,16 @@ delete:
             properties:
               cart:
                 $ref: ../components/schemas/cart.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml
 post:
   operationId: PostCartsCartPaymentSessionUpdate
   summary: Update a Payment Session
@@ -45,6 +66,17 @@ post:
       description: The id of the payment provider.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: >-
+          ../code_samples/JavaScript/carts_{id}_payment-sessions_{provider_id}/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: >-
+          ../code_samples/Shell/carts_{id}_payment-sessions_{provider_id}/postundefined
   tags:
     - Cart
   responses:
@@ -56,6 +88,16 @@ post:
             properties:
               cart:
                 $ref: ../components/schemas/cart.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml
   requestBody:
     content:
       application/json:

docs/api/store/paths/carts_{id}_payment-sessions_{provider_id}_refresh.yaml

@@ -19,6 +19,17 @@ post:
         refreshed.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: >-
+          ../code_samples/JavaScript/carts_{id}_payment-sessions_{provider_id}_refresh/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: >-
+          ../code_samples/Shell/carts_{id}_payment-sessions_{provider_id}_refresh/postundefined
   tags:
     - Cart
   responses:
@@ -30,3 +41,13 @@ post:
             properties:
               cart:
                 $ref: ../components/schemas/cart.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/carts_{id}_shipping-methods.yaml

@@ -2,8 +2,6 @@ post:
   operationId: PostCartsCartShippingMethod
   description: Adds a Shipping Method to the Cart.
   summary: Add a Shipping Method
-  tags:
-    - Cart
   parameters:
     - in: path
       name: id
@@ -11,6 +9,17 @@ post:
       description: The cart ID.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/carts_{id}_shipping-methods/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/carts_{id}_shipping-methods/postundefined
+  tags:
+    - Cart
   responses:
     '200':
       description: OK
@@ -20,6 +29,16 @@ post:
             properties:
               cart:
                 $ref: ../components/schemas/cart.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml
   requestBody:
     content:
       application/json:

docs/api/store/paths/carts_{id}_taxes.yaml

@@ -11,6 +11,11 @@ post:
       description: The Cart ID.
       schema:
         type: string
+  x-codeSamples:
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/carts_{id}_taxes/postundefined
   tags:
     - Cart
   responses:
@@ -22,3 +27,13 @@ post:
             properties:
               cart:
                 $ref: ../components/schemas/cart.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/collections.yaml

@@ -61,6 +61,15 @@ get:
             type: string
             description: filter by dates greater than or equal to this date
             format: date
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/collections/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/collections/getundefined
   tags:
     - Collection
   responses:
@@ -83,3 +92,13 @@ get:
               limit:
                 type: integer
                 description: The number of items per page
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/collections_{id}.yaml

@@ -9,6 +9,15 @@ get:
       description: The id of the Product Collection
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/collections_{id}/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/collections_{id}/getundefined
   tags:
     - Collection
   responses:
@@ -20,3 +29,13 @@ get:
             properties:
               collection:
                 $ref: ../components/schemas/product_collection.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/customers.yaml

@@ -29,6 +29,15 @@ post:
             phone:
               description: The Customer's phone number.
               type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/customers/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/customers/postundefined
   tags:
     - Customer
   responses:
@@ -40,6 +49,12 @@ post:
             properties:
               customer:
                 $ref: ../components/schemas/customer.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
     '422':
       description: A customer with the same email exists
       content:
@@ -61,3 +76,5 @@ post:
             message: >-
               A customer with the given email already has an account. Log in
               instead
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/customers_me.yaml

@@ -5,6 +5,17 @@ get:
     Retrieves a Customer - the Customer must be logged in to retrieve their
     details.
   x-authenticated: true
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/customers_me/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/customers_me/getundefined
+  security:
+    - cookie_auth: []
   tags:
     - Customer
   responses:
@@ -16,6 +27,18 @@ get:
             properties:
               customer:
                 $ref: ../components/schemas/customer.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '401':
+      $ref: ../components/responses/unauthorized.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml
 post:
   operationId: PostCustomersCustomer
   summary: Update Customer details
@@ -51,6 +74,17 @@ post:
             metadata:
               description: Metadata about the customer.
               type: object
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/customers_me/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/customers_me/postundefined
+  security:
+    - cookie_auth: []
   tags:
     - Customer
   responses:
@@ -62,3 +96,15 @@ post:
             properties:
               customer:
                 $ref: ../components/schemas/customer.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '401':
+      $ref: ../components/responses/unauthorized.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/customers_me_addresses.yaml

@@ -14,6 +14,17 @@ post:
               description: The Address to add to the Customer.
               anyOf:
                 - $ref: ../components/schemas/address.yaml
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/customers_me_addresses/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/customers_me_addresses/postundefined
+  security:
+    - cookie_auth: []
   tags:
     - Customer
   responses:
@@ -25,3 +36,15 @@ post:
             properties:
               customer:
                 $ref: ../components/schemas/customer.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '401':
+      $ref: ../components/responses/unauthorized.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/customers_me_addresses_{address_id}.yaml

@@ -10,6 +10,19 @@ delete:
       description: The id of the Address to remove.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: >-
+          ../code_samples/JavaScript/customers_me_addresses_{address_id}/deleteundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: >-
+          ../code_samples/Shell/customers_me_addresses_{address_id}/deleteundefined
+  security:
+    - cookie_auth: []
   tags:
     - Customer
   responses:
@@ -21,6 +34,18 @@ delete:
             properties:
               customer:
                 $ref: ../components/schemas/customer.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '401':
+      $ref: ../components/responses/unauthorized.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml
 post:
   operationId: PostCustomersCustomerAddressesAddress
   summary: Update a Shipping Address
@@ -39,6 +64,19 @@ post:
         schema:
           anyOf:
             - $ref: ../components/schemas/address.yaml
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: >-
+          ../code_samples/JavaScript/customers_me_addresses_{address_id}/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: >-
+          ../code_samples/Shell/customers_me_addresses_{address_id}/postundefined
+  security:
+    - cookie_auth: []
   tags:
     - Customer
   responses:
@@ -50,3 +88,15 @@ post:
             properties:
               customer:
                 $ref: ../components/schemas/customer.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '401':
+      $ref: ../components/responses/unauthorized.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/customers_me_orders.yaml

@@ -163,6 +163,17 @@ get:
         resulting orders.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/customers_me_orders/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/customers_me_orders/getundefined
+  security:
+    - cookie_auth: []
   tags:
     - Customer
   responses:
@@ -185,3 +196,15 @@ get:
               limit:
                 type: integer
                 description: The number of items per page
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '401':
+      $ref: ../components/responses/unauthorized.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/customers_me_payment-methods.yaml

@@ -6,6 +6,17 @@ get:
     saved with Payment Providers and it is their responsibility to fetch saved
     methods.
   x-authenticated: true
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/customers_me_payment-methods/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/customers_me_payment-methods/getundefined
+  security:
+    - cookie_auth: []
   tags:
     - Customer
   responses:
@@ -29,3 +40,15 @@ get:
                       description: >-
                         The data needed for the Payment Provider to use the
                         saved payment method.
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '401':
+      $ref: ../components/responses/unauthorized.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/customers_password-reset.yaml

@@ -24,6 +24,15 @@ post:
             token:
               description: The reset password token
               type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/customers_password-reset/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/customers_password-reset/postundefined
   tags:
     - Customer
   responses:
@@ -35,3 +44,15 @@ post:
             properties:
               customer:
                 $ref: ../components/schemas/customer.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '401':
+      $ref: ../components/responses/unauthorized.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/customers_password-token.yaml

@@ -16,8 +16,29 @@ post:
               description: The email of the customer.
               type: string
               format: email
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/customers_password-token/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/customers_password-token/postundefined
   tags:
     - Customer
   responses:
     '204':
       description: OK
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '401':
+      $ref: ../components/responses/unauthorized.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/gift-cards_{code}.yaml

@@ -9,6 +9,15 @@ get:
       description: The unique Gift Card code.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/gift-cards_{code}/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/gift-cards_{code}/getundefined
   tags:
     - Gift Card
   responses:
@@ -20,3 +29,13 @@ get:
             properties:
               gift_card:
                 $ref: ../components/schemas/gift_card.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/orders.yaml

@@ -29,6 +29,15 @@ get:
           postal_code:
             type: string
             description: The postal code of the shipping address
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/orders/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/orders/getundefined
   tags:
     - Order
   responses:
@@ -40,3 +49,13 @@ get:
             properties:
               order:
                 $ref: ../components/schemas/order.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/orders_cart_{cart_id}.yaml

@@ -9,6 +9,15 @@ get:
       description: The ID of Cart.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/orders_cart_{cart_id}/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/orders_cart_{cart_id}/getundefined
   tags:
     - Order
   responses:
@@ -20,3 +29,13 @@ get:
             properties:
               order:
                 $ref: ../components/schemas/order.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/orders_{id}.yaml

@@ -9,6 +9,15 @@ get:
       description: The id of the Order.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/orders_{id}/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/orders_{id}/getundefined
   tags:
     - Order
   responses:
@@ -20,3 +29,13 @@ get:
             properties:
               order:
                 $ref: ../components/schemas/order.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/products.yaml

@@ -134,6 +134,15 @@ get:
         result.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/products/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/products/getundefined
   tags:
     - Product
   responses:
@@ -156,3 +165,13 @@ get:
               limit:
                 type: integer
                 description: The number of items per page
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/products_search.yaml

@@ -1,5 +1,5 @@
-get:
-  operationId: GetProductsSearch
+post:
+  operationId: PostProductsSearch
   summary: Search Products
   description: Run a search query on products using the search engine installed on Medusa
   parameters:
@@ -19,6 +19,15 @@ get:
       description: Limit the number of products returned.
       schema:
         type: integer
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/products_search/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/products_search/postundefined
   tags:
     - Product
   responses:
@@ -33,3 +42,13 @@ get:
                 description: >-
                   Array of results. The format of the items depends on the
                   search engine installed on the server.
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/products_{id}.yaml

@@ -9,6 +9,15 @@ get:
       description: The id of the Product.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/products_{id}/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/products_{id}/getundefined
   tags:
     - Product
   responses:
@@ -20,3 +29,13 @@ get:
             properties:
               product:
                 $ref: ../components/schemas/product.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/regions.yaml

@@ -59,6 +59,15 @@ get:
             type: string
             description: filter by dates greater than or equal to this date
             format: date
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/regions/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/regions/getundefined
   tags:
     - Region
   responses:
@@ -72,3 +81,13 @@ get:
                 type: array
                 items:
                   $ref: ../components/schemas/region.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/regions_{id}.yaml

@@ -9,6 +9,15 @@ get:
       description: The id of the Region.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/regions_{id}/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/regions_{id}/getundefined
   tags:
     - Region
   responses:
@@ -20,3 +29,13 @@ get:
             properties:
               region:
                 $ref: ../components/schemas/region.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/return-reasons.yaml

@@ -2,6 +2,15 @@ get:
   operationId: GetReturnReasons
   summary: List Return Reasons
   description: Retrieves a list of Return Reasons.
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/return-reasons/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/return-reasons/getundefined
   tags:
     - Return Reason
   responses:
@@ -15,3 +24,13 @@ get:
                 type: array
                 items:
                   $ref: ../components/schemas/return_reason.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/return-reasons_{id}.yaml

@@ -9,6 +9,15 @@ get:
       description: The id of the Return Reason.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/return-reasons_{id}/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/return-reasons_{id}/getundefined
   tags:
     - Return Reason
   responses:
@@ -20,3 +29,13 @@ get:
             properties:
               return_reason:
                 $ref: ../components/schemas/return_reason.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/returns.yaml

@@ -47,6 +47,15 @@ post:
                   description: >-
                     The ID of the Shipping Option to create the Shipping Method
                     from.
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/returns/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/returns/postundefined
   tags:
     - Return
   responses:
@@ -58,3 +67,13 @@ post:
             properties:
               return:
                 $ref: ../components/schemas/return.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/shipping-options.yaml

@@ -20,6 +20,15 @@ get:
       description: the Region to retrieve Shipping Options from.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/shipping-options/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/shipping-options/getundefined
   tags:
     - Shipping Option
   responses:
@@ -33,3 +42,13 @@ get:
                 type: array
                 items:
                   $ref: ../components/schemas/shipping_option.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/shipping-options_{cart_id}.yaml

@@ -9,6 +9,15 @@ get:
       description: The id of the Cart.
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/shipping-options_{cart_id}/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/shipping-options_{cart_id}/getundefined
   tags:
     - Shipping Option
   responses:
@@ -22,3 +31,13 @@ get:
                 type: array
                 items:
                   $ref: ../components/schemas/shipping_option.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/swaps.yaml

@@ -55,6 +55,15 @@ post:
                   quantity:
                     description: The quantity to send of the variant.
                     type: integer
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/swaps/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/swaps/postundefined
   tags:
     - Swap
   responses:
@@ -66,3 +75,13 @@ post:
             properties:
               swap:
                 $ref: ../components/schemas/swap.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/swaps_{cart_id}.yaml

@@ -9,6 +9,15 @@ get:
       description: The id of the Cart
       schema:
         type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/swaps_{cart_id}/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/swaps_{cart_id}/getundefined
   tags:
     - Swap
   responses:
@@ -20,3 +29,13 @@ get:
             properties:
               swap:
                 $ref: ../components/schemas/swap.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/variants.yaml

@@ -62,6 +62,11 @@ get:
                 description: >-
                   filter by inventory quantity greater than or equal to this
                   number
+  x-codeSamples:
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/variants/getundefined
   tags:
     - Product Variant
   responses:
@@ -75,3 +80,13 @@ get:
                 type: array
                 items:
                   $ref: ../components/schemas/product_variant.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml

docs/api/store/paths/variants_{variant_id}.yaml

@@ -29,6 +29,11 @@ get:
         externalDocs:
           url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
           description: See a list of codes.
+  x-codeSamples:
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/variants_{variant_id}/getundefined
   tags:
     - Product Variant
   responses:
@@ -40,3 +45,13 @@ get:
             properties:
               variant:
                 $ref: ../components/schemas/product_variant.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml