Core.ComputedDefaultValue (#266)

* 0.24.0
* ComputedDefaultValue
* refactor tests
* Update Annotations.md

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [0.24.0] - 2023-11-07
+
+### Added
+
+- Core.ComputedDefaultValue means property is not required on create
+
 ## [0.23.4] - 2023-08-16
 
 ### Fixed

doc/Annotations.md

@@ -10,6 +10,7 @@ See [Frequently Asked Questions](FAQ.md) for examples on how to use these annota
 Term | Annotation Target | OpenAPI field
 -----|-------------------|--------------
 `Computed` | Property | omit from Create and Update structures
+`ComputedDefaultValue` | Property | omit from required properties if key
 `DefaultNamespace` | Schema | path templates for actions and functions without namespace prefix
 `Description` | Action, ActionImport, Function, FunctionImport | `summary` of Operation Object
 `Description` | EntitySet, Singleton | `description` of Tag Object

lib/csdl2openapi.js

@@ -2162,10 +2162,7 @@ module.exports.csdl2openapi = function (
             ] = ref("count");
           }
         }
-        if (
-          property[voc.Core.Permissions] != "Read" &&
-          !property[voc.Core.Computed]
-        ) {
+        if (property[voc.Core.Permissions] != "Read") {
           if (property.$ContainsTarget) {
             if (suffix === SUFFIX.create)
               schemaProperties[name] = schema(property, SUFFIX.create);
@@ -2186,20 +2183,26 @@ module.exports.csdl2openapi = function (
       } else {
         if (
           property[voc.Core.Permissions] == "Read" ||
-          property[voc.Core.Computed]
+          property[voc.Core.Computed] ||
+          property[voc.Core.ComputedDefaultValue]
         ) {
           let index = required.indexOf(name);
           if (index != -1) required.splice(index, 1);
-        } else {
-          if (suffix === SUFFIX.create)
-            schemaProperties[name] = schema(property, SUFFIX.create);
-          if (
-            suffix === SUFFIX.update &&
-            !isKey[name] &&
-            !property[voc.Core.Immutable]
-          )
-            schemaProperties[name] = schema(property, SUFFIX.update);
         }
+        if (
+          property[voc.Core.Permissions] == "Read" ||
+          property[voc.Core.Computed]
+        )
+          continue;
+
+        if (suffix === SUFFIX.create)
+          schemaProperties[name] = schema(property, SUFFIX.create);
+        if (
+          suffix === SUFFIX.update &&
+          !isKey[name] &&
+          !property[voc.Core.Immutable]
+        )
+          schemaProperties[name] = schema(property, SUFFIX.update);
       }
     }
 

lib/edm.js

@@ -344,6 +344,7 @@ function vocabularies(voc, alias) {
     Core: [
       "AcceptableMediaTypes",
       "Computed",
+      "ComputedDefaultValue",
       "DefaultNamespace",
       "Description",
       "Example",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "odata-openapi",
-  "version": "0.23.4",
+  "version": "0.24.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",