Add navigation property extension (#277)

Author: millicentachieng

src/Microsoft.OpenApi.OData.Reader/Common/Constants.cs

@@ -95,6 +95,11 @@ internal static class Constants
         /// </summary>
         public static string xMsDiscriminatorValue = "x-ms-discriminator-value";
 
+        /// <summary>
+        /// extension for navigation property
+        /// </summary>
+        public static string xMsNavigationProperty = "x-ms-navigationProperty";
+
         /// <summary>
         /// Name used for the OpenAPI referenced schema for OData Count operations responses.
         /// </summary>

src/Microsoft.OpenApi.OData.Reader/Common/Utils.cs

@@ -166,7 +166,7 @@ internal static bool TryAdd<TKey, TValue>(this IDictionary<TKey, TValue> diction
         /// values will be added to.</param>
         /// <param name="context">The OData context.</param>
         /// <param name="element">The target element.</param>
-        internal static void AddCustomAtributesToExtensions(this IDictionary<string, IOpenApiExtension> extensions, ODataContext context, IEdmElement element)
+        internal static void AddCustomAttributesToExtensions(this IDictionary<string, IOpenApiExtension> extensions, ODataContext context, IEdmElement element)
         {
             if (extensions  == null ||
                 context == null ||
@@ -175,7 +175,7 @@ internal static void AddCustomAtributesToExtensions(this IDictionary<string, IOp
                 return;
             }
 
-            Dictionary<string, string> atrributesValueMap = GetCustomXMLAtrributesValueMapping(context.Model, element, context.Settings.CustomXMLAttributesMapping);
+            Dictionary<string, string> atrributesValueMap = GetCustomXMLAttributesValueMapping(context.Model, element, context.Settings.CustomXMLAttributesMapping);
 
             if (atrributesValueMap?.Any() ?? false)
             {
@@ -194,7 +194,7 @@ internal static void AddCustomAtributesToExtensions(this IDictionary<string, IOp
         /// <param name="element">The target element.</param>
         /// <param name="customXMLAttributesMapping">The dictionary mapping of attribute names and extension names.</param>
         /// <returns>A dictionary of extension names mapped to the custom attribute values.</returns>
-        private static Dictionary<string, string> GetCustomXMLAtrributesValueMapping(IEdmModel model, IEdmElement element, Dictionary<string, string> customXMLAttributesMapping)
+        private static Dictionary<string, string> GetCustomXMLAttributesValueMapping(IEdmModel model, IEdmElement element, Dictionary<string, string> customXMLAttributesMapping)
         {
             Dictionary<string, string> atrributesValueMap = new();
 

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

@@ -389,7 +389,7 @@ public static IDictionary<string, OpenApiSchema> CreateStructuredTypePropertiesS
             {
                 OpenApiSchema propertySchema = context.CreatePropertySchema(property);
                 propertySchema.Description = context.Model.GetDescriptionAnnotation(property);
-                propertySchema.Extensions.AddCustomAtributesToExtensions(context, property);
+                propertySchema.Extensions.AddCustomAttributesToExtensions(context, property);
                 properties.Add(property.Name, propertySchema);
             }
 
@@ -398,7 +398,8 @@ public static IDictionary<string, OpenApiSchema> CreateStructuredTypePropertiesS
             {
                 OpenApiSchema propertySchema = context.CreateEdmTypeSchema(property.Type);
                 propertySchema.Description = context.Model.GetDescriptionAnnotation(property);
-                propertySchema.Extensions.AddCustomAtributesToExtensions(context, property);
+                propertySchema.Extensions.AddCustomAttributesToExtensions(context, property);
+                propertySchema.Extensions.Add(Constants.xMsNavigationProperty, new OpenApiBoolean(true));
                 properties.Add(property.Name, propertySchema);
             }
 

src/Microsoft.OpenApi.OData.Reader/PathItem/ComplexPropertyItemHandler.cs

@@ -70,6 +70,6 @@ protected override void Initialize(ODataContext context, ODataPath path)
 	/// <inheritdoc/>
 	protected override void SetExtensions(OpenApiPathItem item)
 	{
-		item.Extensions.AddCustomAtributesToExtensions(Context, ComplexProperty);
+		item.Extensions.AddCustomAttributesToExtensions(Context, ComplexProperty);
 	}
 }

src/Microsoft.OpenApi.OData.Reader/PathItem/EntityPathItemHandler.cs

@@ -55,7 +55,7 @@ protected override void SetOperations(OpenApiPathItem item)
         protected override void SetExtensions(OpenApiPathItem pathItem)
         {
             base.SetExtensions(pathItem);
-            pathItem.Extensions.AddCustomAtributesToExtensions(Context, EntitySet.EntityType());
+            pathItem.Extensions.AddCustomAttributesToExtensions(Context, EntitySet.EntityType());
         }
     }
 }

src/Microsoft.OpenApi.OData.Reader/PathItem/EntitySetPathItemHandler.cs

@@ -60,7 +60,7 @@ protected override void SetBasicInfo(OpenApiPathItem pathItem)
         protected override void SetExtensions(OpenApiPathItem pathItem)
         {
             base.SetExtensions(pathItem);
-            pathItem.Extensions.AddCustomAtributesToExtensions(Context, EntitySet);            
+            pathItem.Extensions.AddCustomAttributesToExtensions(Context, EntitySet);            
         }
     }
 }

src/Microsoft.OpenApi.OData.Reader/PathItem/NavigationPropertyPathItemHandler.cs

@@ -266,7 +266,7 @@ protected override void SetExtensions(OpenApiPathItem item)
             }
 
             base.SetExtensions(item);
-            item.Extensions.AddCustomAtributesToExtensions(Context, NavigationProperty);
+            item.Extensions.AddCustomAttributesToExtensions(Context, NavigationProperty);
         }
         /// <inheritdoc/>
         protected override void SetBasicInfo(OpenApiPathItem pathItem)

src/Microsoft.OpenApi.OData.Reader/PathItem/ODataTypeCastPathItemHandler.cs

@@ -45,6 +45,6 @@ protected override void SetBasicInfo(OpenApiPathItem pathItem)
     protected override void SetExtensions(OpenApiPathItem pathItem)
     {
         base.SetExtensions(pathItem);
-        pathItem.Extensions.AddCustomAtributesToExtensions(Context, StructuredType);
+        pathItem.Extensions.AddCustomAttributesToExtensions(Context, StructuredType);
     }
 }

src/Microsoft.OpenApi.OData.Reader/PathItem/OperationImportPathItemHandler.cs

@@ -71,7 +71,7 @@ protected override void SetBasicInfo(OpenApiPathItem pathItem)
         protected override void SetExtensions(OpenApiPathItem item)
         {
             base.SetExtensions(item);
-            item.Extensions.AddCustomAtributesToExtensions(Context, EdmOperationImport);
+            item.Extensions.AddCustomAttributesToExtensions(Context, EdmOperationImport);
         }
     }
 }

src/Microsoft.OpenApi.OData.Reader/PathItem/OperationPathItemHandler.cs

@@ -95,7 +95,7 @@ protected override void SetExtensions(OpenApiPathItem item)
             }
 
             base.SetExtensions(item);
-            item.Extensions.AddCustomAtributesToExtensions(Context, EdmOperation);            
+            item.Extensions.AddCustomAttributesToExtensions(Context, EdmOperation);            
         }
 
         /// <inheritdoc/>