v1.3.1

Fixed

• Properties marked with @Capabilities.ExpandRestrictions.NonExpandableProperties are now excluded from OpenAPI schemas

Security

v1.3.0

Added

• Util to regenerate OpenAPI test snapshots
• Calling cds compile -2 openapi now emits events: compile.to.openapi with an object parameter, containing the source model and the compilation options before the compilation takes place. after:compile.to.openapi carries the same parameter with an additional result property, containing the output of the compilation process.

Changed

• Operations: @Core.Description maps to summary, @Core.LongDescription maps to description
• Parameters and schema properties: use @Core.LongDescription with fallback to @Core.Description
• Service info: use @Core.LongDescription with fallback to @Core.Description
• Acronyms in names are now preserved and not split in description fields.
• Tags now display with spaces instead of underscores, and camelCase tags are automatically converted to space-separated words (e.g., "camelCase" becomes "camel Case").

Fixed

• Reading json from project root
• Correctly handle @Core.Immutable properties in PATCH requests.
• Actions without parameters now include requestBody with Content-Type: application/json in OpenAPI spec to prevent 415 errors

Version 1.2.3 - 28.05.2025

Added

• Now writes config file path in case of errors.

Changed

• Allow array of objects for @protocol annotation

Fixed

• Properly consume @Capabilities.UpdateRestrictions.UpdateMethod

Version 1.2.2 - 13.05.2025

Fixed

• Properties with @mandatory annotation is now added to required array.

Version 1.2.1 - 11.03.2025

Changed

• Replaced console.warn statements with cds.debug logs for warning messages.

Version 1.2.0 - 28.02.2025

Added

• Now supports @EntityRelationship annotations.

Fixed

• Parameter aliases conflict with system query options.
• Fixed action/function invocation on navigation path to align with CAP runtime.

Version 1.1.2 - 27.01.2025

Added

• Now supports odata-v4 protocol in the @protocol allowed values in CDS along with odata and rest.

Fixed

• Fixed the filename issue: when there is only one service in the CDL source, the OpenAPI document is now generated with the filename corresponding to the service name rather than the CDL source filename.

Version 1.1.1 - 13.12.2024

Fixed

• Fixes server URL based on the version provided by --odata-version value.

Version 1.1.0 - 04.12.2024

Added

• Now supports x-sap extensions using @OpenAPI.Extensions annotations in service, entity and function/action level.

Fixed

• Fixed allowedValues on all primitive types.
• Removed duplicates in tags.
• No longer append protocol and service name information to the server URL incase of openapi:servers option.

Version 1.0.7 - 17.10.2024

Fixed

• Multiple protocols for a service now renders multiple openapi documents.
• Format and type are now preserved for function parameters.
• Fixed allowedValues on all primitive types.

Changed

• Using @title, @Core.Description and @Core.LongDescription for titles and descriptions for improving the default texts in info object and x-sap-shortText.

Added

• OpenAPI documents can now have externalDocs object provided through @OpenAPI.externalDocs annotation in the service level of CDS.
• OpenAPI documents now throws warning if securitySchemas are not found.
• Introduced --openapi:config-file option to incorporate all the options for cds compile command in a JSON configuration file, inline options take precedence over those defined in the configuration file.

Version 1.0.6 - 23.09.2024

Fixed

• Entities annotated with @cds.autoexpose[d] but explicitly exposed in the service are now made read-write.
• Added a wrapper properties object for primitive return types.
• Adding protocol and service name information to the server URL incase of openapi:servers option.

Changed

• Using @title, @Core.Description and @Core.LongDescription for titles and descriptions for improving the default texts in info object and x-sap-shortText.

Version 1.0.5 - 30.07.2024

Changed

• UUID type elements are not going to have the property of required.

Fixed

• properties with @mandatory annotation is not added to required array.

Version 1.0.4 - 14.05.2024

Changed

• Minor changes

Version 1.0.3 - 14.05.2024

Changed

• Removed registering compile target

Version 1.0.2 - 02.05.2024

Fixed

• Bug fixes

Version 1.0.1 - 02.05.2024

Fixed

• Bug fixes

Version 1.0.0 - 02.05.2024

Added

• Initial release

v1.2.3

Added

• Now writes config file path in case of errors.

v1.2.2

Fixed

• Properties with @mandatory annotation is now added to required array.

v1.2.1

Changed

• Replaced console.warn statements with cds.debug logs for warning messages.

v1.2.0

Added

• Now supports @EntityRelationship annotations.

Fixed

• Fixed action/function invocation on navigation path to align with CAP runtime.

v1.1.2

Added

• Now supports odata-v4 protocol in the @protocol allowed values in CDS along with odata and rest.

Fixed

• Fixed the filename issue: when there is only one service in the CDL source, the OpenAPI document is now generated with the filename corresponding to the service name rather than the CDL source filename.

v1.1.1

Fixed

• Fixes server URL based on the version provided by --odata-version value.

v1.1.0

Added

• Now supports x-sap extensions using @OpenAPI.Extensions annotations in service, entity and function/action level.

Fixed

• Fixed allowedValues on all primitive types.
• Removed duplicates in tags.
• No longer append protocol and service name information to the server URL incase of openapi:servers option.

v1.0.7

Fixed

• Multiple protocols for a service now renders multiple openapi documents.
• Format and type are now preserved for function parameters.

Added

• OpenAPI documents can now have externalDocs object provided through @OpenAPI.externalDocs annotation in the service level of CDS.
• OpenAPI documents now throws warning if securitySchemas are not found.