chore(docs): Generated API Reference (#4706)
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
efdea04963
commit
658339767b
@@ -1,31 +1,44 @@
|
||||
get:
|
||||
operationId: GetCustomers
|
||||
summary: List Customers
|
||||
description: Retrieves a list of Customers.
|
||||
description: >-
|
||||
Retrieve a list of Customers. The customers can be filtered by fields such
|
||||
as `q` or `groups`. The customers can also be paginated.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: query
|
||||
name: limit
|
||||
description: The number of items to return.
|
||||
description: The number of customers to return.
|
||||
schema:
|
||||
type: integer
|
||||
default: 50
|
||||
- in: query
|
||||
name: offset
|
||||
description: The items to skip before result.
|
||||
description: The number of customers to skip when retrieving the customers.
|
||||
schema:
|
||||
type: integer
|
||||
default: 0
|
||||
- in: query
|
||||
name: expand
|
||||
description: (Comma separated) Which fields should be expanded in each customer.
|
||||
description: >-
|
||||
Comma-separated relations that should be expanded in the returned
|
||||
customer.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: q
|
||||
description: a search term to search email, first_name, and last_name.
|
||||
description: term to search customers' email, first_name, and last_name fields.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: groups
|
||||
style: form
|
||||
explode: false
|
||||
description: Filter by customer group IDs.
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetCustomersParams
|
||||
@@ -65,7 +78,7 @@ get:
|
||||
post:
|
||||
operationId: PostCustomers
|
||||
summary: Create a Customer
|
||||
description: Creates a Customer.
|
||||
description: Allow admins to create a customer.
|
||||
x-authenticated: true
|
||||
requestBody:
|
||||
content:
|
||||
|
||||
Reference in New Issue
Block a user