Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
### Removed
### Fixed
- Entities that are transitively autoexposed and should still be considered readonly, do not generate documentation for write endpoints anymore
- Implicitly auto-exposed composition targets (annotated `@cds.autoexposed` by the CDS compiler) no longer generate top-level GET paths that CAP would reject with 405
### Security

## [1.6.0] - 2026-08-04
Expand Down
7 changes: 5 additions & 2 deletions lib/compile/csdl2openapi.js
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@
* @param {{ url?: string, servers?: object, odataVersion?: string, scheme?: string, host?: string, basePath?: string, diagram?: boolean, maxLevels?: number, shortActionPaths?: boolean }} options Optional parameters
* @return {*} OpenAPI description
*/
module.exports.csdl2openapi = function (

Check warning on line 93 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / Node.js 20

Function has a complexity of 22. Maximum allowed is 15

Check warning on line 93 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / lint

Function has a complexity of 22. Maximum allowed is 15

Check warning on line 93 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / Node.js 24

Function has a complexity of 22. Maximum allowed is 15
csdl,
{
url: serviceRoot,
Expand Down Expand Up @@ -128,6 +128,9 @@
if (csdl[serviceName]?.[type]?.['@cds.autoexpose'] || csdl[serviceName]?.[type]?.['@cds.autoexposed']) {
entityContainer[element]['$cds.autoexpose'] = true;
}
if (csdl[serviceName]?.[type]?.['@cds.autoexposed'] && !csdl[serviceName]?.[type]?.['@cds.autoexpose']) {
entityContainer[element]['$cds.autoexposed'] = true;
}
}
});
}
Expand Down Expand Up @@ -380,7 +383,7 @@
Object.keys(container)
.filter(name => isIdentifier(name) && container[name].$Type)
.forEach(child => {
if (child.endsWith('_texts') && container[child]['$cds.autoexpose']) {
if (container[child]['$cds.autoexposed']) {
return;
}
const type = meta.modelElement(container[child].$Type) || {};
Expand Down Expand Up @@ -425,7 +428,7 @@
const resources = Object.keys(container).filter(name => isIdentifier(name));
resources.forEach(name => {
const child = container[name];
if (name.endsWith('_texts') && child['$cds.autoexpose']) {
if (child['$cds.autoexposed']) {
return;
}
if (child.$Type) {
Expand Down Expand Up @@ -471,7 +474,7 @@
* @param {number} options.level Number of navigation segments so far
* @param {string} options.navigationPath Path for finding navigation restrictions
*/
function pathItems({ paths, prefix, prefixParameters, element, root, sourceName, targetName, target, level, navigationPath }) {

Check warning on line 477 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / Node.js 20

Function 'pathItems' has a complexity of 19. Maximum allowed is 15

Check warning on line 477 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / lint

Function 'pathItems' has a complexity of 19. Maximum allowed is 15

Check warning on line 477 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / Node.js 24

Function 'pathItems' has a complexity of 19. Maximum allowed is 15
const name = prefix.substring(prefix.lastIndexOf('/') + 1);
const type = meta.modelElement(element.$Type);
const pathItem = {};
Expand Down Expand Up @@ -749,7 +752,7 @@
* @param {boolean} options.byKey Read by key
* @param {array} options.nonExpandable Non-expandable navigation properties
*/
function operationRead({ pathItem, element, name, sourceName, targetName, target, level, restrictions, byKey, nonExpandable }) {

Check warning on line 755 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / Node.js 20

Function 'operationRead' has a complexity of 31. Maximum allowed is 15

Check warning on line 755 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / lint

Function 'operationRead' has a complexity of 31. Maximum allowed is 15

Check warning on line 755 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / Node.js 24

Function 'operationRead' has a complexity of 31. Maximum allowed is 15
const targetRestrictions = target?.[meta.voc.Capabilities.ReadRestrictions];
const readRestrictions = restrictions.ReadRestrictions || targetRestrictions || {};
const readByKeyRestrictions = readRestrictions.ReadByKeyRestrictions;
Expand Down Expand Up @@ -1219,7 +1222,7 @@
* @param {*} options.restrictions Navigation property restrictions of navigation segment
* @param {boolean} [options.byKey=false] Update by key
*/
function operationUpdate({ pathItem, element, name, sourceName, target, level, restrictions, byKey = false }) {

Check warning on line 1225 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / Node.js 20

Function 'operationUpdate' has a complexity of 16. Maximum allowed is 15

Check warning on line 1225 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / lint

Function 'operationUpdate' has a complexity of 16. Maximum allowed is 15

Check warning on line 1225 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / Node.js 24

Function 'operationUpdate' has a complexity of 16. Maximum allowed is 15
const updateRestrictions = restrictions.UpdateRestrictions || target?.[meta.voc.Capabilities.UpdateRestrictions] || {};
const countRestrictions = target?.[meta.voc.Capabilities.CountRestrictions]?.Countable === false;
if (updateRestrictions.Updatable !== false && !element[meta.voc.Core.Immutable]) {
Expand Down Expand Up @@ -1310,7 +1313,7 @@
*/
function pathItemsForMediaStream({ paths, prefix, prefixParameters, type, name, sourceName }) {
if (type.$HasStream) {
const mediaTypes = type[meta.voc.Core.AcceptableMediaTypes]?.map(t => t['$EnumMember'] ?? t) ?? [];

Check warning on line 1316 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / Node.js 20

["$EnumMember"] is better written in dot notation

Check warning on line 1316 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / lint

["$EnumMember"] is better written in dot notation

Check warning on line 1316 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / Node.js 24

["$EnumMember"] is better written in dot notation
const contentTypes = mediaTypes.length > 0 ? mediaTypes : ['*/*'];
const mediaContent = Object.fromEntries(contentTypes.map(ct => [ct, { schema: { type: 'string', format: 'binary' } }]));
const lname = splitName(name);
Expand Down Expand Up @@ -1640,7 +1643,7 @@
* @param {string} options.sourceName Name of path source
* @param {*} [options.actionImport={}] Action import
*/
function pathItemAction({ paths, prefix, prefixParameters, actionName, overload, sourceName, actionImport = {} }) {

Check warning on line 1646 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / Node.js 20

Function 'pathItemAction' has a complexity of 18. Maximum allowed is 15

Check warning on line 1646 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / lint

Function 'pathItemAction' has a complexity of 18. Maximum allowed is 15

Check warning on line 1646 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / Node.js 24

Function 'pathItemAction' has a complexity of 18. Maximum allowed is 15
const name = actionName.indexOf('.') === -1 ? actionName : nameParts(actionName).name;
const pathItem = {
post: {
Expand Down Expand Up @@ -1730,7 +1733,7 @@
* @param {string} options.sourceName Name of path source
* @param {*} [options.functionImport={}] Function Import
*/
function pathItemFunction({ paths, prefix, prefixParameters, functionName, overload, sourceName, functionImport = {} }) {

Check warning on line 1736 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / Node.js 20

Function 'pathItemFunction' has a complexity of 16. Maximum allowed is 15

Check warning on line 1736 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / lint

Function 'pathItemFunction' has a complexity of 16. Maximum allowed is 15

Check warning on line 1736 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / Node.js 24

Function 'pathItemFunction' has a complexity of 16. Maximum allowed is 15
const name = functionName.indexOf('.') === -1 ? functionName : nameParts(functionName).name;
let parameters = overload.$Parameter || [];
if (overload.$IsBound) parameters = parameters.slice(1);
Expand All @@ -1739,7 +1742,7 @@

const implicitAliases = csdl.$Version > '4.0' || parameters.some(p => p[meta.voc.Core.OptionalParameter]);

parameters.forEach(p => {

Check warning on line 1745 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / Node.js 20

Arrow function has a complexity of 29. Maximum allowed is 15

Check warning on line 1745 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / lint

Arrow function has a complexity of 29. Maximum allowed is 15

Check warning on line 1745 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / Node.js 24

Arrow function has a complexity of 29. Maximum allowed is 15
const description = getDescriptionWithFallback(p);
/** @type {Parameter} */
const param = {
Expand Down Expand Up @@ -2119,7 +2122,7 @@
* @param {string} options.suffix Suffix for read/create/update
* @return {*} Map of Schemas Objects
*/
function schemasForStructuredType({ schemas, qualifier, name, type, suffix }) {

Check warning on line 2125 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / Node.js 20

Function 'schemasForStructuredType' has a complexity of 18. Maximum allowed is 15

Check warning on line 2125 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / lint

Function 'schemasForStructuredType' has a complexity of 18. Maximum allowed is 15

Check warning on line 2125 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / Node.js 24

Function 'schemasForStructuredType' has a complexity of 18. Maximum allowed is 15
const schemaName = `${qualifier}.${name}${suffix}`;
const baseName = `${qualifier}.${name}`;
const isKey = keyMap(type);
Expand All @@ -2135,7 +2138,7 @@
const properties = propertiesOfStructuredType(type);
const expandRestrictions = type[meta.voc.Capabilities.ExpandRestrictions] ?? {};
const nonExpandableProperties = expandRestrictions.NonExpandableProperties ?? [];
Object.keys(properties).forEach(iName => {

Check warning on line 2141 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / Node.js 20

Arrow function has a complexity of 27. Maximum allowed is 15

Check warning on line 2141 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / lint

Arrow function has a complexity of 27. Maximum allowed is 15

Check warning on line 2141 in lib/compile/csdl2openapi.js

View workflow job for this annotation

GitHub Actions / Node.js 24

Arrow function has a complexity of 27. Maximum allowed is 15
if (nonExpandableProperties.includes(iName)) {
return;
}
Expand Down
18 changes: 17 additions & 1 deletion test/lib/compile/csdl2openapi.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,12 @@ const result12 = require("./data/autoexposed-texts.openapi3.json");
const example13 = require("./data/autoexposed-direct.json");
const result13 = require("./data/autoexposed-direct.openapi3.json");

const example14 = require("./data/autoexposed-composition.json");
const result14 = require("./data/autoexposed-composition.openapi3.json");

const example15 = require("./data/autoexposed-codelist.json");
const result15 = require("./data/autoexposed-codelist.openapi3.json");

describe("Examples", () => {
test("csdl-16.1", () => {
const openapi = lib.csdl2openapi(example1, { diagram: true });
Expand Down Expand Up @@ -108,9 +114,19 @@ describe("Examples", () => {
});

test("autoexposed-direct", () => {
const openapi = lib.csdl2openapi(example13, { url: "https://localhost/service-root" });
const openapi = lib.csdl2openapi(example13);
check(openapi, result13);
});

test("autoexposed-composition", () => {
const openapi = lib.csdl2openapi(example14);
check(openapi, result14);
});

test("autoexposed-codelist", () => {
const openapi = lib.csdl2openapi(example15);
check(openapi, result15);
});
});

describe("Edge cases", () => {
Expand Down
47 changes: 47 additions & 0 deletions test/lib/compile/data/autoexposed-codelist.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{
"$Version": "4.01",
"$EntityContainer": "MyService.EntityContainer",
"$Reference": {},
"MyService": {
"$Kind": "Schema",
"EntityContainer": {
"$Kind": "EntityContainer",
"Orders": {
"$Collection": true,
"$Type": "MyService.Orders",
"$NavigationPropertyBinding": {
"currency": "Currencies"
}
},
"Currencies": {
"$Collection": true,
"$Type": "MyService.Currencies"
}
},
"Orders": {
"$Kind": "EntityType",
"$Key": ["ID"],
"ID": {
"$Type": "Edm.Int32"
},
"currency": {
"$Kind": "NavigationProperty",
"$Type": "MyService.Currencies",
"$Nullable": true
}
},
"Currencies": {
"$Kind": "EntityType",
"$Key": ["code"],
"@cds.autoexpose": true,
"@cds.autoexposed": true,
"code": {
"$MaxLength": 3
},
"name": {
"$Nullable": true,
"$MaxLength": 255
}
}
}
}
Loading
Loading