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

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

docs/api/admin/components/examples/database_error.yaml

@@ -0,0 +1,5 @@
+summary: Database Error
+value:
+  code: api_error
+  message: An error occured while hashing password
+  type: database_error

docs/api/admin/components/examples/default_error.yaml

@@ -0,0 +1,5 @@
+summary: Default Error
+value:
+  code: unknown_error
+  message: An unknown error occurred.
+  type: unknown_error

docs/api/admin/components/examples/invalid_argument_error.yaml

@@ -0,0 +1,4 @@
+summary: Invalid Argument Error
+value:
+  message: cart.total must be defined
+  type: unexpected_state

docs/api/admin/components/examples/invalid_data_error.yaml

@@ -0,0 +1,4 @@
+summary: Invalid Data Error
+value:
+  message: first_name must be a string
+  type: invalid_data

docs/api/admin/components/examples/multiple_errors.yaml

@@ -0,0 +1,10 @@
+summary: Multiple Errors
+value:
+  message: >-
+    Provided request body contains errors. Please check the data and retry the
+    request
+  errors:
+    - message: first_name must be a string
+      type: invalid_data
+    - message: Discount must be set to dynamic
+      type: not_allowed

docs/api/admin/components/examples/not_allowed_error.yaml

@@ -0,0 +1,4 @@
+summary: Not Allowed Error
+value:
+  message: Discount must be set to dynamic
+  type: not_allowed

docs/api/admin/components/examples/unexpected_state_error.yaml

@@ -0,0 +1,4 @@
+summary: Unexpected State Error
+value:
+  message: cart.total must be defined
+  type: unexpected_state

docs/api/admin/components/responses/400_error.yaml

@@ -0,0 +1,14 @@
+description: Client Error or Multiple Errors
+content:
+  application/json:
+    schema:
+      oneOf:
+        - $ref: ../schemas/error.yaml
+        - $ref: ../schemas/multiple_errors.yaml
+    examples:
+      not_allowed:
+        $ref: ../examples/not_allowed_error.yaml
+      invalid_data:
+        $ref: ../examples/invalid_data_error.yaml
+      multiple_errors:
+        $ref: ../examples/multiple_errors.yaml

docs/api/admin/components/responses/500_error.yaml

@@ -0,0 +1,14 @@
+description: Server Error
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/error.yaml
+    examples:
+      database:
+        $ref: ../examples/database_error.yaml
+      unexpected_state:
+        $ref: ../examples/unexpected_state_error.yaml
+      invalid_argument:
+        $ref: ../examples/invalid_argument_error.yaml
+      default_error:
+        $ref: ../examples/default_error.yaml

docs/api/admin/components/responses/default_error.yaml

@@ -0,0 +1,9 @@
+description: Default Error
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/error.yaml
+    example:
+      code: unknown_error
+      message: An unknown error occurred.
+      type: unknown_error

docs/api/admin/components/responses/incorrect_credentials.yaml

@@ -0,0 +1,7 @@
+description: User does not exist or incorrect credentials
+content:
+  text/plain:
+    schema:
+      type: string
+      default: Unauthorized
+      example: Unauthorized

docs/api/admin/components/responses/invalid_request_error.yaml

@@ -0,0 +1,9 @@
+description: Invalid Request Error
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/error.yaml
+    example:
+      code: invalid_request_error
+      message: Discount with code TEST already exists.
+      type: duplicate_error

docs/api/admin/components/responses/invalid_state_error.yaml

@@ -0,0 +1,11 @@
+description: Invalid State Error
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/error.yaml
+    example:
+      code: unknown_error
+      message: >-
+        The request conflicted with another request. You may retry the request
+        with the provided Idempotency-Key.
+      type: QueryRunnerAlreadyReleasedError

docs/api/admin/components/responses/not_found_error.yaml

@@ -0,0 +1,8 @@
+description: Not Found Error
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/error.yaml
+    example:
+      message: Entity with id 1 was not found
+      type: not_found

docs/api/admin/components/responses/unauthorized.yaml

@@ -0,0 +1,7 @@
+description: User is not authorized. Must log in first
+content:
+  text/plain:
+    schema:
+      type: string
+      default: Unauthorized
+      example: Unauthorized

docs/api/admin/components/schemas/error.yaml

@@ -0,0 +1,12 @@
+title: Response Error
+x-resourceId: error
+properties:
+  code:
+    type: string
+    description: A slug code to indicate the type of the error.
+  message:
+    type: string
+    description: Description of the error that occurred.
+  type:
+    type: string
+    description: A slug indicating the type of the error.

docs/api/admin/components/schemas/multiple_errors.yaml

@@ -0,0 +1,13 @@
+title: Multiple Errors
+x-resourceId: multiple_errors
+properties:
+  errors:
+    type: array
+    description: Array of errors
+    items:
+      $ref: ./error.yaml
+  message:
+    type: string
+    default: >-
+      Provided request body contains errors. Please check the data and retry the
+      request