chore(docs): Generated API Reference (#5662)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
co-authored by
olivermrbl
parent
d3e8efd573
commit
73799d4e9e
+7
@@ -21,3 +21,10 @@ properties:
|
|||||||
rank:
|
rank:
|
||||||
type: number
|
type: number
|
||||||
description: The rank of the category in the tree node (starting from 0)
|
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
|
||||||
|
|||||||
+7
@@ -25,3 +25,10 @@ properties:
|
|||||||
parent_category_id:
|
parent_category_id:
|
||||||
type: string
|
type: string
|
||||||
description: The ID of the parent product category
|
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
|
||||||
|
|||||||
@@ -1857,6 +1857,18 @@ paths:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/AdminCurrenciesListRes'
|
$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}:
|
/admin/currencies/{code}:
|
||||||
post:
|
post:
|
||||||
operationId: PostCurrenciesCurrency
|
operationId: PostCurrenciesCurrency
|
||||||
@@ -1917,6 +1929,18 @@ paths:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/AdminCurrenciesRes'
|
$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:
|
/admin/customer-groups:
|
||||||
get:
|
get:
|
||||||
operationId: GetCustomerGroups
|
operationId: GetCustomerGroups
|
||||||
@@ -25228,6 +25252,15 @@ components:
|
|||||||
rank:
|
rank:
|
||||||
type: number
|
type: number
|
||||||
description: The rank of the category in the tree node (starting from 0)
|
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:
|
AdminPostProductCategoriesReq:
|
||||||
type: object
|
type: object
|
||||||
required:
|
required:
|
||||||
@@ -25258,6 +25291,15 @@ components:
|
|||||||
parent_category_id:
|
parent_category_id:
|
||||||
type: string
|
type: string
|
||||||
description: The ID of the parent product category
|
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:
|
AdminPostProductsProductMetadataReq:
|
||||||
type: object
|
type: object
|
||||||
required:
|
required:
|
||||||
@@ -32975,6 +33017,7 @@ components:
|
|||||||
- id
|
- id
|
||||||
- is_active
|
- is_active
|
||||||
- is_internal
|
- is_internal
|
||||||
|
- metadata
|
||||||
- mpath
|
- mpath
|
||||||
- name
|
- name
|
||||||
- parent_category_id
|
- parent_category_id
|
||||||
@@ -33047,6 +33090,18 @@ components:
|
|||||||
description: The date with timezone at which the resource was updated.
|
description: The date with timezone at which the resource was updated.
|
||||||
type: string
|
type: string
|
||||||
format: date-time
|
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:
|
ProductCollection:
|
||||||
title: Product Collection
|
title: Product Collection
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -59,3 +59,15 @@ get:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: ../components/schemas/AdminCurrenciesListRes.yaml
|
$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
|
||||||
|
|||||||
@@ -39,3 +39,15 @@ post:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: ../components/schemas/AdminCurrenciesRes.yaml
|
$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
|
||||||
|
|||||||
@@ -10399,6 +10399,7 @@ components:
|
|||||||
- id
|
- id
|
||||||
- is_active
|
- is_active
|
||||||
- is_internal
|
- is_internal
|
||||||
|
- metadata
|
||||||
- mpath
|
- mpath
|
||||||
- name
|
- name
|
||||||
- parent_category_id
|
- parent_category_id
|
||||||
@@ -10471,6 +10472,18 @@ components:
|
|||||||
description: The date with timezone at which the resource was updated.
|
description: The date with timezone at which the resource was updated.
|
||||||
type: string
|
type: string
|
||||||
format: date-time
|
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:
|
ProductCollection:
|
||||||
title: Product Collection
|
title: Product Collection
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
Reference in New Issue
Block a user