From 73799d4e9edd168ea0ecdd85f142d509a2534802 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 21 Nov 2023 10:45:38 +0000 Subject: [PATCH] chore(docs): Generated API Reference (#5662) Co-authored-by: olivermrbl --- ...AdminPostProductCategoriesCategoryReq.yaml | 7 +++ .../AdminPostProductCategoriesReq.yaml | 7 +++ .../specs/admin/openapi.full.yaml | 55 +++++++++++++++++++ .../specs/admin/paths/admin_currencies.yaml | 12 ++++ .../admin/paths/admin_currencies_{code}.yaml | 12 ++++ .../specs/store/openapi.full.yaml | 13 +++++ 6 files changed, 106 insertions(+) diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesCategoryReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesCategoryReq.yaml index b9f61a3d2c..276e25b0e8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesCategoryReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesCategoryReq.yaml @@ -21,3 +21,10 @@ properties: rank: type: number description: The rank of the category in the tree node (starting from 0) + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + externalDocs: + description: Learn about the metadata attribute, and how to delete and update it. + url: >- + https://docs.medusajs.com/development/entities/overview#metadata-attribute diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesReq.yaml index 2b003fbb24..444e7e7636 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesReq.yaml @@ -25,3 +25,10 @@ properties: parent_category_id: type: string description: The ID of the parent product category + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + externalDocs: + description: Learn about the metadata attribute, and how to delete and update it. + url: >- + https://docs.medusajs.com/development/entities/overview#metadata-attribute diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index 223581fb2c..f1a24178ec 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -1857,6 +1857,18 @@ paths: application/json: schema: $ref: '#/components/schemas/AdminCurrenciesListRes' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' /admin/currencies/{code}: post: operationId: PostCurrenciesCurrency @@ -1917,6 +1929,18 @@ paths: application/json: schema: $ref: '#/components/schemas/AdminCurrenciesRes' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' /admin/customer-groups: get: operationId: GetCustomerGroups @@ -25228,6 +25252,15 @@ components: rank: type: number description: The rank of the category in the tree node (starting from 0) + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + externalDocs: + description: >- + Learn about the metadata attribute, and how to delete and update + it. + url: >- + https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostProductCategoriesReq: type: object required: @@ -25258,6 +25291,15 @@ components: parent_category_id: type: string description: The ID of the parent product category + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + externalDocs: + description: >- + Learn about the metadata attribute, and how to delete and update + it. + url: >- + https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostProductsProductMetadataReq: type: object required: @@ -32975,6 +33017,7 @@ components: - id - is_active - is_internal + - metadata - mpath - name - parent_category_id @@ -33047,6 +33090,18 @@ components: description: The date with timezone at which the resource was updated. type: string format: date-time + metadata: + description: An optional key-value map with additional details + nullable: true + type: object + example: + car: white + externalDocs: + description: >- + Learn about the metadata attribute, and how to delete and update + it. + url: >- + https://docs.medusajs.com/development/entities/overview#metadata-attribute ProductCollection: title: Product Collection description: >- diff --git a/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml b/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml index 74e92a3d13..55114ee205 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml @@ -59,3 +59,15 @@ get: application/json: schema: $ref: ../components/schemas/AdminCurrenciesListRes.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_currencies_{code}.yaml b/www/apps/api-reference/specs/admin/paths/admin_currencies_{code}.yaml index b14e03c681..4f6752a96e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_currencies_{code}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_currencies_{code}.yaml @@ -39,3 +39,15 @@ post: application/json: schema: $ref: ../components/schemas/AdminCurrenciesRes.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 2af55f852c..58b52e0bfb 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -10399,6 +10399,7 @@ components: - id - is_active - is_internal + - metadata - mpath - name - parent_category_id @@ -10471,6 +10472,18 @@ components: description: The date with timezone at which the resource was updated. type: string format: date-time + metadata: + description: An optional key-value map with additional details + nullable: true + type: object + example: + car: white + externalDocs: + description: >- + Learn about the metadata attribute, and how to delete and update + it. + url: >- + https://docs.medusajs.com/development/entities/overview#metadata-attribute ProductCollection: title: Product Collection description: >-