Support OData V2 sap:label and sap:quickinfo (#309)

* Bump dependencies, adjust test expectations * 0.28.0 * Update CHANGELOG.md * bump dependencies
oasis-tcs · Aug 6, 2024 · 1e41aad · 1e41aad
1 parent 9ea8e2b
commit 1e41aad
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 14 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
diff --git 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",