Added cursor-based pagination example to CatalogItems.get
This commit is contained in:
@@ -65,24 +65,38 @@ paths:
|
|||||||
get:
|
get:
|
||||||
summary: List all CatalogItems for an Enterprise
|
summary: List all CatalogItems for an Enterprise
|
||||||
parameters:
|
parameters:
|
||||||
- name: page
|
- name: before
|
||||||
description: The page number of items to start with (see limit)
|
description: The cursor returned from a previous request, requesting the API return elements before that id.
|
||||||
in: query
|
in: query
|
||||||
required: true
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: integer
|
type: string
|
||||||
minimum: 1
|
- name: after
|
||||||
default: 1
|
description: The cursor returned from a previous request, requesting the API return elements after that id.
|
||||||
example: 1
|
|
||||||
- name: limit
|
|
||||||
description: The number of items to return
|
|
||||||
in: query
|
in: query
|
||||||
required: true
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: first
|
||||||
|
description: Return up to the first x elements in the list
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
minimum: 1
|
minimum: 1
|
||||||
maximum: 225
|
maximum: 255
|
||||||
|
default: 25
|
||||||
|
example: 25
|
||||||
|
- name: last
|
||||||
|
description: Return up to the last x elements in the list
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
format: int32
|
||||||
|
minimum: 1
|
||||||
|
maximum: 255
|
||||||
default: 25
|
default: 25
|
||||||
example: 25
|
example: 25
|
||||||
tags:
|
tags:
|
||||||
|
|||||||
Reference in New Issue
Block a user