From d69c28769a2bd456befebd905c49a5b67313408d Mon Sep 17 00:00:00 2001 From: "henrik.larsen@dcsa.org" Date: Thu, 22 Jan 2026 09:57:03 +0100 Subject: [PATCH 1/2] Fix Next-Page-Cursor description --- cs/v1/CS_v1.0.2.yaml | 18 +++++++++--------- ovs/v3/OVS_v3.0.2.yaml | 6 +++--- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/cs/v1/CS_v1.0.2.yaml b/cs/v1/CS_v1.0.2.yaml index bd8abfba..51c2d251 100644 --- a/cs/v1/CS_v1.0.2.yaml +++ b/cs/v1/CS_v1.0.2.yaml @@ -64,11 +64,11 @@ paths: maxLength: 1024 example: fE9mZnNldHw9MTAmbGltaXQ9MTA description: | - The Next-Page-Cursor header contains a cursor value that points to the next page of results in a paginated API response. + The `Next-Page-Cursor` header contains a cursor value that points to the next page of results in a paginated API response. When an initial `GET` endpoint request includes the query parameter `limit=...` the API provider limits the number of items in the root array of the response to the specified limit. If the response would contain more items than the specified limit, the API provider includes only the first set of limit items and appends the following response header: - `Next-Page-Cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA`, a string that acts as a reference for the next page of results. The cursor value is used in subsequent requests to retrieve the next page by passing it as a query parameter: `?cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA`. + `Next-Page-Cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA`, a string that acts as a reference for the next page of results. The `Next-Page-Cursor` value is used in a subsequent request to retrieve the next page by passing it as a value in the `cursor`-query parameter: `cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA`. - To retrieve the next page, the API consumer sends a `GET` request to the endpoint URL with only `?cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA` as query parameter. The limit of items per page and any other query parameters may not be altered and MUST be preserved when requesting subsequent pages. + To retrieve the next page, the API consumer sends a `GET` request to the endpoint URL with `cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA` as query parameter along with the limit of items per page and any other query parameters used in the original request. Filter parameters may not be altered and MUST be preserved when requesting subsequent pages. '400': description: Bad Request headers: @@ -285,11 +285,11 @@ paths: maxLength: 1024 example: fE9mZnNldHw9MTAmbGltaXQ9MTA description: | - The Next-Page-Cursor header contains a cursor value that points to the next page of results in a paginated API response. + The `Next-Page-Cursor` header contains a cursor value that points to the next page of results in a paginated API response. When an initial `GET` endpoint request includes the query parameter `limit=...` the API provider limits the number of items in the root array of the response to the specified limit. If the response would contain more items than the specified limit, the API provider includes only the first set of limit items and appends the following response header: - `Next-Page-Cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA`, a string that acts as a reference for the next page of results. The cursor value is used in subsequent requests to retrieve the next page by passing it as a query parameter: `?cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA`. + `Next-Page-Cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA`, a string that acts as a reference for the next page of results. The `Next-Page-Cursor` value is used in a subsequent request to retrieve the next page by passing it as a value in the `cursor`-query parameter: `cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA`. - To retrieve the next page, the API consumer sends a `GET` request to the endpoint URL with only `?cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA` as query parameter. The limit of items per page and any other query parameters may not be altered and MUST be preserved when requesting subsequent pages. + To retrieve the next page, the API consumer sends a `GET` request to the endpoint URL with `cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA` as query parameter along with the limit of items per page and any other query parameters used in the original request. Filter parameters may not be altered and MUST be preserved when requesting subsequent pages. '400': description: Bad Request headers: @@ -422,11 +422,11 @@ paths: maxLength: 1024 example: fE9mZnNldHw9MTAmbGltaXQ9MTA description: | - The Next-Page-Cursor header contains a cursor value that points to the next page of results in a paginated API response. + The `Next-Page-Cursor` header contains a cursor value that points to the next page of results in a paginated API response. When an initial `GET` endpoint request includes the query parameter `limit=...` the API provider limits the number of items in the root array of the response to the specified limit. If the response would contain more items than the specified limit, the API provider includes only the first set of limit items and appends the following response header: - `Next-Page-Cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA`, a string that acts as a reference for the next page of results. The cursor value is used in subsequent requests to retrieve the next page by passing it as a query parameter: `?cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA`. + `Next-Page-Cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA`, a string that acts as a reference for the next page of results. The `Next-Page-Cursor` value is used in a subsequent request to retrieve the next page by passing it as a value in the `cursor`-query parameter: `cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA`. - To retrieve the next page, the API consumer sends a `GET` request to the endpoint URL with only `?cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA` as query parameter. The limit of items per page and any other query parameters may not be altered and MUST be preserved when requesting subsequent pages. + To retrieve the next page, the API consumer sends a `GET` request to the endpoint URL with `cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA` as query parameter along with the limit of items per page and any other query parameters used in the original request. Filter parameters may not be altered and MUST be preserved when requesting subsequent pages. '400': description: Bad Request headers: diff --git a/ovs/v3/OVS_v3.0.2.yaml b/ovs/v3/OVS_v3.0.2.yaml index 6e0c1aba..481ab68e 100644 --- a/ovs/v3/OVS_v3.0.2.yaml +++ b/ovs/v3/OVS_v3.0.2.yaml @@ -203,11 +203,11 @@ paths: maxLength: 1024 example: fE9mZnNldHw9MTAmbGltaXQ9MTA description: | - The Next-Page-Cursor header contains a cursor value that points to the next page of results in a paginated API response. + The `Next-Page-Cursor` header contains a cursor value that points to the next page of results in a paginated API response. When an initial `GET` endpoint request includes the query parameter `limit=...` the API provider limits the number of items in the root array of the response to the specified limit. If the response would contain more items than the specified limit, the API provider includes only the first set of limit items and appends the following response header: - `Next-Page-Cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA`, a string that acts as a reference for the next page of results. The cursor value is used in subsequent requests to retrieve the next page by passing it as a query parameter: `?cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA`. + `Next-Page-Cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA`, a string that acts as a reference for the next page of results. The `Next-Page-Cursor` value is used in a subsequent request to retrieve the next page by passing it as a value in the `cursor`-query parameter: `cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA`. - To retrieve the next page, the API consumer sends a `GET` request to the endpoint URL with only `?cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA` as query parameter. The limit of items per page and any other query parameters may not be altered, therefore it may also not be specified when requesting subsequent pages. The API provider must ignore any query parameters passed along with a cursor, and should return a `400` error if any other query parameter is passed along with the `cursor`. + To retrieve the next page, the API consumer sends a `GET` request to the endpoint URL with `cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA` as query parameter along with the limit of items per page and any other query parameters used in the original request. Filter parameters may not be altered and MUST be preserved when requesting subsequent pages. content: application/json: schema: From c890ffa448e0d5a980441ed5605b3181a2be79dc Mon Sep 17 00:00:00 2001 From: "henrik.larsen@dcsa.org" Date: Thu, 22 Jan 2026 10:30:01 +0100 Subject: [PATCH 2/2] Revert some text and keep OVS working as previously --- ovs/v3/OVS_v3.0.2.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ovs/v3/OVS_v3.0.2.yaml b/ovs/v3/OVS_v3.0.2.yaml index 481ab68e..aa0cbcef 100644 --- a/ovs/v3/OVS_v3.0.2.yaml +++ b/ovs/v3/OVS_v3.0.2.yaml @@ -207,7 +207,7 @@ paths: When an initial `GET` endpoint request includes the query parameter `limit=...` the API provider limits the number of items in the root array of the response to the specified limit. If the response would contain more items than the specified limit, the API provider includes only the first set of limit items and appends the following response header: `Next-Page-Cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA`, a string that acts as a reference for the next page of results. The `Next-Page-Cursor` value is used in a subsequent request to retrieve the next page by passing it as a value in the `cursor`-query parameter: `cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA`. - To retrieve the next page, the API consumer sends a `GET` request to the endpoint URL with `cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA` as query parameter along with the limit of items per page and any other query parameters used in the original request. Filter parameters may not be altered and MUST be preserved when requesting subsequent pages. + To retrieve the next page, the API consumer sends a `GET` request to the endpoint URL with only `cursor=fE9mZnNldHw9MTAmbGltaXQ9MTA` as query parameter. The limit of items per page and any other query parameters may not be altered, therefore it may also not be specified when requesting subsequent pages. The API provider must ignore any query parameters passed along with a cursor, and should return a `400` error if any other query parameter is passed along with the `cursor`. content: application/json: schema: