From 1e41aadfa37b4ed9485163195c72c98c3208b094 Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Tue, 6 Aug 2024 17:43:45 +0200 Subject: [PATCH] Support OData V2 sap:label and sap:quickinfo (#309) * Bump dependencies, adjust test expectations * 0.28.0 * Update CHANGELOG.md * bump dependencies --- CHANGELOG.md | 6 ++++++ examples/PingTest_V1.no-batch.openapi3.json | 5 +++-- examples/PingTest_V1.openapi3.json | 5 +++-- examples/TitleAndDescription.openapi3.json | 5 +++-- package-lock.json | 12 ++++++------ package.json | 4 ++-- 6 files changed, 23 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9d102b60..00e2f475 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Changelog +## 0.28.0 - 2024-08-06 + +### Added + +- Support [SAP OData V2 annotations](https://github.com/SAP/odata-vocabularies/blob/main/docs/v2-annotations.md#element-edmproperty) `label` and `quickinfo` on properties, and `label` on entity types and parameters + ## 0.27.1 - 2024-08-01 ### Fixed diff --git a/examples/PingTest_V1.no-batch.openapi3.json b/examples/PingTest_V1.no-batch.openapi3.json index fa65cbeb..ff0b6837 100644 --- a/examples/PingTest_V1.no-batch.openapi3.json +++ b/examples/PingTest_V1.no-batch.openapi3.json @@ -90,7 +90,7 @@ "/PingTestSet('{DummyKey}')": { "parameters": [ { - "description": "key: DummyKey", + "description": "Einstelliges Kennzeichen", "in": "path", "name": "DummyKey", "required": true, @@ -156,7 +156,8 @@ "properties": { "DummyKey": { "type": "string", - "maxLength": 1 + "maxLength": 1, + "title": "Einstelliges Kennzeichen" }, "Client": { "type": "string", diff --git a/examples/PingTest_V1.openapi3.json b/examples/PingTest_V1.openapi3.json index b7fa5442..051b3e83 100644 --- a/examples/PingTest_V1.openapi3.json +++ b/examples/PingTest_V1.openapi3.json @@ -90,7 +90,7 @@ "/PingTestSet('{DummyKey}')": { "parameters": [ { - "description": "key: DummyKey", + "description": "Einstelliges Kennzeichen", "in": "path", "name": "DummyKey", "required": true, @@ -193,7 +193,8 @@ "properties": { "DummyKey": { "type": "string", - "maxLength": 1 + "maxLength": 1, + "title": "Einstelliges Kennzeichen" }, "Client": { "type": "string", diff --git a/examples/TitleAndDescription.openapi3.json b/examples/TitleAndDescription.openapi3.json index 27fb24b1..1a88c697 100644 --- a/examples/TitleAndDescription.openapi3.json +++ b/examples/TitleAndDescription.openapi3.json @@ -90,7 +90,7 @@ "/PingTestSet('{DummyKey}')": { "parameters": [ { - "description": "key: DummyKey", + "description": "Einstelliges Kennzeichen", "in": "path", "name": "DummyKey", "required": true, @@ -193,7 +193,8 @@ "properties": { "DummyKey": { "type": "string", - "maxLength": 1 + "maxLength": 1, + "title": "Einstelliges Kennzeichen" }, "Client": { "type": "string", diff --git a/package-lock.json b/package-lock.json index 6d869499..e7135bfa 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,16 +1,16 @@ { "name": "odata-openapi", - "version": "0.27.1", + "version": "0.28.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "odata-openapi", - "version": "0.27.1", + "version": "0.28.0", "license": "SEE LICENSE IN LICENSE.md", "dependencies": { "@discoveryjs/json-ext": "^0.6.0", - "odata-csdl": "^0.10.1" + "odata-csdl": "^0.11.1" }, "bin": { "odata-openapi3": "lib/cli.js" @@ -1785,9 +1785,9 @@ } }, "node_modules/odata-csdl": { - "version": "0.10.1", - "resolved": "https://registry.npmjs.org/odata-csdl/-/odata-csdl-0.10.1.tgz", - "integrity": "sha512-gLYaUFDEO+HlZ8q4ApMjh/aRRDVKLlhT9tv6AO+Umcuy23PUAYTM9WxKVsJpi9a7AO04JBxSMjVrjroAUIY2AA==", + "version": "0.11.1", + "resolved": "https://registry.npmjs.org/odata-csdl/-/odata-csdl-0.11.1.tgz", + "integrity": "sha512-1Ikpy6U2QeJ8O4QhgT0h483zsduvqms2QVHNqLMYVrD+wu6QmdHTyT6nppGVWpCRhgWRqnic9ZIQh29bRjuIEw==", "license": "SEE LICENSE IN LICENSE.md", "dependencies": { "colors": "^1.4.0", diff --git a/package.json b/package.json index ee346675..537fdf2b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "odata-openapi", - "version": "0.27.1", + "version": "0.28.0", "description": "Convert OData CSDL XML or CSDL JSON to OpenAPI", "homepage": "https://github.com/oasis-tcs/odata-openapi/blob/master/lib/README.md", "bugs": "https://github.com/oasis-tcs/odata-openapi/issues", @@ -21,7 +21,7 @@ "exports": "./lib/csdl2openapi.js", "dependencies": { "@discoveryjs/json-ext": "^0.6.0", - "odata-csdl": "^0.10.1" + "odata-csdl": "^0.11.1" }, "devDependencies": { "@apidevtools/openapi-schemas": "^2.1.0",