diff options
| author |   Luke Gleeson <luke.gleeson@est.tech> | 2023-08-03 13:13:47 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@onap.org> | 2023-08-03 13:13:47 +0000 |
| commit | 478c5dac54ed508f0ce97e18e91aac7b821d814f (patch) | |
| tree | 6b8d3d25972ebacf2d429ede2fff601cce15bc2e /cps-rest/docs | |
| parent | 2a1e576e6d12456e43c47d4cd81be7f88d1a2a2b (diff) | |
| parent | f248b5d9b794d5bdff59145406e0398d6fdcafa4 (diff) | |
Merge "Support pagination in query across all anchors(ep4)"
Diffstat (limited to 'cps-rest/docs')
| -rw-r--r-- | cps-rest/docs/openapi/components.yml | 16 | ||||
| -rw-r--r-- | cps-rest/docs/openapi/cpsQueryV2.yml | 4 |
2 files changed, 19 insertions, 1 deletions
diff --git a/cps-rest/docs/openapi/components.yml b/cps-rest/docs/openapi/components.yml index a72130562e..900f663bfc 100644 --- a/cps-rest/docs/openapi/components.yml +++ b/cps-rest/docs/openapi/components.yml @@ -269,6 +269,22 @@ components: type: string default: none example: 3 + pageIndexInQuery: + name: pageIndex + in: query + description: page index for pagination over anchors. It must be greater then zero if provided. + required: false + schema: + type: integer + example: 1 + pageSizeInQuery: + name: pageSize + in: query + description: number of records (anchors) per page. It must be greater then zero if provided. + required: false + schema: + type: integer + example: 10 responses: NotFound: diff --git a/cps-rest/docs/openapi/cpsQueryV2.yml b/cps-rest/docs/openapi/cpsQueryV2.yml index 9beb0e3330..4443fb17ec 100644 --- a/cps-rest/docs/openapi/cpsQueryV2.yml +++ b/cps-rest/docs/openapi/cpsQueryV2.yml @@ -53,12 +53,14 @@ nodesByDataspaceAndCpsPath: description: Query data nodes for the given dataspace across anchors using CPS path tags: - cps-query - summary: Query data nodes + summary: Query data nodes across anchors operationId: getNodesByDataspaceAndCpsPath parameters: - $ref: 'components.yml#/components/parameters/dataspaceNameInPath' - $ref: 'components.yml#/components/parameters/cpsPathInQuery' - $ref: 'components.yml#/components/parameters/descendantsInQuery' + - $ref: 'components.yml#/components/parameters/pageIndexInQuery' + - $ref: 'components.yml#/components/parameters/pageSizeInQuery' responses: '200': description: OK |