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:
committed by
GitHub
parent
29e463e8c3
commit
c9eeaebdd9
@@ -135,27 +135,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 child 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
|
||||
child 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: created_at
|
||||
in: query
|
||||
description: Filter by the category's creation date.
|
||||
|
||||
@@ -37,27 +37,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`.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
|
||||
Reference in New Issue
Block a user