From e479ebe02083bd1305a334f3084e2a0cbd74c3c0 Mon Sep 17 00:00:00 2001 From: Andrea Vassallo Date: Tue, 10 Jan 2023 14:49:59 +0100 Subject: [PATCH] Add a better description for the api key Some endpoints that are not related to the users can be used without the api key changing the Solidus configuration. Add the instruction to do it. --- api/openapi/authentication.md | 2 + api/openapi/solidus-api.oas.yml | 3513 ++++++++++++++++--------------- 2 files changed, 1759 insertions(+), 1756 deletions(-) diff --git a/api/openapi/authentication.md b/api/openapi/authentication.md index 4ae9674a279..025aed18c56 100644 --- a/api/openapi/authentication.md +++ b/api/openapi/authentication.md @@ -20,6 +20,8 @@ curl --header "Authorization: Bearer 1a6a9936ad150a2ee345c65331da7a3ccc2de" http By default, API keys are only generated for admins, but you can easily customize Solidus to generate them for all users, which is useful for instance if you want users to be able to sign in and manage their profile via the API. +The `API key` is mandatory for each endpoint by default. You can change this configuration [here](https://github.com/solidusio/solidus/blob/master/api/lib/spree/api_configuration.rb#L5) if you want to avoid the default behaviour exposing some endpoints without an API key. An example is the [GET product list](https://solidus.stoplight.io/docs/solidus/08307f3d809e7-list-products). + ### Order token For allowing guests to manage their cart and place their order, you can use the order's guest token. This token is contained in the `guest_token` property of the order, and it allows you to perform certain checkout-related operations on the order such as managing line items, completing the checkout flow etc. diff --git a/api/openapi/solidus-api.oas.yml b/api/openapi/solidus-api.oas.yml index b9631b91683..5babdb7fed2 100644 --- a/api/openapi/solidus-api.oas.yml +++ b/api/openapi/solidus-api.oas.yml @@ -1,58 +1,58 @@ openapi: 3.0.3 +x-stoplight: + docs: + showModels: false info: title: Solidus API - version: '1.0' + version: "1.0" description: The standard Solidus API. contact: name: Solidus - url: 'https://solidus.io' + url: "https://solidus.io" license: - name: '' -x-stoplight: - docs: - showModels: false + name: "" paths: /products: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: products: type: array items: - $ref: '#/components/schemas/product' - '401': - $ref: '#/components/responses/invalid-api-key' + $ref: "#/components/schemas/product" + "401": + $ref: "#/components/responses/invalid-api-key" summary: List products description: Returns a list of available products. operationId: list-products tags: - Products parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/product' - '401': - $ref: '#/components/responses/invalid-api-key' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/product" + "401": + $ref: "#/components/responses/invalid-api-key" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create product description: Creates a product. operationId: create-product @@ -67,13 +67,13 @@ paths: type: object properties: product: - $ref: '#/components/schemas/product-input' + $ref: "#/components/schemas/product-input" examples: Example: value: product: name: The Majestic Product - price: '19.99' + price: "19.99" shipping_category_id: 8 product_properties_attributes: - property_name: fabric @@ -81,7 +81,7 @@ paths: option_types: - size - color - taxon_ids: '2,4' + taxon_ids: "2,4" variants: - price: 19.99 cost_price: 17 @@ -95,45 +95,45 @@ paths: /orders/mine: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: orders: type: array items: - $ref: '#/components/schemas/order-small' - '401': - $ref: '#/components/responses/invalid-api-key' + $ref: "#/components/schemas/order-small" + "401": + $ref: "#/components/responses/invalid-api-key" summary: List user's orders description: Lists the orders that belong to the current user. operationId: list-user-orders tags: - Orders parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] - '/orders/{number}': + "/orders/{number}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/order-big' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/order-big" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get order description: Retrieves an order. operationId: get-order @@ -151,18 +151,18 @@ paths: description: The order number patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/order-big' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/order-big" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update order description: |- Updates an order. @@ -181,7 +181,7 @@ paths: type: object properties: order: - $ref: '#/components/schemas/order-input' + $ref: "#/components/schemas/order-input" examples: Updating Billing Address: value: @@ -193,7 +193,7 @@ paths: city: Phoenix country_id: 22 state_id: 31 - zipcode: '85022' + zipcode: "85022" phone: 509-644-9988 company: Acme Inc. Select a Shipment's Shipping Rate: @@ -206,22 +206,22 @@ paths: value: order: payments_attributes: - - amount: '42.42' + - amount: "42.42" payment_method_id: 1 source_attributes: gateway_payment_profile_id: super-secret-token-2131m3n13bv3hv1vasda - description: '' + description: "" /orders/current: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/order-big' - '401': - $ref: '#/components/responses/invalid-api-key' + $ref: "#/components/schemas/order-big" + "401": + $ref: "#/components/responses/invalid-api-key" summary: Get current order description: Retrieves the user's current order. operationId: get-current-order @@ -233,46 +233,46 @@ paths: /countries: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: countries: items: - $ref: '#/components/schemas/country' + $ref: "#/components/schemas/country" oneOf: - type: string - type: array items: {} - '401': - $ref: '#/components/responses/invalid-api-key' + "401": + $ref: "#/components/responses/invalid-api-key" summary: List countries description: Lists all available countries. operationId: list-countries tags: - Countries parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' - '/countries/{id}': + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" + "/countries/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/country' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/country" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get country description: Retrieves a country. operationId: get-country @@ -284,11 +284,11 @@ paths: required: true schema: type: string - '/countries/{country_id}/states': + "/countries/{country_id}/states": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: @@ -296,17 +296,17 @@ paths: properties: states: items: - $ref: '#/components/schemas/state' + $ref: "#/components/schemas/state" oneOf: - type: string - type: array items: {} states_required: type: boolean - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: List country states operationId: list-country-states tags: @@ -318,19 +318,19 @@ paths: required: true schema: type: string - '/countries/{country_id}/states/{id}': + "/countries/{country_id}/states/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/state' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/state" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get country state operationId: get-country-state tags: @@ -347,19 +347,19 @@ paths: required: true schema: type: string - '/products/{id}': + "/products/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/product' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/product" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get product description: Retrieves a product. operationId: get-product @@ -375,18 +375,18 @@ paths: type: string delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/product' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/product" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Delete product description: Deletes a product. operationId: delete-product @@ -396,18 +396,18 @@ paths: - api-key: [] patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/product' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/product" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update product description: Updates a product. operationId: update-product @@ -422,18 +422,18 @@ paths: type: object properties: product: - $ref: '#/components/schemas/product-input' + $ref: "#/components/schemas/product-input" examples: Example: value: product: name: The Majestic Product - price: '22.22' - '/products/{product_id}/images': + price: "22.22" + "/products/{product_id}/images": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: @@ -442,11 +442,11 @@ paths: images: type: array items: - $ref: '#/components/schemas/image' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/image" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: List product images description: Retrieves a product's images. operationId: list-product-images @@ -462,18 +462,18 @@ paths: type: string post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/image' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/image" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create product image description: |- Creates an image for a product. @@ -491,35 +491,35 @@ paths: type: object properties: image: - $ref: '#/components/schemas/image-input' - '/products/{product_id}/variants': + $ref: "#/components/schemas/image-input" + "/products/{product_id}/variants": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: variants: type: array items: {} - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: List product variants description: Retrieves a product's variants. operationId: list-product-variants tags: - Variants parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] parameters: @@ -530,18 +530,18 @@ paths: type: string post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/variant' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/variant" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create product variant description: Creates a variant for a product. operationId: create-product-variant @@ -556,13 +556,13 @@ paths: type: object properties: variant: - $ref: '#/components/schemas/variant-input' + $ref: "#/components/schemas/variant-input" examples: Example with Option Value Ids: value: variant: - price: '11.22' - cost_price: '9' + price: "11.22" + cost_price: "9" position: 1 track_inventory: true sku: AWSOME-1122 @@ -573,8 +573,8 @@ paths: Example with Option Value Text: value: variant: - price: '11.22' - cost_price: '9' + price: "11.22" + cost_price: "9" position: 1 track_inventory: true sku: AWSOME-1122 @@ -582,19 +582,19 @@ paths: options: name: Color value: White - '/products/{product_id}/images/{id}': + "/products/{product_id}/images/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/image' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/image" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get product image description: Retrieves a product's image. operationId: get-product-image @@ -608,27 +608,27 @@ paths: required: true schema: type: string - description: 'The id of the Spree::Product' + description: "The id of the Spree::Product" - name: id in: path required: true schema: type: string - description: 'The id of the Spree::Image' + description: "The id of the Spree::Image" delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/image' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/image" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Delete product image description: Deletes a product's image. operationId: delete-product-image @@ -638,18 +638,18 @@ paths: - api-key: [] patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/image' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/image" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update product image description: |- Updates a product's image. @@ -667,20 +667,20 @@ paths: type: object properties: image: - $ref: '#/components/schemas/image-input' - '/products/{product_id}/variants/{id}': + $ref: "#/components/schemas/image-input" + "/products/{product_id}/variants/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/variant' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/variant" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get product variant description: |- **Deprecation Warning**: Use [shallow version](/docs/solidus/87df124706c5f-get-variant) instead @@ -704,18 +704,18 @@ paths: type: string delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/variant' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/variant" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Delete product variant description: |- **Deprecation Warning**: Use [shallow version](/docs/solidus/82ccaada99139-delete-variant) instead @@ -728,18 +728,18 @@ paths: - api-key: [] put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/variant' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/variant" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update product variant description: |- **Deprecation Warning**: Use [shallow version](/docs/solidus/ce338b5f3b940-update-variant) instead @@ -757,13 +757,13 @@ paths: type: object properties: variant: - $ref: '#/components/schemas/variant-input' + $ref: "#/components/schemas/variant-input" examples: Example with Option Value Ids: value: variant: - price: '11.22' - cost_price: '9' + price: "11.22" + cost_price: "9" position: 1 track_inventory: true sku: AWSOME-1122 @@ -774,8 +774,8 @@ paths: Example with Option Value Text: value: variant: - price: '11.22' - cost_price: '9' + price: "11.22" + cost_price: "9" position: 1 track_inventory: true sku: AWSOME-1122 @@ -786,35 +786,35 @@ paths: /states: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: type: object properties: states: - $ref: '#/components/schemas/state' - '401': - $ref: '#/components/responses/invalid-api-key' + $ref: "#/components/schemas/state" + "401": + $ref: "#/components/responses/invalid-api-key" summary: List states operationId: list-states tags: - States description: Lists all states in the system. - '/states/{id}': + "/states/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/state' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/state" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get state description: Retrieves a state. operationId: get-state @@ -829,42 +829,42 @@ paths: /variants: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: variants: - $ref: '#/components/schemas/variant' - '401': - $ref: '#/components/responses/invalid-api-key' + $ref: "#/components/schemas/variant" + "401": + $ref: "#/components/responses/invalid-api-key" summary: List variants description: List variants. operationId: list-variants tags: - Variants parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/variant' - '401': - $ref: '#/components/responses/invalid-api-key' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/variant" + "401": + $ref: "#/components/responses/invalid-api-key" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create variant description: |- **Deprecation Warning**: Use [nested version](/docs/solidus/681aa6cb75b1e-create-product-variant) instead @@ -884,14 +884,14 @@ paths: product_id: type: integer variant: - $ref: '#/components/schemas/variant-input' + $ref: "#/components/schemas/variant-input" examples: Example with Option Value Ids: value: product_id: 1 variant: - price: '11.22' - cost_price: '9' + price: "11.22" + cost_price: "9" position: 1 track_inventory: true sku: AWSOME-1122 @@ -903,8 +903,8 @@ paths: value: product_id: 1 variant: - price: '11.22' - cost_price: '9' + price: "11.22" + cost_price: "9" position: 1 track_inventory: true sku: AWSOME-1122 @@ -912,19 +912,19 @@ paths: options: name: Color value: White - '/variants/{id}': + "/variants/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/variant' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/variant" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get variant description: Retrieves a variant. operationId: get-variant @@ -940,18 +940,18 @@ paths: type: string delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/variant' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/variant" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Delete variant description: Deletes a variant. operationId: delete-variant @@ -961,18 +961,18 @@ paths: - api-key: [] patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/variant' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/variant" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update variant description: Updates a variant. operationId: update-variant @@ -987,13 +987,13 @@ paths: type: object properties: variant: - $ref: '#/components/schemas/variant-input' + $ref: "#/components/schemas/variant-input" examples: Example with Option Value Ids: value: variant: - price: '11.22' - cost_price: '9' + price: "11.22" + cost_price: "9" position: 1 track_inventory: true sku: AWSOME-1122 @@ -1004,8 +1004,8 @@ paths: Example with Option Value Text: value: variant: - price: '11.22' - cost_price: '9' + price: "11.22" + cost_price: "9" position: 1 track_inventory: true sku: AWSOME-1122 @@ -1013,11 +1013,11 @@ paths: options: name: Color value: White - '/variants/{variant_id}/images': + "/variants/{variant_id}/images": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: @@ -1026,11 +1026,11 @@ paths: images: type: array items: - $ref: '#/components/schemas/image' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/image" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: List variant images description: Lists a variant's images. operationId: list-variant-images @@ -1046,18 +1046,18 @@ paths: type: string post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/image' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/image" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create variant image description: |- Creates an image for a variant. @@ -1075,20 +1075,20 @@ paths: type: object properties: image: - $ref: '#/components/schemas/image-input' - '/variants/{variant_id}/images/{id}': + $ref: "#/components/schemas/image-input" + "/variants/{variant_id}/images/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/image' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/image" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get variant image description: Retrieves a variant's image. operationId: get-variant-image @@ -1102,27 +1102,27 @@ paths: required: true schema: type: string - description: 'The id of the Spree::Variant' + description: "The id of the Spree::Variant" - name: id in: path required: true schema: type: string - description: 'The id of the Spree::Image' + description: "The id of the Spree::Image" delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/image' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/image" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Delete variant image description: Deletes a variant's image. operationId: delete-variant-image @@ -1132,18 +1132,18 @@ paths: - api-key: [] patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/image' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/image" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update variant image description: |- Updates a variant's image. @@ -1161,12 +1161,12 @@ paths: type: object properties: image: - $ref: '#/components/schemas/image-input' - '/shipments/{shipment_number}/estimated_rates': + $ref: "#/components/schemas/image-input" + "/shipments/{shipment_number}/estimated_rates": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: @@ -1175,11 +1175,11 @@ paths: shipping_rates: type: array items: - $ref: '#/components/schemas/shipping-rate' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/shipping-rate" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: List shipment estimated rates description: Lists a shipment's estimated rates. operationId: list-shipment-estimated-rates @@ -1197,45 +1197,45 @@ paths: /shipments/mine: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: shipments: type: array items: - $ref: '#/components/schemas/shipment' - '401': - $ref: '#/components/responses/invalid-api-key' + $ref: "#/components/schemas/shipment" + "401": + $ref: "#/components/responses/invalid-api-key" summary: List user's shipments description: Lists the current user's shipments. operationId: list-user-shipments tags: - Shipments parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] - '/users/{id}': + "/users/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/user' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/user" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get user description: Retrieves a user. operationId: get-user @@ -1249,21 +1249,21 @@ paths: required: true schema: type: string - description: 'The ID of the Spree::User' + description: "The ID of the Spree::User" delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/user' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/user" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Delete user description: Deletes a user. operationId: delete-user @@ -1273,18 +1273,18 @@ paths: - api-key: [] patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/user' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/user" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update user description: |- Updates a user. @@ -1302,20 +1302,20 @@ paths: type: object properties: user: - $ref: '#/components/schemas/user-input' - '/users/{user_id}/address_book': + $ref: "#/components/schemas/user-input" + "/users/{user_id}/address_book": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/address-book' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/address-book" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get user address book operationId: get-user-address-book description: Retrieves a user's address book. @@ -1331,18 +1331,18 @@ paths: type: string delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/address-book' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/address-book" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Remove address from user address book description: |- Removes an address from a user's address book. @@ -1360,18 +1360,18 @@ paths: - api-key: [] patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/address-book' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/address-book" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update user address book operationId: update-user-address-book tags: @@ -1387,36 +1387,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/address-book-input' - '/users/{user_id}/credit_cards': + $ref: "#/components/schemas/address-book-input" + "/users/{user_id}/credit_cards": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: credit_cards: type: array items: - $ref: '#/components/schemas/credit-card' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/credit-card" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: List user credit cards description: Lists a user's credit cards. operationId: list-user-credit-cards tags: - Credit cards parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] parameters: @@ -1425,19 +1425,19 @@ paths: required: true schema: type: string - '/checkouts/{checkout_id}/addresses/{id}': + "/checkouts/{checkout_id}/addresses/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/address' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/address" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get checkout address description: Retrieves a checkout's address. operationId: get-checkout-address @@ -1460,18 +1460,18 @@ paths: type: string patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/address' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/address" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update checkout address description: Updates a checkout's address. operationId: update-checkout-address @@ -1487,7 +1487,7 @@ paths: type: object properties: address: - $ref: '#/components/schemas/address-input' + $ref: "#/components/schemas/address-input" examples: Example with state_id: value: @@ -1497,7 +1497,7 @@ paths: city: Phoenix country_id: 22 state_id: 31 - zipcode: '85022' + zipcode: "85022" phone: 509-644-9988 company: Acme Inc. Example with state_name: @@ -1508,38 +1508,38 @@ paths: city: Phoenix country_id: 22 state_name: AZ - zipcode: '85022' + zipcode: "85022" phone: 509-644-9988 company: Acme Inc. - '/checkouts/{checkout_id}/payments': + "/checkouts/{checkout_id}/payments": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: payments: type: array items: - $ref: '#/components/schemas/payment' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/payment" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: List checkout payments - description: 'Lists a checkout''s payments. The list of payments is only visible by the checkout''s owner and by users authorized to see the order, eg. users with admin role. ' + description: "Lists a checkout's payments. The list of payments is only visible by the checkout's owner and by users authorized to see the order, eg. users with admin role. " operationId: list-checkout-payments tags: - Payments parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] parameters: @@ -1551,18 +1551,18 @@ paths: type: string post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/payment' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/payment" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create checkout payment description: Creates a new payment for a checkout. Only the checkout's owner and users that can create a payment (eg. users with admin role) are allowed to perform this action. operationId: create-checkout-payment @@ -1578,17 +1578,17 @@ paths: type: object properties: payment: - $ref: '#/components/schemas/payment-input' + $ref: "#/components/schemas/payment-input" examples: Example without a payment source: value: payment: - amount: '42.42' + amount: "42.42" payment_method_id: 1 Example with a payment source: value: payment: - amount: '42.42' + amount: "42.42" payment_method_id: 1 source_attributes: gateway_payment_profile_id: super-secret-token-2131m3n13bv3hv1vasda @@ -1596,19 +1596,19 @@ paths: This requests only accepts available Payment Methods in the `payment_method_id` field. The Payment Methods available to users for creating a new payment are the ones with both attributes `available_to_users` and `active` set to `true`. - '/checkouts/{checkout_id}/payments/{id}': + "/checkouts/{checkout_id}/payments/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/payment' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/payment" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get checkout payment description: Gets a checkout's payment. operationId: get-checkout-payment @@ -1632,16 +1632,16 @@ paths: type: string patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/payment' - '401': - $ref: '#/components/responses/invalid-api-key' - '403': - description: 'Forbidden ' + $ref: "#/components/schemas/payment" + "401": + $ref: "#/components/responses/invalid-api-key" + "403": + description: "Forbidden " content: application/json: schema: @@ -1649,12 +1649,12 @@ paths: properties: error: type: string - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update checkout payment - description: 'Updates a checkout''s payment. Please note that this action can be done by users with the admin permissions on Payments (eg. users with the admin role). Only pending payment can be updated. ' + description: "Updates a checkout's payment. Please note that this action can be done by users with the admin permissions on Payments (eg. users with the admin role). Only pending payment can be updated. " operationId: update-checkout-payment tags: - Payments @@ -1668,41 +1668,41 @@ paths: type: object properties: payment: - $ref: '#/components/schemas/payment-input' + $ref: "#/components/schemas/payment-input" examples: Example: value: payment: - amount: '12.10' - '/checkouts/{checkout_id}/return_authorizations': + amount: "12.10" + "/checkouts/{checkout_id}/return_authorizations": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: return_authorizations: type: array items: - $ref: '#/components/schemas/return-authorization' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/return-authorization" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: List checkout return authorizations description: Lists a checkout's return authorizations. operationId: list-checkout-return-authorization tags: - Return authorizations parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] parameters: @@ -1714,18 +1714,18 @@ paths: type: string post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/return-authorization' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/return-authorization" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create checkout return authorization description: |- Creates a return authorization for a checkout. @@ -1743,19 +1743,19 @@ paths: type: object properties: return_authorization: - $ref: '#/components/schemas/return-authorization-input' - '/checkouts/{checkout_id}/return_authorizations/{id}': + $ref: "#/components/schemas/return-authorization-input" + "/checkouts/{checkout_id}/return_authorizations/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: {} - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get checkout return authorization description: Gets a checkout's return authorization. operationId: get-checkout-return-authorization @@ -1775,21 +1775,21 @@ paths: required: true schema: type: string - description: 'The ID of the Spree::ReturnAuthorization' + description: "The ID of the Spree::ReturnAuthorization" delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/return-authorization' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/return-authorization" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Delete checkout return authorization description: Deletes a checkout's return authorization. operationId: delete-checkout-return-authorization @@ -1799,18 +1799,18 @@ paths: - api-key: [] patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/return-authorization' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/return-authorization" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update checkout return authorization description: |- Updates a checkout's return authorization. @@ -1828,19 +1828,19 @@ paths: type: object properties: return_authorization: - $ref: '#/components/schemas/return-authorization-input' - '/orders/{order_id}/customer_returns/{id}': + $ref: "#/components/schemas/return-authorization-input" + "/orders/{order_id}/customer_returns/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: {} - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get order customer return description: Gets an orders customer return. operationId: get-order-customer-return @@ -1863,18 +1863,18 @@ paths: type: string put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/customer-return' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/customer-return" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update order customer return description: |- Updates an orders customer return. @@ -1890,50 +1890,50 @@ paths: type: object properties: customer_return: - $ref: '#/components/schemas/customer-return-input' + $ref: "#/components/schemas/customer-return-input" security: - api-key: [] /orders: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: orders: type: array items: - $ref: '#/components/schemas/order-small' - '401': - $ref: '#/components/responses/invalid-api-key' + $ref: "#/components/schemas/order-small" + "401": + $ref: "#/components/responses/invalid-api-key" summary: List orders description: Lists all orders. operationId: list-orders tags: - Orders parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/order-big' - '401': - $ref: '#/components/responses/invalid-api-key' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/order-big" + "401": + $ref: "#/components/responses/invalid-api-key" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create order description: Creates a new order. operationId: create-order @@ -1948,7 +1948,7 @@ paths: type: object properties: order: - $ref: '#/components/schemas/order-input' + $ref: "#/components/schemas/order-input" examples: Example: value: @@ -1957,19 +1957,19 @@ paths: line_items_attributes: - quantity: 1 variant_id: 22 - '/orders/{order_number}/addresses/{id}': + "/orders/{order_number}/addresses/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/address' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/address" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get order address description: Retrieves an order's address. operationId: get-order-address @@ -1993,18 +1993,18 @@ paths: type: string patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/address' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/address" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update order address description: Updates an order's address. operationId: update-order-address @@ -2020,7 +2020,7 @@ paths: type: object properties: address: - $ref: '#/components/schemas/address-input' + $ref: "#/components/schemas/address-input" examples: Example with state_id: value: @@ -2030,7 +2030,7 @@ paths: city: Phoenix country_id: 22 state_id: 31 - zipcode: '85022' + zipcode: "85022" phone: 509-644-9988 company: Acme Inc. Example with state_name: @@ -2041,41 +2041,41 @@ paths: city: Phoenix country_id: 22 state_name: AZ - zipcode: '85022' + zipcode: "85022" phone: 509-644-9988 company: Acme Inc. - '/orders/{order_number}/payments': + "/orders/{order_number}/payments": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: payments: items: - $ref: '#/components/schemas/payment' + $ref: "#/components/schemas/payment" oneOf: - type: string - type: array items: {} - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: List order payments description: Lists an order's payments. operationId: list-order-payments tags: - Payments parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] - order-token: [] @@ -2088,18 +2088,18 @@ paths: type: string post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/payment' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/payment" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create order payment description: Creates a new payment for a checkout. Only the order's owner and users that can create a payment (eg. users with admin role) are allowed to perform this action. operationId: create-order-payment @@ -2115,17 +2115,17 @@ paths: type: object properties: payment: - $ref: '#/components/schemas/payment-input' + $ref: "#/components/schemas/payment-input" examples: Example without a payment source: value: payment: - amount: '42.42' + amount: "42.42" payment_method_id: 1 Example with a payment source: value: payment: - amount: '42.42' + amount: "42.42" payment_method_id: 1 source_attributes: gateway_payment_profile_id: super-secret-token-2131m3n13bv3hv1vasda @@ -2133,18 +2133,18 @@ paths: This requests only accepts available Payment Methods in the `payment_method_id` field. The Payment Methods available to users for creating a new payment are the ones with both attributes `available_to_users` and `active` set to `true`. - '/orders/{order_number}/payments/{id}': + "/orders/{order_number}/payments/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: {} - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get order payment description: Retrieves an orer's payment. operationId: get-order-payment @@ -2166,15 +2166,15 @@ paths: type: string patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/payment' - '401': - $ref: '#/components/responses/invalid-api-key' - '403': + $ref: "#/components/schemas/payment" + "401": + $ref: "#/components/responses/invalid-api-key" + "403": description: Forbidden content: application/json: @@ -2183,12 +2183,12 @@ paths: properties: error: type: string - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update order payment - description: 'Updates a checkout''s payment. Please note that this action can be done by users with the admin permissions on Payments (eg. users with the admin role). Only pending payment can be updated. ' + description: "Updates a checkout's payment. Please note that this action can be done by users with the admin permissions on Payments (eg. users with the admin role). Only pending payment can be updated. " operationId: update-order-payment tags: - Payments @@ -2202,41 +2202,41 @@ paths: type: object properties: payment: - $ref: '#/components/schemas/payment-input' + $ref: "#/components/schemas/payment-input" examples: Example: value: payment: - amount: '12.10' - '/orders/{order_number}/return_authorizations': + amount: "12.10" + "/orders/{order_number}/return_authorizations": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: return_authorizations: type: array items: - $ref: '#/components/schemas/return-authorization' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/return-authorization" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: List order return authorizations description: Lists an order's return authorizations. operationId: list-order-return-authorizations tags: - Return authorizations parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] parameters: @@ -2247,18 +2247,18 @@ paths: type: string post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/return-authorization' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/return-authorization" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create order return authorization description: |- Creates a return authorization for an order. @@ -2276,20 +2276,20 @@ paths: type: object properties: return_authorization: - $ref: '#/components/schemas/return-authorization-input' - '/orders/{order_number}/return_authorizations/{id}': + $ref: "#/components/schemas/return-authorization-input" + "/orders/{order_number}/return_authorizations/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/return-authorization' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/return-authorization" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get order return authorization description: Retrieves an order's return authorization. operationId: get-order-return-authorization @@ -2309,21 +2309,21 @@ paths: required: true schema: type: string - description: 'The ID of the Spree::ReturnAuthorization' + description: "The ID of the Spree::ReturnAuthorization" delete: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/return-authorization' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/return-authorization" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Delete order return authorization description: Deletes an order's return authorization. operationId: delete-order-return-authorization @@ -2333,18 +2333,18 @@ paths: - api-key: [] patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/return-authorization' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/return-authorization" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update order return authorization description: |- Updates an order's return authorization. @@ -2362,12 +2362,12 @@ paths: type: object properties: return_authorization: - $ref: '#/components/schemas/return-authorization-input' + $ref: "#/components/schemas/return-authorization-input" /config: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: @@ -2375,8 +2375,8 @@ paths: properties: default_country_iso: type: string - '401': - $ref: '#/components/responses/invalid-api-key' + "401": + $ref: "#/components/responses/invalid-api-key" summary: Get system configuration description: Retrieves the system's configuration. operationId: get-config @@ -2387,8 +2387,8 @@ paths: /config/money: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: @@ -2396,8 +2396,8 @@ paths: properties: symbol: type: string - '401': - $ref: '#/components/responses/invalid-api-key' + "401": + $ref: "#/components/responses/invalid-api-key" summary: Get money configuration description: Gets the system's money configuration. operationId: get-money-config @@ -2408,16 +2408,16 @@ paths: /option_types: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: type: array items: - $ref: '#/components/schemas/option-type' - '401': - $ref: '#/components/responses/invalid-api-key' + $ref: "#/components/schemas/option-type" + "401": + $ref: "#/components/responses/invalid-api-key" summary: List option types description: Lists the system's option types. operationId: list-option-types @@ -2427,16 +2427,16 @@ paths: - api-key: [] post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/option-type' - '401': - $ref: '#/components/responses/invalid-api-key' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/option-type" + "401": + $ref: "#/components/responses/invalid-api-key" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create option type description: Creates an option type. operationId: create-option-type @@ -2448,20 +2448,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/option-type-input' - '/option_types/{id}': + $ref: "#/components/schemas/option-type-input" + "/option_types/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/option-type' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/option-type" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get option type description: Retrieve an option type. operationId: get-option-type @@ -2477,18 +2477,18 @@ paths: type: string post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/option-type' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/option-type" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Delete option type description: Deletes an option type. operationId: delete-option-type @@ -2498,18 +2498,18 @@ paths: - api-key: [] patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/option-type' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/option-type" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update option type description: Updates an option type. operationId: update-option-type @@ -2521,20 +2521,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/option-type' + $ref: "#/components/schemas/option-type" /option_values: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: type: array items: - $ref: '#/components/schemas/option-value' - '401': - $ref: '#/components/responses/invalid-api-key' + $ref: "#/components/schemas/option-value" + "401": + $ref: "#/components/responses/invalid-api-key" summary: List option values description: Lists the system's option values. operationId: list-option-values @@ -2544,16 +2544,16 @@ paths: - api-key: [] post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/option-value' - '401': - $ref: '#/components/responses/invalid-api-key' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/option-value" + "401": + $ref: "#/components/responses/invalid-api-key" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create option value description: |- **Deprecation Warning**: Use [nested version](/docs/solidus/810154673c613-create-option-type-value) instead @@ -2573,20 +2573,20 @@ paths: type: object properties: option_value: - $ref: '#/components/schemas/option-value-input' - '/option_values/{id}': + $ref: "#/components/schemas/option-value-input" + "/option_values/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/option-value' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/option-value" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get option value description: Retrieves an option value. operationId: get-option-value @@ -2600,21 +2600,21 @@ paths: required: true schema: type: string - description: 'The ID of the Spree::OptionValue' + description: "The ID of the Spree::OptionValue" delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/option-value' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/option-value" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" description: Deletes an option value. summary: Delete option value operationId: delete-option-value @@ -2624,18 +2624,18 @@ paths: - api-key: [] patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/option-value' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/option-value" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update option value description: |- Updates an option value. @@ -2653,23 +2653,23 @@ paths: type: object properties: option_value: - $ref: '#/components/schemas/option-value-input' - description: '' - '/option_types/{option_type_id}/option_values': + $ref: "#/components/schemas/option-value-input" + description: "" + "/option_types/{option_type_id}/option_values": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: type: array items: - $ref: '#/components/schemas/option-value' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/option-value" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: List option type values description: Retrieves an option type's option values. operationId: list-option-type-values @@ -2683,21 +2683,21 @@ paths: required: true schema: type: string - description: 'The ID of the Spree::OptionType' + description: "The ID of the Spree::OptionType" post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/option-value' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/option-value" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create option type value description: |- Creates an option value for a type. @@ -2715,19 +2715,19 @@ paths: type: object properties: option_value: - $ref: '#/components/schemas/option-value-input' - '/option_types/{option_type_id}/option_values/{id}': + $ref: "#/components/schemas/option-value-input" + "/option_types/{option_type_id}/option_values/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: {} - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get option type value description: |- **Deprecation Warning**: Use [shallow version](/docs/solidus/cbbc403ed08a3-get-option-value) instead @@ -2744,7 +2744,7 @@ paths: required: true schema: type: string - description: 'The ID of the Spree::OptionType' + description: "The ID of the Spree::OptionType" - name: id in: path required: true @@ -2753,18 +2753,18 @@ paths: description: The ID of the OptionValue delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/option-value' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/option-value" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Delete option type value description: |- **Deprecation Warning**: Use [shallow version](/docs/solidus/0742e63219b1f-delete-option-value) instead @@ -2777,18 +2777,18 @@ paths: - api-key: [] patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/option-value' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/option-value" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update option type value description: |- **Deprecation Warning**: Use [shallow version](/docs/solidus/b43f889175ebb-update-option-value) instead @@ -2808,36 +2808,36 @@ paths: type: object properties: option_value: - $ref: '#/components/schemas/option-value-input' - '/products/{product_id}/product_properties': + $ref: "#/components/schemas/option-value-input" + "/products/{product_id}/product_properties": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: product_properties: type: array items: - $ref: '#/components/schemas/product-property' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/product-property" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: List product properties description: Lists a product's properties. operationId: list-product-properties tags: - Product properties parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] parameters: @@ -2848,18 +2848,18 @@ paths: type: string post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/product-property' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/product-property" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create product property description: |- Creates a product property. @@ -2877,26 +2877,26 @@ paths: type: object properties: product_property: - $ref: '#/components/schemas/product-property-input' + $ref: "#/components/schemas/product-property-input" examples: Example: value: product_property: property_name: Fit value: Loose - '/products/{product_id}/product_properties/{id}': + "/products/{product_id}/product_properties/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/product-property' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/product-property" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get product property description: Retrieves a product's property. operationId: get-product-property @@ -2917,18 +2917,18 @@ paths: type: string delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/product-property' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/product-property" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Delete product property description: Deletes a product's property. operationId: delete-product-property @@ -2938,18 +2938,18 @@ paths: - api-key: [] patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/product-property' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/product-property" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update product property description: |- Updates a product's property. @@ -2967,7 +2967,7 @@ paths: type: object properties: product_property: - $ref: '#/components/schemas/product-property-input' + $ref: "#/components/schemas/product-property-input" examples: Example: value: @@ -2976,44 +2976,44 @@ paths: /properties: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: properties: type: array items: - $ref: '#/components/schemas/property' - '401': - $ref: '#/components/responses/invalid-api-key' + $ref: "#/components/schemas/property" + "401": + $ref: "#/components/responses/invalid-api-key" summary: List properties description: Lists the defined properties. operationId: list-properties tags: - Properties parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/property' - '401': - $ref: '#/components/responses/invalid-api-key' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/property" + "401": + $ref: "#/components/responses/invalid-api-key" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create property description: |- Creates a property. @@ -3031,20 +3031,20 @@ paths: type: object properties: property: - $ref: '#/components/schemas/property-input' - '/properties/{id}': + $ref: "#/components/schemas/property-input" + "/properties/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/property' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/property" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get property description: Retrieves a property. operationId: get-property @@ -3058,21 +3058,21 @@ paths: required: true schema: type: string - description: 'The id of the Spree::Property' + description: "The id of the Spree::Property" delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/property' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/property" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Delete property description: Deletes a property. operationId: delete-property @@ -3082,18 +3082,18 @@ paths: - api-key: [] patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/property' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/property" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update property description: |- Updates a property. @@ -3111,19 +3111,19 @@ paths: type: object properties: property: - $ref: '#/components/schemas/property-input' - '/inventory_units/{id}': + $ref: "#/components/schemas/property-input" + "/inventory_units/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: {} - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get inventory unit description: Retrieves an inventory unit. operationId: get-inventory-unit @@ -3139,18 +3139,18 @@ paths: type: string patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/inventory-unit' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/inventory-unit" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update inventory unit description: Updates an inventory unit. operationId: update-inventory-unit @@ -3162,48 +3162,48 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inventory-unit-input' + $ref: "#/components/schemas/inventory-unit-input" /stock_locations: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: stock_locations: type: array items: - $ref: '#/components/schemas/stock-location' - '401': - $ref: '#/components/responses/invalid-api-key' + $ref: "#/components/schemas/stock-location" + "401": + $ref: "#/components/responses/invalid-api-key" summary: List stock location description: Lists the stock locations. operationId: list-stock-locations tags: - Stock locations parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/stock-location' - '401': - $ref: '#/components/responses/invalid-api-key' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/stock-location" + "401": + $ref: "#/components/responses/invalid-api-key" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create stock location description: |- Creates a stock location. @@ -3221,25 +3221,25 @@ paths: type: object properties: stock_location: - $ref: '#/components/schemas/stock-location-input' + $ref: "#/components/schemas/stock-location-input" examples: Example: value: stock_location: name: North Pole active: true - '/stock_locations/{id}': + "/stock_locations/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: {} - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get stock location description: Get a stock location. operationId: get-stock-location @@ -3256,18 +3256,18 @@ paths: description: The id of the stock location delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/stock-location' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/stock-location" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Delete stock location description: Deletes a stock location. operationId: delete-stock-location @@ -3277,18 +3277,18 @@ paths: - api-key: [] patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/stock-location' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/stock-location" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update stock location description: |- Updates a stock location. @@ -3306,41 +3306,41 @@ paths: type: object properties: stock_location: - $ref: '#/components/schemas/stock-location-input' + $ref: "#/components/schemas/stock-location-input" examples: Example: value: stock_location: active: false - '/stock_locations/{stock_location_id}/stock_items': + "/stock_locations/{stock_location_id}/stock_items": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: stock_items: type: array items: - $ref: '#/components/schemas/stock-item' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/stock-item" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: List stock location items description: Lists a stock location's items. operationId: list-stock-location-items tags: - Stock items parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] parameters: @@ -3351,18 +3351,18 @@ paths: type: string post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/stock-item' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/stock-item" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create stock location item description: |- Creates a stock item for a stock location. @@ -3380,19 +3380,19 @@ paths: type: object properties: stock_item: - $ref: '#/components/schemas/stock-item-input' - '/stock_locations/{stock_location_id}/stock_items/{id}': + $ref: "#/components/schemas/stock-item-input" + "/stock_locations/{stock_location_id}/stock_items/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: {} - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get stock location item description: Retrieves a stock location's item. operationId: get-stock-location-item @@ -3406,27 +3406,27 @@ paths: required: true schema: type: string - description: 'The ID of the Spree::StockLocation' + description: "The ID of the Spree::StockLocation" - name: id in: path required: true schema: type: string - description: 'The ID of the Spree::StockItem' + description: "The ID of the Spree::StockItem" delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/stock-item' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/stock-item" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Delete stock location item description: Deletes a stock location's item. operationId: delete-stock-location-item @@ -3436,18 +3436,18 @@ paths: - api-key: [] patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/stock-item' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/stock-item" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update stock location item description: |- Updates a stock location's item. @@ -3465,34 +3465,34 @@ paths: type: object properties: stock_item: - $ref: '#/components/schemas/stock-item-input' - '/stock_locations/{stock_location_id}/stock_movements': + $ref: "#/components/schemas/stock-item-input" + "/stock_locations/{stock_location_id}/stock_movements": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: stock_movements: - $ref: '#/components/schemas/stock-movement' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/stock-movement" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: List stock location movements description: Lists a stock location's movements. operationId: list-stock-location-movements tags: - Stock movements parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] parameters: @@ -3503,18 +3503,18 @@ paths: type: string post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/stock-movement' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/stock-movement" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create stock location movement description: Creates a stock movement for a stock location. operationId: create-stock-location-movement @@ -3526,19 +3526,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/stock-movement-input' - '/stock_locations/{stock_location_id}/stock_movements/{id}': + $ref: "#/components/schemas/stock-movement-input" + "/stock_locations/{stock_location_id}/stock_movements/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: {} - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get stock location movement description: Retrieves a stock location's movement. operationId: get-stock-location-movement @@ -3560,8 +3560,8 @@ paths: /stores: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: @@ -3570,31 +3570,31 @@ paths: stores: type: array items: - $ref: '#/components/schemas/store' - '401': - $ref: '#/components/responses/invalid-api-key' + $ref: "#/components/schemas/store" + "401": + $ref: "#/components/responses/invalid-api-key" summary: List stores description: Lists all stores in the system. operationId: list-stores tags: - Stores parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" security: - api-key: [] post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/store' - '401': - $ref: '#/components/responses/invalid-api-key' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/store" + "401": + $ref: "#/components/responses/invalid-api-key" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create store description: Creates a store. operationId: create-store @@ -3611,19 +3611,19 @@ paths: properties: code: type: string - - $ref: '#/components/schemas/store-input' - '/stores/{id}': + - $ref: "#/components/schemas/store-input" + "/stores/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: {} - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get store description: Retrieves a store. operationId: get-store @@ -3639,18 +3639,18 @@ paths: type: string delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/store' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/store" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Delete store description: Deletes a store. operationId: delete-store @@ -3660,18 +3660,18 @@ paths: - api-key: [] patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/store' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/store" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update store description: Updates a store. operationId: update-store @@ -3683,48 +3683,48 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/store-input' + $ref: "#/components/schemas/store-input" /taxonomies: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: taxonomies: type: array items: - $ref: '#/components/schemas/taxonomy' - '401': - $ref: '#/components/responses/invalid-api-key' + $ref: "#/components/schemas/taxonomy" + "401": + $ref: "#/components/responses/invalid-api-key" summary: List taxonomies description: Lists the taxonomies. operationId: list-taxonomies tags: - Taxonomies parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/taxonomy' - '401': - $ref: '#/components/responses/invalid-api-key' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/taxonomy" + "401": + $ref: "#/components/responses/invalid-api-key" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create taxonomy description: |- Creates a taxonomy. @@ -3744,24 +3744,24 @@ paths: type: object properties: taxonomy: - $ref: '#/components/schemas/taxonomy-input' + $ref: "#/components/schemas/taxonomy-input" examples: Example: value: taxonomy: name: Colors - '/taxonomies/{id}': + "/taxonomies/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: {} - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get taxonomy description: Retrieves a taxonomy. operationId: get-taxonomy @@ -3785,18 +3785,18 @@ paths: description: The id of the taxonomy delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/taxonomy' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/taxonomy" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Delete taxonomy description: Deletes a taxonomy. operationId: delete-taxonomy @@ -3806,18 +3806,18 @@ paths: - api-key: [] patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/taxonomy' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/taxonomy" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update taxonomy description: |- Updates a taxonomy. @@ -3835,41 +3835,41 @@ paths: type: object properties: taxonomy: - $ref: '#/components/schemas/taxonomy-input' + $ref: "#/components/schemas/taxonomy-input" examples: Example: value: taxonomy: name: Colours - '/taxonomies/{taxonomy_id}/taxons': + "/taxonomies/{taxonomy_id}/taxons": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: taxons: type: array items: - $ref: '#/components/schemas/taxon' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/taxon" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: List taxonomy taxons description: Lists a taxonomy's taxons. operationId: list-taxonomy-taxons tags: - Taxons parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] parameters: @@ -3881,18 +3881,18 @@ paths: description: The id of the taxonomy for which the new taxon will be added post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/taxon' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/taxon" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create taxonomy taxon description: |- Creates a taxon for a taxonomy. @@ -3910,25 +3910,25 @@ paths: type: object properties: taxon: - $ref: '#/components/schemas/taxon-input' + $ref: "#/components/schemas/taxon-input" examples: Example: value: taxon: name: Colors parent_id: 22 - '/taxonomies/{taxonomy_id}/taxons/{id}': + "/taxonomies/{taxonomy_id}/taxons/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: {} - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get taxonomy taxon description: Retrieves a taxonomy's taxon. operationId: get-taxonomy-taxon @@ -3951,18 +3951,18 @@ paths: description: The id of the taxon delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/taxon' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/taxon" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Delete taxonomy taxon description: Deletes a taxonomy's taxon. operationId: delete-taxonomy-taxon @@ -3972,18 +3972,18 @@ paths: - api-key: [] patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/taxon' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/taxon" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update taxonomy taxon description: |- Updates a taxonomy's taxon. @@ -4001,7 +4001,7 @@ paths: type: object properties: taxon: - $ref: '#/components/schemas/taxon-input' + $ref: "#/components/schemas/taxon-input" examples: Example: value: @@ -4010,77 +4010,77 @@ paths: /taxons: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: taxons: type: array items: - $ref: '#/components/schemas/taxon' - '401': - $ref: '#/components/responses/invalid-api-key' + $ref: "#/components/schemas/taxon" + "401": + $ref: "#/components/responses/invalid-api-key" summary: List taxons description: Lists all taxons. operationId: list-taxons tags: - Taxons parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" - schema: type: boolean in: query name: without_children - description: 'When set to `true`, it won''t recursively return all the taxons'' children.' + description: "When set to `true`, it won't recursively return all the taxons' children." security: - api-key: [] /users: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: users: type: array items: {} - '401': - $ref: '#/components/responses/invalid-api-key' + "401": + $ref: "#/components/responses/invalid-api-key" summary: List users description: Lists all users. operationId: list-users tags: - Users parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/user' - '401': - $ref: '#/components/responses/invalid-api-key' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/user" + "401": + $ref: "#/components/responses/invalid-api-key" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create user description: | Creates a user. @@ -4098,49 +4098,49 @@ paths: type: object properties: user: - $ref: '#/components/schemas/user-input' - description: '' + $ref: "#/components/schemas/user-input" + description: "" /zones: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: zones: type: array items: - $ref: '#/components/schemas/zone' - '401': - $ref: '#/components/responses/invalid-api-key' + $ref: "#/components/schemas/zone" + "401": + $ref: "#/components/responses/invalid-api-key" summary: List zones description: Lists all zones. operationId: list-zones tags: - Zones parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/zone' - '401': - $ref: '#/components/responses/invalid-api-key' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/zone" + "401": + $ref: "#/components/responses/invalid-api-key" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create zone description: |- Creates a zone. @@ -4158,7 +4158,7 @@ paths: type: object properties: zone: - $ref: '#/components/schemas/zone-input' + $ref: "#/components/schemas/zone-input" examples: Example: value: @@ -4166,21 +4166,21 @@ paths: name: North Pole description: The coldest one. zone_members_attributes: - - zoneable_type: 'Spree::Country' + - zoneable_type: "Spree::Country" zoneable_id: 1 - '/zones/{id}': + "/zones/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/zone' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/zone" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get zone description: Retrieves a zone. operationId: get-zone @@ -4197,18 +4197,18 @@ paths: description: The ID of the zone we want to update delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/zone' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/zone" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Delete zone description: Deletes a zone. operationId: delete-zone @@ -4218,18 +4218,18 @@ paths: - api-key: [] patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/zone' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/zone" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update zone description: |- Updates a zone. @@ -4247,25 +4247,25 @@ paths: type: object properties: zone: - $ref: '#/components/schemas/zone-input' + $ref: "#/components/schemas/zone-input" examples: Example: value: zone: description: Brrr. The coldest one. - '/promotions/{id}': + "/promotions/{id}": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/promotion' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/promotion" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Get promotion description: Retrieves a promotion. operationId: get-promotion @@ -4282,50 +4282,50 @@ paths: /store_credit_events/mine: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: store_credit_events: type: array items: - $ref: '#/components/schemas/store-credit-event' - '401': - $ref: '#/components/responses/invalid-api-key' + $ref: "#/components/schemas/store-credit-event" + "401": + $ref: "#/components/responses/invalid-api-key" summary: List current user's store credit events description: Lists the current user's store credit events. operationId: list-current-user-store-credit-events tags: - Store credit events parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" security: - api-key: [] - '/orders/{order_number}/coupon_codes/{id}': + "/orders/{order_number}/coupon_codes/{id}": delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/coupon-code-handler' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': + $ref: "#/components/schemas/coupon-code-handler" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": description: Unprocessable Entity (WebDAV) content: application/json: schema: - $ref: '#/components/schemas/coupon-code-handler' + $ref: "#/components/schemas/coupon-code-handler" summary: Delete order coupon code description: |- Deletes an order's coupon code. @@ -4350,21 +4350,21 @@ paths: description: This is the coupon code schema: type: string - '/orders/{order_number}/line_items': + "/orders/{order_number}/line_items": post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/line-item' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/line-item" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create order line item description: |- Create a line item in an order not yet completed. @@ -4383,35 +4383,35 @@ paths: type: object properties: line_item: - $ref: '#/components/schemas/line-item-input' + $ref: "#/components/schemas/line-item-input" examples: Example: value: line_item: quantity: 1 variant_id: 22 - description: '' + description: "" parameters: - name: order_number in: path required: true schema: type: string - '/orders/{order_number}/line_items/{id}': + "/orders/{order_number}/line_items/{id}": delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/line-item' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/line-item" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Delete order line item description: Deletes an order's line item. operationId: delete-order-line-item @@ -4435,18 +4435,18 @@ paths: description: The id of the line item to update patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/line-item' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/line-item" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update order line item description: |- Update line item's information in an order not yet completed. @@ -4465,27 +4465,27 @@ paths: type: object properties: line_item: - $ref: '#/components/schemas/line-item-input' + $ref: "#/components/schemas/line-item-input" examples: example-1: value: line_item: quantity: 1 - '/stock_items/{id}': + "/stock_items/{id}": delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/stock-item' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/stock-item" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Delete stock item description: Deletes a stock item. operationId: delete-stock-item @@ -4499,21 +4499,21 @@ paths: required: true schema: type: string - description: 'The ID of the Stock::Item' + description: "The ID of the Stock::Item" patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/stock-item' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/stock-item" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update stock item description: |- Updates a stock item. @@ -4531,22 +4531,22 @@ paths: type: object properties: stock_item: - $ref: '#/components/schemas/stock-item-input' - '/checkouts/{id}': + $ref: "#/components/schemas/stock-item-input" + "/checkouts/{id}": patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/order-big' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/order-big" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update checkout description: |- Updates a checkout and moves the order to the next checkout step. A request with an empty body is legit and only tries to move the order to the next step. @@ -4567,7 +4567,7 @@ paths: type: object properties: order: - $ref: '#/components/schemas/order-input' + $ref: "#/components/schemas/order-input" parameters: - name: id in: path @@ -4575,21 +4575,21 @@ paths: schema: type: string description: The order number - '/credit_cards/{id}': + "/credit_cards/{id}": patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/credit-card' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/credit-card" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update credit card description: Updates a credit card. operationId: update-credit-card @@ -4601,28 +4601,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/credit-card-update-input' + $ref: "#/components/schemas/credit-card-update-input" parameters: - name: id in: path required: true schema: type: string - '/shipments/{number}': + "/shipments/{number}": patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/shipment' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/shipment" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update shipment description: |- Updates a shipment. @@ -4640,7 +4640,7 @@ paths: type: object properties: shipment: - $ref: '#/components/schemas/shipment-input' + $ref: "#/components/schemas/shipment-input" examples: Example: value: @@ -4652,21 +4652,21 @@ paths: required: true schema: type: string - '/checkouts/{checkout_id}/payments/{payment_id}/authorize': + "/checkouts/{checkout_id}/payments/{payment_id}/authorize": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/payment' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/payment" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Authorize checkout payment description: Authorizes a checkout's payment. operationId: authorize-checkout-payment @@ -4686,21 +4686,21 @@ paths: required: true schema: type: string - '/checkouts/{checkout_id}/payments/{payment_id}/capture': + "/checkouts/{checkout_id}/payments/{payment_id}/capture": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/payment' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/payment" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Capture checkout payment description: Captures a checkout's payment. operationId: capture-checkout-payment @@ -4720,21 +4720,21 @@ paths: required: true schema: type: string - '/checkouts/{checkout_id}/payments/{payment_id}/credit': + "/checkouts/{checkout_id}/payments/{payment_id}/credit": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/payment' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/payment" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Credit checkout payment description: Credits a checkout's payment. operationId: credit-checkout-payment @@ -4754,21 +4754,21 @@ paths: required: true schema: type: string - '/checkouts/{checkout_id}/payments/{payment_id}/purchase': + "/checkouts/{checkout_id}/payments/{payment_id}/purchase": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/payment' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/payment" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Purchase checkout payment description: Purchases a checkout's payment. operationId: purchase-checkout-payment @@ -4788,21 +4788,21 @@ paths: required: true schema: type: string - '/checkouts/{checkout_id}/payments/{payment_id}/void': + "/checkouts/{checkout_id}/payments/{payment_id}/void": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/payment' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/payment" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Void checkout payment description: Voids a checkout's payment. operationId: void-checkout-payment @@ -4822,21 +4822,21 @@ paths: required: true schema: type: string - '/checkouts/{checkout_id}/return_authorizations/{return_authorization_id}/cancel': + "/checkouts/{checkout_id}/return_authorizations/{return_authorization_id}/cancel": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/return-authorization' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/return-authorization" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Cancel checkout return authorization description: Cancels a checkout's return authorization. operationId: cancel-checkout-return-authorization @@ -4856,21 +4856,21 @@ paths: required: true schema: type: string - '/checkouts/{checkout_id}/advance': + "/checkouts/{checkout_id}/advance": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/order-big' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/order-big" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Advance checkout description: Advances a checkout to the furthest possible state. operationId: advance-checkout @@ -4886,21 +4886,21 @@ paths: description: The order number schema: type: string - '/checkouts/{checkout_id}/complete': + "/checkouts/{checkout_id}/complete": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/order-big' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/order-big" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Complete checkout description: Completes a checkout. operationId: complete-checkout @@ -4910,7 +4910,7 @@ paths: - api-key: [] - order-token: [] requestBody: - $ref: '#/components/requestBodies/complete-checkoutBody' + $ref: "#/components/requestBodies/complete-checkoutBody" parameters: - name: checkout_id in: path @@ -4918,21 +4918,21 @@ paths: description: The order number schema: type: string - '/checkouts/{checkout_id}/next': + "/checkouts/{checkout_id}/next": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/order-big' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/order-big" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Transition checkout description: Transitions a checkout to the next state. operationId: transition-checkout @@ -4942,7 +4942,7 @@ paths: - api-key: [] - order-token: [] requestBody: - $ref: '#/components/requestBodies/complete-checkoutBody' + $ref: "#/components/requestBodies/complete-checkoutBody" parameters: - name: checkout_id in: path @@ -4950,21 +4950,21 @@ paths: description: The order number schema: type: string - '/checkouts/{checkout_id}/line_items': + "/checkouts/{checkout_id}/line_items": post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/line-item' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/line-item" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create checkout line item description: |- Create a line item in an checkout not yet completed. @@ -4985,7 +4985,7 @@ paths: type: object properties: line_item: - $ref: '#/components/schemas/line-item-input' + $ref: "#/components/schemas/line-item-input" examples: Example: value: @@ -4999,21 +4999,21 @@ paths: description: The order number schema: type: string - '/checkouts/{checkout_id}/line_items/{id}': + "/checkouts/{checkout_id}/line_items/{id}": delete: responses: - '204': - description: '' + "204": + description: "" content: application/json: schema: - $ref: '#/components/schemas/line-item' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/delete-restriction' + $ref: "#/components/schemas/line-item" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/delete-restriction" summary: Delete checkout line item description: Deletes a checkout's line item. operationId: delete-checkout-line-item @@ -5037,18 +5037,18 @@ paths: description: The id of the line item to update patch: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/line-item' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/line-item" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update checkout line item description: |- Update line item's information in an checkout not yet completed. @@ -5069,7 +5069,7 @@ paths: type: object properties: line_item: - $ref: '#/components/schemas/line-item-input' + $ref: "#/components/schemas/line-item-input" examples: Example: value: @@ -5078,17 +5078,17 @@ paths: /classifications: put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: type: object properties: {} - '401': - $ref: '#/components/responses/invalid-api-key' - '422': - $ref: '#/components/responses/unprocessable-entity' + "401": + $ref: "#/components/responses/invalid-api-key" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Update classification description: |- Updates a classification. @@ -5111,21 +5111,21 @@ paths: type: integer position: type: integer - '/orders/{order_number}/cancel': + "/orders/{order_number}/cancel": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/order-big' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/order-big" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Cancel order description: Cancels an order. operationId: cancel-order @@ -5140,21 +5140,21 @@ paths: required: true schema: type: string - '/orders/{order_number}/empty': + "/orders/{order_number}/empty": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/order-big' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/order-big" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Empty order description: Empties an order's cart. operationId: empty-order @@ -5169,21 +5169,21 @@ paths: required: true schema: type: string - '/orders/{order_number}/payments/{payment_id}/authorize': + "/orders/{order_number}/payments/{payment_id}/authorize": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/payment' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/payment" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Authorize order payment description: Authorizes an order's payment. operationId: authorize-order-payment @@ -5202,21 +5202,21 @@ paths: required: true schema: type: string - '/orders/{order_number}/payments/{payment_id}/capture': + "/orders/{order_number}/payments/{payment_id}/capture": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/payment' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/payment" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Capture order payment description: Captures an order's payment. operationId: capture-order-payment @@ -5235,21 +5235,21 @@ paths: required: true schema: type: string - '/orders/{order_number}/payments/{payment_id}/credit': + "/orders/{order_number}/payments/{payment_id}/credit": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/payment' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/payment" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Credit order payment description: Credits an order's payment. operationId: credit-order-payment @@ -5268,21 +5268,21 @@ paths: required: true schema: type: string - '/orders/{order_number}/payments/{payment_id}/purchase': + "/orders/{order_number}/payments/{payment_id}/purchase": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/payment' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/payment" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Purchase order payment description: Purchases an order's payment. operationId: purchase-order-payment @@ -5301,21 +5301,21 @@ paths: required: true schema: type: string - '/orders/{order_number}/payments/{payment_id}/void': + "/orders/{order_number}/payments/{payment_id}/void": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/payment' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/payment" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Void order payment description: Voids an order's payment. operationId: void-order-payment @@ -5334,21 +5334,21 @@ paths: required: true schema: type: string - '/orders/{order_number}/return_authorizations/{return_authorization_id}/cancel': + "/orders/{order_number}/return_authorizations/{return_authorization_id}/cancel": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/return-authorization' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/return-authorization" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Cancel order return authorization description: Cancels an order's return authorization. operationId: cancel-order-return-authorization @@ -5367,21 +5367,21 @@ paths: required: true schema: type: string - '/shipments/{shipment_number}/add': + "/shipments/{shipment_number}/add": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/shipment' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/shipment" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Add shipment item description: Adds an item to a shipment. operationId: add-shipment-item @@ -5390,28 +5390,28 @@ paths: security: - api-key: [] requestBody: - $ref: '#/components/requestBodies/add-shipment-itemBody' + $ref: "#/components/requestBodies/add-shipment-itemBody" parameters: - name: shipment_number in: path required: true schema: type: string - '/shipments/{shipment_number}/ready': + "/shipments/{shipment_number}/ready": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/shipment' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/shipment" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Ready shipment description: Readies a shipment for processing. operationId: ready-shipment @@ -5425,21 +5425,21 @@ paths: required: true schema: type: string - '/shipments/{shipment_id}/remove': + "/shipments/{shipment_id}/remove": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/shipment' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/shipment" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Remove shipment item description: Removes an item from a shipment. operationId: remove-shipment-id @@ -5448,26 +5448,26 @@ paths: security: - api-key: [] requestBody: - $ref: '#/components/requestBodies/add-shipment-itemBody' + $ref: "#/components/requestBodies/add-shipment-itemBody" parameters: - name: shipment_id in: path required: true schema: type: string - '/shipments/{shipment_number}/select_shipping_method': + "/shipments/{shipment_number}/select_shipping_method": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/shipment' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/shipment" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: Select shipment shipping method description: Selects the shipping method for a shipment. operationId: select-shipment-shipping-method @@ -5490,21 +5490,21 @@ paths: required: true schema: type: string - '/shipments/{shipment_number}/ship': + "/shipments/{shipment_number}/ship": put: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/shipment' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/shipment" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Ship shipment description: Ships a shipment. operationId: ship-shipment @@ -5526,25 +5526,25 @@ paths: required: true schema: type: string - '/orders/{order_number}/coupon_codes': + "/orders/{order_number}/coupon_codes": post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/coupon-code-handler' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - description: '' + $ref: "#/components/schemas/coupon-code-handler" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + description: "" content: application/json: schema: - $ref: '#/components/schemas/coupon-code-handler' + $ref: "#/components/schemas/coupon-code-handler" summary: Create order coupon code description: |- Creates a coupon code for an order. @@ -5560,7 +5560,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/coupon-code-input' + $ref: "#/components/schemas/coupon-code-input" examples: Example: value: @@ -5575,16 +5575,16 @@ paths: /shipments: post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/shipment' - '401': - $ref: '#/components/responses/invalid-api-key' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/shipment" + "401": + $ref: "#/components/responses/invalid-api-key" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create shipment description: |- Creates a shipment. @@ -5622,8 +5622,8 @@ paths: /shipments/transfer_to_location: post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: @@ -5633,10 +5633,10 @@ paths: type: boolean message: type: string - '401': - $ref: '#/components/responses/invalid-api-key' - '422': - $ref: '#/components/responses/unprocessable-entity' + "401": + $ref: "#/components/responses/invalid-api-key" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Transfer shipment item to location description: Transfers a shipment's item to a different stock location. operationId: transfer-shipment-item-to-location @@ -5663,8 +5663,8 @@ paths: /shipments/transfer_to_shipment: post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: @@ -5674,10 +5674,10 @@ paths: type: boolean message: type: string - '401': - $ref: '#/components/responses/invalid-api-key' - '422': - $ref: '#/components/responses/unprocessable-entity' + "401": + $ref: "#/components/responses/invalid-api-key" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Transfer shipment item to shipment description: Transfer a shipment's item to another shipment. operationId: transfer-shipment-item-to-shipment @@ -5702,21 +5702,21 @@ paths: /taxons/products: get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: products: type: array items: - $ref: '#/components/schemas/product' - '401': - $ref: '#/components/responses/invalid-api-key' + $ref: "#/components/schemas/product" + "401": + $ref: "#/components/responses/invalid-api-key" summary: List taxon products description: Lists a taxon's products. operationId: list-taxon-products @@ -5728,9 +5728,9 @@ paths: schema: type: integer description: The id of the Taxon - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" - in: query name: simple schema: @@ -5738,35 +5738,35 @@ paths: description: Returns a simplified version of the JSON security: - api-key: [] - '/orders/{order_number}/customer_returns': + "/orders/{order_number}/customer_returns": get: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: allOf: - - $ref: '#/components/schemas/pagination-data' + - $ref: "#/components/schemas/pagination-data" - type: object properties: customer_returns: type: array items: - $ref: '#/components/schemas/customer-return' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' + $ref: "#/components/schemas/customer-return" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" summary: List order customer returns description: Lists an order's customer returns. operationId: list-order-customer-returns tags: - Customer returns parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/per_page' - - $ref: '#/components/parameters/q' + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/per_page" + - $ref: "#/components/parameters/q" security: - api-key: [] parameters: @@ -5778,18 +5778,18 @@ paths: description: The order number post: responses: - '200': - description: '' + "200": + description: "" content: application/json: schema: - $ref: '#/components/schemas/customer-return' - '401': - $ref: '#/components/responses/invalid-api-key' - '404': - $ref: '#/components/responses/not-found' - '422': - $ref: '#/components/responses/unprocessable-entity' + $ref: "#/components/schemas/customer-return" + "401": + $ref: "#/components/responses/invalid-api-key" + "404": + $ref: "#/components/responses/not-found" + "422": + $ref: "#/components/responses/unprocessable-entity" summary: Create order customer return description: |- Creates a customer return for an order. @@ -5805,7 +5805,7 @@ paths: type: object properties: customer_return: - $ref: '#/components/schemas/customer-return-input' + $ref: "#/components/schemas/customer-return-input" security: - api-key: [] tags: @@ -5843,8 +5843,8 @@ tags: - name: Variants - name: Zones servers: - - url: 'https://example.com/api' - - url: 'http://example.com/api' + - url: "https://example.com/api" + - url: "http://example.com/api" components: parameters: page: @@ -5863,11 +5863,11 @@ components: name: q in: query schema: - example: '?q[attribute_eq]=value' - description: 'Allows to query results based on search filters provided by Ransack (https://github.com/activerecord-hackery/ransack/).' + example: "?q[attribute_eq]=value" + description: "Allows to query results based on search filters provided by Ransack (https://github.com/activerecord-hackery/ransack/)." responses: not-found: - description: '' + description: "" content: application/json: schema: @@ -5876,7 +5876,7 @@ components: error: type: string unprocessable-entity: - description: '' + description: "" content: application/json: schema: @@ -5887,7 +5887,7 @@ components: errors: type: object delete-restriction: - description: '' + description: "" content: application/json: schema: @@ -5896,7 +5896,7 @@ components: error: type: string invalid-api-key: - description: '' + description: "" content: application/json: schema: @@ -5928,6 +5928,7 @@ components: type: apiKey name: Authorization in: header + description: "The `API key` is mandatory for each endpoint by default. You can change this configuration [here](https://github.com/solidusio/solidus/blob/master/api/lib/spree/api_configuration.rb#L5) if you want to avoid the default behaviour exposing some endpoints without an API key. An example is the [GET product list](https://solidus.stoplight.io/docs/solidus/08307f3d809e7-list-products)." order-token: type: apiKey name: X-Spree-Order-Token @@ -5942,7 +5943,7 @@ components: classifications: type: array items: - $ref: '#/components/schemas/classification' + $ref: "#/components/schemas/classification" description: type: string display_price: @@ -5952,7 +5953,7 @@ components: id: type: integer master: - $ref: '#/components/schemas/variant' + $ref: "#/components/schemas/variant" meta_description: type: string meta_keywords: @@ -5964,13 +5965,13 @@ components: option_types: type: array items: - $ref: '#/components/schemas/option-type' + $ref: "#/components/schemas/option-type" price: type: string product_properties: type: array items: - $ref: '#/components/schemas/product-property' + $ref: "#/components/schemas/product-property" shipping_category_id: type: integer slug: @@ -5984,7 +5985,7 @@ components: variants: type: array items: - $ref: '#/components/schemas/variant' + $ref: "#/components/schemas/variant" pagination-data: type: object properties: @@ -6052,7 +6053,7 @@ components: images: type: array items: - $ref: '#/components/schemas/image' + $ref: "#/components/schemas/image" in_stock: type: boolean is_backorderable: @@ -6066,7 +6067,7 @@ components: option_values: type: array items: - $ref: '#/components/schemas/option-value' + $ref: "#/components/schemas/option-value" options_text: type: string price: @@ -6123,7 +6124,7 @@ components: option_values: type: array items: - $ref: '#/components/schemas/option-value' + $ref: "#/components/schemas/option-value" position: type: integer presentation: @@ -6136,7 +6137,7 @@ components: position: type: integer taxon: - $ref: '#/components/schemas/taxon' + $ref: "#/components/schemas/taxon" taxon_id: type: integer taxon: @@ -6157,7 +6158,7 @@ components: taxons: type: array items: - $ref: '#/components/schemas/taxon' + $ref: "#/components/schemas/taxon" title: Taxon order-small: type: object @@ -6252,9 +6253,9 @@ components: adjustments: type: array items: - $ref: '#/components/schemas/adjustment' + $ref: "#/components/schemas/adjustment" bill_address: - $ref: '#/components/schemas/address' + $ref: "#/components/schemas/address" canceler_id: type: integer channel: @@ -6272,7 +6273,7 @@ components: credit_cards: type: array items: - $ref: '#/components/schemas/credit-card' + $ref: "#/components/schemas/credit-card" currency: type: string display_additional_tax_total: @@ -6306,7 +6307,7 @@ components: line_items: type: array items: - $ref: '#/components/schemas/line-item' + $ref: "#/components/schemas/line-item" number: type: string order_total_after_store_credit: @@ -6314,7 +6315,7 @@ components: payment_methods: type: array items: - $ref: '#/components/schemas/payment-method' + $ref: "#/components/schemas/payment-method" payment_state: type: string payment_total: @@ -6322,11 +6323,11 @@ components: payments: type: array items: - $ref: '#/components/schemas/payment' + $ref: "#/components/schemas/payment" permissions: - $ref: '#/components/schemas/order-permissions' + $ref: "#/components/schemas/order-permissions" ship_address: - $ref: '#/components/schemas/address' + $ref: "#/components/schemas/address" ship_total: type: string shipment_state: @@ -6334,7 +6335,7 @@ components: shipments: type: array items: - $ref: '#/components/schemas/shipment' + $ref: "#/components/schemas/shipment" special_instructions: type: string state: @@ -6368,7 +6369,7 @@ components: company: type: string country: - $ref: '#/components/schemas/country' + $ref: "#/components/schemas/country" country_id: type: integer country_iso: @@ -6380,7 +6381,7 @@ components: phone: type: string state: - $ref: '#/components/schemas/state' + $ref: "#/components/schemas/state" state_id: type: integer state_name: @@ -6471,7 +6472,7 @@ components: adjustments: type: array items: - $ref: '#/components/schemas/adjustment' + $ref: "#/components/schemas/adjustment" display_amount: type: string id: @@ -6485,7 +6486,7 @@ components: total: type: string variant: - $ref: '#/components/schemas/variant' + $ref: "#/components/schemas/variant" variant_id: type: integer payment-method: @@ -6515,11 +6516,11 @@ components: id: type: integer payment_method: - $ref: '#/components/schemas/payment-method' + $ref: "#/components/schemas/payment-method" payment_method_id: type: integer source: - $ref: '#/components/schemas/payment-source' + $ref: "#/components/schemas/payment-source" source_id: type: integer source_type: @@ -6561,7 +6562,7 @@ components: adjustments: type: array items: - $ref: '#/components/schemas/adjustment' + $ref: "#/components/schemas/adjustment" cost: type: string id: @@ -6569,23 +6570,23 @@ components: manifest: type: array items: - $ref: '#/components/schemas/shipment-manifest' + $ref: "#/components/schemas/shipment-manifest" number: type: string order_id: type: string selected_shipping_rate: - $ref: '#/components/schemas/shipping-rate' + $ref: "#/components/schemas/shipping-rate" shipped_at: type: string shipping_methods: type: array items: - $ref: '#/components/schemas/shipping-method' + $ref: "#/components/schemas/shipping-method" shipping_rates: type: array items: - $ref: '#/components/schemas/shipping-rate' + $ref: "#/components/schemas/shipping-rate" state: type: string stock_location_name: @@ -6625,11 +6626,11 @@ components: shipping_categories: type: array items: - $ref: '#/components/schemas/shipping-category' + $ref: "#/components/schemas/shipping-category" zones: type: array items: - $ref: '#/components/schemas/zone' + $ref: "#/components/schemas/zone" shipment-manifest: type: array title: Shipment manifest @@ -6667,7 +6668,7 @@ components: type: object properties: bill_address: - $ref: '#/components/schemas/address' + $ref: "#/components/schemas/address" created_at: type: string email: @@ -6675,7 +6676,7 @@ components: id: type: integer ship_address: - $ref: '#/components/schemas/address' + $ref: "#/components/schemas/address" updated_at: type: string title: User @@ -6718,7 +6719,7 @@ components: city: type: string country: - $ref: '#/components/schemas/country' + $ref: "#/components/schemas/country" country_id: type: integer id: @@ -6728,7 +6729,7 @@ components: phone: type: string state: - $ref: '#/components/schemas/state' + $ref: "#/components/schemas/state" state_id: type: integer state_name: @@ -6747,7 +6748,7 @@ components: stock_location_id: type: integer variant: - $ref: '#/components/schemas/variant' + $ref: "#/components/schemas/variant" variant_id: type: integer title: Stock item @@ -6760,7 +6761,7 @@ components: quantity: type: integer stock_item: - $ref: '#/components/schemas/stock-item' + $ref: "#/components/schemas/stock-item" stock_item_id: type: integer store: @@ -6801,7 +6802,7 @@ components: name: type: string root: - $ref: '#/components/schemas/taxon' + $ref: "#/components/schemas/taxon" title: Taxonomy promotion: type: object @@ -6866,7 +6867,7 @@ components: title: Address book items: allOf: - - $ref: '#/components/schemas/address' + - $ref: "#/components/schemas/address" - type: object properties: default: @@ -6940,20 +6941,20 @@ components: type: string abbr: type: string - description: '' + description: "" line-item-input: type: object title: Line item input properties: quantity: type: integer - description: 'Passing `0`, the line item will be removed. When omitted creating a line item, quantity will be `1`.' + description: "Passing `0`, the line item will be removed. When omitted creating a line item, quantity will be `1`." options: type: object - description: 'This field can be used to pass custom line item attributes. When used, it will force a new price calculation, unless `price` is one of the options.' + description: "This field can be used to pass custom line item attributes. When used, it will force a new price calculation, unless `price` is one of the options." id: type: integer - description: 'Required when updating existing line items, only when not already present in the Path Parameters.' + description: "Required when updating existing line items, only when not already present in the Path Parameters." variant_id: type: integer description: Required for new line items only. @@ -6968,7 +6969,7 @@ components: option_values_attributes: type: array items: - $ref: '#/components/schemas/option-value-input' + $ref: "#/components/schemas/option-value-input" option-value-input: type: object title: Option value input @@ -6994,7 +6995,7 @@ components: name: type: string address_attributes: - $ref: '#/components/schemas/address-input' + $ref: "#/components/schemas/address-input" inventory-unit-input: type: object title: Inventory unit input @@ -7042,7 +7043,7 @@ components: wallet_payment_source_id: type: integer address_attributes: - $ref: '#/components/schemas/address-input' + $ref: "#/components/schemas/address-input" shipment-input: type: object title: Shipment input @@ -7067,21 +7068,21 @@ components: use_billing: type: boolean bill_address_attributes: - $ref: '#/components/schemas/address-input' + $ref: "#/components/schemas/address-input" ship_address_attributes: - $ref: '#/components/schemas/address-input' + $ref: "#/components/schemas/address-input" payments_attributes: type: array items: - $ref: '#/components/schemas/payment-input' + $ref: "#/components/schemas/payment-input" shipments_attributes: type: array items: - $ref: '#/components/schemas/shipment-input' + $ref: "#/components/schemas/shipment-input" line_items_attributes: type: array items: - $ref: '#/components/schemas/line-item-input' + $ref: "#/components/schemas/line-item-input" product-input: type: object title: Product input @@ -7129,7 +7130,7 @@ components: product_properties_attributes: type: array items: - $ref: '#/components/schemas/product-property-input' + $ref: "#/components/schemas/product-property-input" product-property-input: type: object title: Product property input @@ -7191,10 +7192,10 @@ components: option_values_attributes: type: array items: - $ref: '#/components/schemas/option-value-input' + $ref: "#/components/schemas/option-value-input" options: type: object - description: '`Name` will be the name/presentation of the option type and `Value` will be the name/presentation of the option value. They will be created if not exist.' + description: "`Name` will be the name/presentation of the option type and `Value` will be the name/presentation of the option value. They will be created if not exist." properties: name: type: string @@ -7315,13 +7316,13 @@ components: password_confirmation: type: string bill_address_attributes: - $ref: '#/components/schemas/address-input' + $ref: "#/components/schemas/address-input" ship_address_attributes: - $ref: '#/components/schemas/address-input' + $ref: "#/components/schemas/address-input" address-book-input: title: Address book input allOf: - - $ref: '#/components/schemas/address-input' + - $ref: "#/components/schemas/address-input" - type: object properties: default: