chore(docs): Updated API Reference (automated) (#10437)
* chore(docs): Generated API Reference (automated) * fixes --------- Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
29e463e8c3
commit
c9eeaebdd9
@@ -109,3 +109,71 @@ get:
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: getOrderDetailWorkflow
|
||||
post:
|
||||
operationId: PostOrdersId
|
||||
summary: Update Order
|
||||
description: Update an order's details.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The order's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: fields
|
||||
in: query
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
|
||||
if a field is prefixed with `+` it will be added to the default fields,
|
||||
using `-` will remove it from the default fields.
|
||||
|
||||
without prefix it will replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: fields
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
If a field is prefixed with `+` it will be added to the default
|
||||
fields, using `-` will remove it from the default fields. Without
|
||||
prefix it will replace the entire default fields.
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminUpdateOrder.yaml
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_orders_{id}/post.sh
|
||||
tags:
|
||||
- Orders
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminOrderResponse.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
|
||||
x-workflow: updateOrderWorkflow
|
||||
|
||||
@@ -129,31 +129,43 @@ get:
|
||||
- name: include_ancestors_tree
|
||||
in: query
|
||||
description: >-
|
||||
Whether to include the parent category of each category. If enabled, the
|
||||
parent category is set in the `parent_category` property of each
|
||||
category object.
|
||||
Whether to include the parent category of each category. If you enable
|
||||
this, add to the `fields` query parameter `parent_category` to set the
|
||||
parent of a category in this field. You can either pass
|
||||
`*parent_category` to retreieve the fields of all parent categories, or
|
||||
select specific fields to make the response size smaller. For example,
|
||||
`fields=parent_category.id,parent_category.name`.
|
||||
required: false
|
||||
schema:
|
||||
type: boolean
|
||||
title: include_ancestors_tree
|
||||
description: >-
|
||||
Whether to include the parent category of each category. If enabled,
|
||||
the parent category is set in the `parent_category` property of each
|
||||
category object.
|
||||
Whether to include the parent category of each category. If you enable
|
||||
this, add to the `fields` query parameter `parent_category` to set the
|
||||
parent of a category in this field. You can either pass
|
||||
`*parent_category` to retreieve the fields of all parent categories,
|
||||
or select specific fields to make the response size smaller. For
|
||||
example, `fields=parent_category.id,parent_category.name`.
|
||||
- name: include_descendants_tree
|
||||
in: query
|
||||
description: >-
|
||||
Whether to include the child categories of each category. If enabled,
|
||||
the child categories are added to the `category_children` property of
|
||||
each category object.
|
||||
Whether to include the child categories of each category. If you enable
|
||||
this, add to the `fields` query parameter `category_children` to set the
|
||||
children of a category in this field. You can either pass
|
||||
`*category_children` to retreieve the fields of all child categories, or
|
||||
select specific fields to make the response size smaller. For example,
|
||||
`fields=category_children.id,category_children.name`.
|
||||
required: false
|
||||
schema:
|
||||
type: boolean
|
||||
title: include_descendants_tree
|
||||
description: >-
|
||||
Whether to include the child categories of each category. If enabled,
|
||||
the child categories are added to the `category_children` property of
|
||||
each category object.
|
||||
Whether to include the child categories of each category. If you
|
||||
enable this, add to the `fields` query parameter `category_children`
|
||||
to set the children of a category in this field. You can either pass
|
||||
`*category_children` to retreieve the fields of all child categories,
|
||||
or select specific fields to make the response size smaller. For
|
||||
example, `fields=category_children.id,category_children.name`.
|
||||
- name: is_internal
|
||||
in: query
|
||||
description: Filter by whether the category is internal.
|
||||
|
||||
@@ -33,27 +33,43 @@ get:
|
||||
- name: include_ancestors_tree
|
||||
in: query
|
||||
description: >-
|
||||
Whether to retrieve the category's parent. When enabled, the parent
|
||||
category is set in the `parent_category` property.
|
||||
Whether to retrieve the category's parent. If you enable this, add to
|
||||
the `fields` query parameter `parent_category` to set the parent of a
|
||||
category in this field. You can either pass `*parent_category` to
|
||||
retreieve the fields of all parent categories, or select specific fields
|
||||
to make the response size smaller. For example,
|
||||
`fields=parent_category.id,parent_category.name`.
|
||||
required: false
|
||||
schema:
|
||||
type: boolean
|
||||
title: include_ancestors_tree
|
||||
description: >-
|
||||
Whether to retrieve the category's parent. When enabled, the parent
|
||||
category is set in the `parent_category` property.
|
||||
Whether to retrieve the category's parent. If you enable this, add to
|
||||
the `fields` query parameter `parent_category` to set the parent of a
|
||||
category in this field. You can either pass `*parent_category` to
|
||||
retreieve the fields of all parent categories, or select specific
|
||||
fields to make the response size smaller. For example,
|
||||
`fields=parent_category.id,parent_category.name`.
|
||||
- name: include_descendants_tree
|
||||
in: query
|
||||
description: >-
|
||||
Whether to retrieve a list of child categories. When enabled, the parent
|
||||
categories are added to the `category_children` property.
|
||||
Whether to retrieve a list of child categories. If you enable this, add
|
||||
to the `fields` query parameter `category_children` to set the children
|
||||
of a category in this field. You can either pass `*category_children` to
|
||||
retreieve the fields of all child categories, or select specific fields
|
||||
to make the response size smaller. For example,
|
||||
`fields=category_children.id,category_children.name`.
|
||||
required: false
|
||||
schema:
|
||||
type: boolean
|
||||
title: include_descendants_tree
|
||||
description: >-
|
||||
Whether to retrieve a list of child categories. When enabled, the
|
||||
parent categories are added to the `category_children` property.
|
||||
Whether to retrieve a list of child categories. If you enable this,
|
||||
add to the `fields` query parameter `category_children` to set the
|
||||
children of a category in this field. You can either pass
|
||||
`*category_children` to retreieve the fields of all child categories,
|
||||
or select specific fields to make the response size smaller. For
|
||||
example, `fields=category_children.id,category_children.name`.
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
Reference in New Issue
Block a user