Merge pull request #156 from microsoft/bugfix/path-items-descriptions

adds descriptions for path items

Author: baywet

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

@@ -21,5 +21,11 @@ protected override void SetOperations(OpenApiPathItem item)
         {
             AddOperation(item, OperationType.Get);
         }
+        /// <inheritdoc/>
+        protected override void SetBasicInfo(OpenApiPathItem pathItem)
+        {
+            base.SetBasicInfo(pathItem);
+            pathItem.Description = "Provides operations to count the resources in the collection.";
+        }
     }
 }

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

@@ -48,5 +48,11 @@ protected override void Initialize(ODataContext context, ODataPath path)
             ODataNavigationSourceSegment navigationSourceSegment = path.FirstSegment as ODataNavigationSourceSegment;
             EntitySet = navigationSourceSegment.NavigationSource as IEdmEntitySet;
         }
+        /// <inheritdoc/>
+        protected override void SetBasicInfo(OpenApiPathItem pathItem)
+        {
+            base.SetBasicInfo(pathItem);
+            pathItem.Description = $"Provides operations to manage the collection of {EntitySet.EntityType().Name} entities.";
+        }
     }
 }

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

@@ -66,5 +66,11 @@ protected override void Initialize(ODataContext context, ODataPath path)
                 Singleton = navigationSourceSegment.NavigationSource as IEdmSingleton;
             }
         }
+        /// <inheritdoc/>
+        protected override void SetBasicInfo(OpenApiPathItem pathItem)
+        {
+            base.SetBasicInfo(pathItem);
+            pathItem.Description = $"Provides operations to manage the media for the {(EntitySet?.EntityType() ?? Singleton?.EntityType()).Name} entity.";
+        }
     }
 }

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

@@ -21,5 +21,11 @@ protected override void SetOperations(OpenApiPathItem item)
         {
             AddOperation(item, OperationType.Get);
         }
+        /// <inheritdoc/>
+        protected override void SetBasicInfo(OpenApiPathItem pathItem)
+        {
+            base.SetBasicInfo(pathItem);
+            pathItem.Description = "Provides operations to obtain the service metadata.";
+        }
     }
 }

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

@@ -246,5 +246,11 @@ protected override void SetExtensions(OpenApiPathItem item)
                 item.Extensions.Add(Constants.xMsDosGroupPath, array);
             }
         }
+        /// <inheritdoc/>
+        protected override void SetBasicInfo(OpenApiPathItem pathItem)
+        {
+            base.SetBasicInfo(pathItem);
+            pathItem.Description = $"Provides operations to manage the {NavigationProperty.Name} property of the {NavigationProperty.DeclaringType.FullTypeName()} entity.";
+        }
     }
 }

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

@@ -58,5 +58,11 @@ protected override void Initialize(ODataContext context, ODataPath path)
             ODataOperationImportSegment operationImportSegment = path.FirstSegment as ODataOperationImportSegment;
             EdmOperationImport = operationImportSegment.OperationImport;
         }
+        /// <inheritdoc/>
+        protected override void SetBasicInfo(OpenApiPathItem pathItem)
+        {
+            base.SetBasicInfo(pathItem);
+            pathItem.Description = $"Provides operations to call the {EdmOperationImport.Name} method.";
+        }
     }
 }

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

@@ -94,5 +94,11 @@ protected override void SetExtensions(OpenApiPathItem item)
                 item.Extensions.Add(Constants.xMsDosGroupPath, array);
             }
         }
+        /// <inheritdoc/>
+        protected override void SetBasicInfo(OpenApiPathItem pathItem)
+        {
+            base.SetBasicInfo(pathItem);
+            pathItem.Description = $"Provides operations to call the {EdmOperation.Name} method.";
+        }
     }
 }

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

@@ -41,14 +41,22 @@ public virtual OpenApiPathItem CreatePathItem(ODataContext context, ODataPath pa
 
             Initialize(context, path);
 
-            OpenApiPathItem item = new OpenApiPathItem();
+            OpenApiPathItem item = new();
+
+            SetBasicInfo(item);
 
             SetOperations(item);
 
             SetExtensions(item);
 
             return item;
         }
+        /// <summary>
+        /// Set the basic information for <see cref="OpenApiPathItem"/>.
+        /// </summary>
+        /// <param name="pathItem">The <see cref="OpenApiPathItem"/>.</param>
+        protected virtual void SetBasicInfo(OpenApiPathItem pathItem)
+        { }
 
         /// <summary>
         /// Set the operation for the path item.

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

@@ -137,5 +137,11 @@ protected override void Initialize(ODataContext context, ODataPath path)
 
             NavigationProperty = path.OfType<ODataNavigationPropertySegment>().Last().NavigationProperty;
         }
+        /// <inheritdoc/>
+        protected override void SetBasicInfo(OpenApiPathItem pathItem)
+        {
+            base.SetBasicInfo(pathItem);
+            pathItem.Description = $"Provides operations to manage the collection of {NavigationSource?.EntityType().Name ?? NavigationProperty?.Type.ShortQualifiedName()} entities.";
+        }
     }
 }

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

@@ -49,5 +49,11 @@ protected override void Initialize(ODataContext context, ODataPath path)
             ODataNavigationSourceSegment navigationSourceSegment = path.FirstSegment as ODataNavigationSourceSegment;
             Singleton = navigationSourceSegment.NavigationSource as IEdmSingleton;
         }
+        /// <inheritdoc/>
+        protected override void SetBasicInfo(OpenApiPathItem pathItem)
+        {
+            base.SetBasicInfo(pathItem);
+            pathItem.Description = $"Provides operations to manage the {Singleton.EntityType().Name} singleton.";
+        }
     }
 }