chore(docs): Updated API Reference (v2) (#8384)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
This commit is contained in:
github-actions[bot]
2024-08-01 07:43:40 +00:00
committed by GitHub
parent 123dad7db8
commit 31ec4d0d71
10 changed files with 38 additions and 76 deletions
@@ -22,18 +22,18 @@
* description: Comma-separated relations that should be expanded in the returned data.
* - 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.
* 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.
* 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.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
@@ -75,8 +75,6 @@
* tags:
* - Claims
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -173,7 +173,6 @@
* description: The product's tags.
* required: false
* schema:
* type: object
* description: The product's tags.
* properties:
* value:
@@ -21,18 +21,18 @@
* description: Comma-separated relations that should be expanded in the returned data.
* - 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.
* 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.
* 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.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
@@ -79,8 +79,6 @@
* tags:
* - Claims
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -158,7 +158,6 @@
* description: The product's category id.
* required: true
* schema:
* type: array
* description: The product's category id.
* items:
* type: string
@@ -169,7 +168,6 @@
* description: The product's sales channel id.
* required: true
* schema:
* type: array
* description: The product's sales channel id.
* items:
* type: string
@@ -180,7 +178,6 @@
* description: The product's collection id.
* required: true
* schema:
* type: array
* description: The product's collection id.
* items:
* type: string
@@ -191,7 +188,6 @@
* description: The product's tags.
* required: false
* schema:
* type: array
* description: The product's tags.
* items:
* type: string
@@ -202,7 +198,6 @@
* description: The product's type id.
* required: false
* schema:
* type: array
* description: The product's type id.
* items:
* type: string