Skip to content

fix: Fix $skiptoken again #209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
daogrady wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix: Fix $skiptoken again #209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/compile/csdl.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ const CDS_TERMS = Object.freeze({
Authorization: ['Authorizations', 'SecuritySchemes'],
Capabilities: ['BatchSupport', 'BatchSupported', 'ChangeTracking', 'CountRestrictions', 'DeleteRestrictions', 'DeepUpdateSupport', 'ExpandRestrictions',
'FilterRestrictions', 'IndexableByKey', 'InsertRestrictions', 'KeyAsSegmentSupported', 'NavigationRestrictions', 'OperationRestrictions',
'ReadRestrictions', 'SearchRestrictions', 'SelectSupport', 'SkipSupported', 'SortRestrictions', 'TopSupported', 'UpdateRestrictions'],
'ReadRestrictions', 'SearchRestrictions', 'SelectSupport', 'SkipSupported', 'SkipTokenSupported', 'SortRestrictions', 'TopSupported', 'UpdateRestrictions'],
Core: ['AcceptableMediaTypes', 'Computed', 'ComputedDefaultValue', 'DefaultNamespace', 'Description', 'Example', 'Immutable', 'LongDescription',
'MediaType', 'OptionalParameter', 'Permissions', 'SchemaVersion'],
JSON: ['Schema'],
Expand Down
27 changes: 27 additions & 0 deletions lib/compile/csdl2openapi.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -856,6 +856,7 @@ module.exports.csdl2openapi = function (
if (collection) {
optionTop(operation.parameters, target, restrictions);
optionSkip(operation.parameters, target, restrictions);
if (isODataProtocol(protocol)) optionSkipToken(operation.parameters, target, restrictions);
if (csdl.$Version >= '4.0') optionSearch(operation.parameters, target, restrictions);
optionFilter(operation.parameters, target, restrictions);
optionCount(operation.parameters, target);
Expand Down Expand Up @@ -1332,6 +1333,24 @@ see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-prot
}
}

/**
* Add parameter for query option $skiptoken
* @param {Array} parameters Array of parameters to augment
* @param {null | TargetRestrictions} target Target container child of path
* @param {*} restrictions Navigation property restrictions of navigation segment
*/
function optionSkipToken(parameters, target, restrictions) {
const supported = restrictions.SkipTokenSupported !== undefined
? restrictions.SkipTokenSupported
: target == null || target?.[meta.voc.Capabilities.SkipTokenSupported] !== false;

if (supported) {
parameters.push({
$ref: '#/components/parameters/skiptoken'
});
}
}

/**
* Add parameter for query option $top
* @param {Array} parameters Array of parameters to augment
Expand Down Expand Up @@ -2509,6 +2528,14 @@ see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-prot
minimum: 0
}
},
skiptoken: {
name: `${queryOptionPrefix}skiptoken`,
in: 'query',
description: 'Continuation token for server-driven paging, see [Server-driven Paging](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_ServerDrivenPaging)',
schema: {
type: 'string'
}
},
count: {
name: `${queryOptionPrefix}count`,
in: 'query',
Expand Down
8 changes: 7 additions & 1 deletion test/lib/compile/csdl2openapi.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -642,7 +642,7 @@ describe("Edge cases", () => {

const openapi = lib.csdl2openapi(csdl, {});
assert.deepStrictEqual(
openapi.paths["/sources"].get.parameters[5],
openapi.paths["/sources"].get.parameters[6],
expected_sources_get_param
);
});
Expand Down Expand Up @@ -1400,6 +1400,7 @@ describe("Edge cases", () => {
parameters: [
{ $ref: "#/components/parameters/top" },
{ $ref: "#/components/parameters/skip" },
{ $ref: "#/components/parameters/skiptoken" },
{ $ref: "#/components/parameters/search" },
{
in: "query",
Expand Down Expand Up @@ -1587,6 +1588,7 @@ describe("Edge cases", () => {
parameters: [
{ $ref: "#/components/parameters/top" },
{ $ref: "#/components/parameters/skip" },
{ $ref: "#/components/parameters/skiptoken" },
{ $ref: "#/components/parameters/search" },
{
in: "query",
Expand Down Expand Up @@ -1785,6 +1787,7 @@ see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-prot
parameters: [
{ $ref: "#/components/parameters/top" },
{ $ref: "#/components/parameters/skip" },
{ $ref: "#/components/parameters/skiptoken" },
{ $ref: "#/components/parameters/search" },
{
in: "query",
Expand Down Expand Up @@ -1973,6 +1976,7 @@ see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-prot
parameters: [
{ $ref: "#/components/parameters/top" },
{ $ref: "#/components/parameters/skip" },
{ $ref: "#/components/parameters/skiptoken" },
{ $ref: "#/components/parameters/search" },
{
in: "query",
Expand Down Expand Up @@ -2168,6 +2172,7 @@ see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-prot
parameters: [
{ $ref: "#/components/parameters/top" },
{ $ref: "#/components/parameters/skip" },
{ $ref: "#/components/parameters/skiptoken" },
{
in: "query",
name: "$search",
Expand Down Expand Up @@ -3501,6 +3506,7 @@ describe("CAP / CS01", () => {
parameters: [
{ $ref: "#/components/parameters/top" },
{ $ref: "#/components/parameters/skip" },
{ $ref: "#/components/parameters/skiptoken" },
{ $ref: "#/components/parameters/search" },
{
in: "query",
Expand Down
Loading
Loading