Update API docs with product filters

This commit is contained in:
David Bomba 2023-02-18 15:20:21 +11:00
parent df8bd671d9
commit 93c3d007f3
2 changed files with 28 additions and 0 deletions

View File

@ -11670,6 +11670,13 @@ paths:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
- name: filter
in: query
description: Filter by product name
required: false
schema:
type: string
example: bob
responses:
200:
description: "A list of products"

View File

@ -12,6 +12,27 @@
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
- name: filter
in: query
description: Filter by product name
required: false
schema:
type: string
example: bob
- name: product_key
in: query
description: Filter by product key
required: false
schema:
type: string
example: bob
- name: sort
in: query
description: Returns the list sorted by column in ascending or descending order.
required: false
schema:
type: string
example: id|desc product_key|desc
responses:
200:
description: "A list of products"