diff --git a/openapi/components/parameters/After.yaml b/openapi/components/parameters/After.yaml index 80e6127..202bf01 100644 --- a/openapi/components/parameters/After.yaml +++ b/openapi/components/parameters/After.yaml @@ -1,6 +1,6 @@ name: after in: query required: false -description: Use the `endCursor` as a value for the `after` parameter to get the next page. +description: Use the `nextPage` value as the `after` parameter to get the next page. schema: type: string diff --git a/openapi/components/parameters/Before.yaml b/openapi/components/parameters/Before.yaml index a719dc6..b244d53 100644 --- a/openapi/components/parameters/Before.yaml +++ b/openapi/components/parameters/Before.yaml @@ -2,6 +2,6 @@ name: before in: query required: false description: | - Use the `startCursor` as a value for the `before` parameter to get the previous page. + Use the `previousPage` value as the `before` parameter to get the previous page. schema: type: string diff --git a/openapi/components/schemas/Page.yaml b/openapi/components/schemas/Page.yaml index a0e995a..76bd73a 100644 --- a/openapi/components/schemas/Page.yaml +++ b/openapi/components/schemas/Page.yaml @@ -1,41 +1,28 @@ type: object properties: - endCursor: + nextPage: type: - string - 'null' description: |- Use with the `after` query parameter to load the next page of data. - When `null`, there is no data. + When `null`, there is no next page. The cursor is opaque and internal structure is subject to change. - startCursor: + previousPage: type: - string - 'null' description: |- Use with the `before` query parameter to load the previous page of data. - When `null`, there is no data. + When `null`, there is no previous page. The cursor is opaque and internal structure is subject to change. - hasNextPage: - type: boolean - description: Indicates if there is a next page with items. - hasPrevPage: - type: boolean - description: Indicates if there is a previous page with items. limit: type: integer minimum: 1 maximum: 100 default: 10 description: Value showing how many items are in the page limit. - total: - type: integer - description: Count of items across all pages. - minimum: 0 required: - - endCursor - - startCursor - - hasNextPage - - hasPrevPage + - nextPage + - previousPage - limit - - total