Use Computed annotation in the CSDL to declare property as ReadOnly (#273)

* Use Computed annotation in the CSDL to set property as readonly

* Add tests

* Add release notes

* Remove unnecessary assignment of read-only attribute to property

Author: millicentachieng

src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiSchemaGenerator.cs

@@ -16,6 +16,7 @@
 using System.Linq;
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.OData.OpenApiExtensions;
+using Microsoft.OpenApi.OData.Vocabulary.Core;
 
 namespace Microsoft.OpenApi.OData.Generator
 {
@@ -363,6 +364,9 @@ public static OpenApiSchema CreatePropertySchema(this ODataContext context, IEdm
             // whose value is the value of the unqualified annotation Core.Description of the property.
             schema.Description = context.Model.GetDescriptionAnnotation(property);
 
+            // Set property with Computed Annotation in CSDL to readonly
+            schema.ReadOnly = context.Model.GetBoolean(property, CoreConstants.Computed) ?? false;
+
             return schema;
         }
 

src/Microsoft.OpenApi.OData.Reader/Microsoft.OpenAPI.OData.Reader.csproj

@@ -22,6 +22,7 @@
     <RepositoryUrl>https://github.com/Microsoft/OpenAPI.NET.OData</RepositoryUrl>
     <PackageReleaseNotes>
 - Fixes response schemas of actions and functions that return a collection to contain the nextLink property #231
+- Use Computed annotation in the CSDL to declare property as ReadOnly #254
 - Fixes duplicated actions/functions request body/response schemas #241
     </PackageReleaseNotes>
     <AssemblyName>Microsoft.OpenApi.OData.Reader</AssemblyName>

src/Microsoft.OpenApi.OData.Reader/Operation/EntitySetPostOperationHandler.cs

@@ -11,6 +11,7 @@
 using Microsoft.OpenApi.OData.Edm;
 using Microsoft.OpenApi.OData.Generator;
 using Microsoft.OpenApi.OData.Vocabulary.Capabilities;
+using Microsoft.OpenApi.OData.Vocabulary.Core;
 
 namespace Microsoft.OpenApi.OData.Operation
 {
@@ -124,7 +125,7 @@ private IDictionary<string, OpenApiMediaType> GetContentDescription()
             if (EntitySet.EntityType().HasStream)
             {
                 IEnumerable<string> mediaTypes = Context.Model.GetCollection(EntitySet.EntityType(),
-                    CapabilitiesConstants.AcceptableMediaTypes);
+                    CoreConstants.AcceptableMediaTypes);
 
                 if (mediaTypes != null)
                 {

src/Microsoft.OpenApi.OData.Reader/Operation/MediaEntityOperationalHandler.cs

@@ -9,7 +9,6 @@
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.OData.Common;
 using Microsoft.OpenApi.OData.Edm;
-using Microsoft.OpenApi.OData.Vocabulary.Capabilities;
 using Microsoft.OpenApi.OData.Vocabulary.Core;
 using System.Collections.Generic;
 using System.Linq;
@@ -151,7 +150,7 @@ protected IDictionary<string, OpenApiMediaType> GetContentDescription()
             if (annotatableElement != null)
             {
                 mediaTypes = Context.Model.GetCollection(annotatableElement,
-                    CapabilitiesConstants.AcceptableMediaTypes);
+                    CoreConstants.AcceptableMediaTypes);
             }
 
             if (mediaTypes != null)

src/Microsoft.OpenApi.OData.Reader/Vocabulary/Capabilities/CapabilitiesConstants.cs

@@ -94,10 +94,5 @@ internal class CapabilitiesConstants
         /// Org.OData.Capabilities.V1.KeyAsSegmentSupported
         /// </summary>
         public const string KeyAsSegmentSupported = "Org.OData.Capabilities.V1.KeyAsSegmentSupported";
-
-        /// <summary>
-        /// Org.OData.Core.V1.AcceptableMediaTypes
-        /// </summary>
-        public const string AcceptableMediaTypes = "Org.OData.Core.V1.AcceptableMediaTypes";
     }
 }

src/Microsoft.OpenApi.OData.Reader/Vocabulary/Core/CoreConstants.cs

@@ -20,6 +20,16 @@ internal static class CoreConstants
         /// </summary>
         public const string Revisions = "Org.OData.Core.V1.Revisions";
 
+        /// <summary>
+        /// Org.OData.Core.V1.AcceptableMediaTypes
+        /// </summary>
+        public const string AcceptableMediaTypes = "Org.OData.Core.V1.AcceptableMediaTypes";
+
+        /// <summary>
+        /// Org.OData.Core.V1.Computed
+        /// </summary>
+        public const string Computed = "Org.OData.Core.V1.Computed";
+
         /// <summary>
         /// External docs description.
         /// </summary>

test/Microsoft.OpenAPI.OData.Reader.Tests/Generator/OpenApiSchemaGeneratorTests.cs

@@ -803,6 +803,46 @@ public void CreatePropertySchemaForNullableEnumPropertyReturnSchema(OpenApiSpecV
 }".ChangeLineBreaks(), json);
             }
         }
+
+        [Theory]
+        [InlineData(OpenApiSpecVersion.OpenApi3_0)]
+        [InlineData(OpenApiSpecVersion.OpenApi2_0)]
+        public void CreatePropertySchemaWithComputedAnnotationReturnsCorrectSchema(OpenApiSpecVersion specVersion)
+        {
+            // Arrange
+            IEdmModel model = EdmModelHelper.GraphBetaModel;
+            ODataContext context = new(model);
+
+            context.Settings.OpenApiSpecVersion = specVersion;
+
+            IEdmEntityType entityType = model.SchemaElements.OfType<IEdmEntityType>().First(e => e.Name == "bookingAppointment");
+            IEdmProperty property = entityType.Properties().FirstOrDefault(x => x.Name == "duration");
+
+            // Act
+            var schema = context.CreatePropertySchema(property);
+            Assert.NotNull(schema);
+            string json = schema.SerializeAsJson(specVersion);
+
+            // Assert
+            if (specVersion == OpenApiSpecVersion.OpenApi2_0)
+            {
+                Assert.Equal(@"{
+  ""format"": ""duration"",
+  ""pattern"": ""^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$"",
+  ""type"": ""string"",
+  ""readOnly"": true
+}".ChangeLineBreaks(), json);    
+            }
+            else
+            {
+                Assert.Equal(@"{
+  ""pattern"": ""^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$"",
+  ""type"": ""string"",
+  ""format"": ""duration"",
+  ""readOnly"": true
+}".ChangeLineBreaks(), json);
+            }
+        }
         #endregion
 
         #region BaseTypeToDerivedTypesSchema

test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/EntitySetPostOperationHandlerTests.cs

@@ -10,7 +10,7 @@
 using Microsoft.OpenApi.OData.Common;
 using Microsoft.OpenApi.OData.Edm;
 using Microsoft.OpenApi.OData.Tests;
-using Microsoft.OpenApi.OData.Vocabulary.Capabilities;
+using Microsoft.OpenApi.OData.Vocabulary.Core;
 using System.Xml.Linq;
 using Xunit;
 
@@ -28,7 +28,7 @@ public class EntitySetPostOperationHandlerTests
         public void CreateEntitySetPostOperationReturnsCorrectOperation(bool enableOperationId, bool hasStream, bool useHTTPStatusCodeClass2XX)
         {
             // Arrange
-            string qualifiedName = CapabilitiesConstants.AcceptableMediaTypes;
+            string qualifiedName = CoreConstants.AcceptableMediaTypes;
             string annotation = $@"
             <Annotation Term=""{qualifiedName}"" >
               <Collection>

test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/MediaEntityGetOperationHandlerTests.cs

@@ -7,7 +7,7 @@
 using Microsoft.OData.Edm.Csdl;
 using Microsoft.OpenApi.OData.Common;
 using Microsoft.OpenApi.OData.Edm;
-using Microsoft.OpenApi.OData.Vocabulary.Capabilities;
+using Microsoft.OpenApi.OData.Vocabulary.Core;
 using System.Linq;
 using System.Xml.Linq;
 using Xunit;
@@ -26,7 +26,7 @@ public class MediaEntityGetOperationHandlerTests
         public void CreateMediaEntityGetOperationReturnsCorrectOperation(bool enableOperationId, bool useHTTPStatusCodeClass2XX)
         {
             // Arrange
-            string qualifiedName = CapabilitiesConstants.AcceptableMediaTypes;
+            string qualifiedName = CoreConstants.AcceptableMediaTypes;
             string annotation = $@"
             <Annotation Term=""{qualifiedName}"" >
               <Collection>

test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/MediaEntityPutOperationHandlerTests.cs

@@ -6,7 +6,7 @@
 using Microsoft.OData.Edm;
 using Microsoft.OpenApi.OData.Common;
 using Microsoft.OpenApi.OData.Edm;
-using Microsoft.OpenApi.OData.Vocabulary.Capabilities;
+using Microsoft.OpenApi.OData.Vocabulary.Core;
 using System.Linq;
 using Xunit;
 
@@ -22,7 +22,7 @@ public class MediaEntityPutOperationHandlerTests
         public void CreateMediaEntityPutOperationReturnsCorrectOperation(bool enableOperationId)
         {
             // Arrange
-            string qualifiedName = CapabilitiesConstants.AcceptableMediaTypes;
+            string qualifiedName = CoreConstants.AcceptableMediaTypes;
             string annotation = $@"
             <Annotation Term=""{qualifiedName}"" >
               <Collection>