Merge pull request #155 from microsoft/feature/deprecated

adds support for deprecation

Author: baywet

src/Microsoft.OpenApi.OData.Reader/Edm/ODataContext.cs

@@ -6,12 +6,14 @@
 using System.Collections.Generic;
 using System.Linq;
 using Microsoft.OData.Edm;
+using Microsoft.OData.Edm.Vocabularies;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.OData.Common;
 using Microsoft.OpenApi.OData.Generator;
 using Microsoft.OpenApi.OData.Operation;
 using Microsoft.OpenApi.OData.PathItem;
 using Microsoft.OpenApi.OData.Vocabulary.Capabilities;
+using Microsoft.OpenApi.OData.Vocabulary.Core;
 
 namespace Microsoft.OpenApi.OData.Edm
 {
@@ -171,5 +173,12 @@ private IEnumerable<ODataPath> LoadAllODataPaths()
                 yield return path;
             }
         }
+        internal IEnumerable<DeprecatedRevisionsType> GetDeprecationInformations(IEdmVocabularyAnnotatable annotable)
+        {
+            return annotable == null ?
+                Enumerable.Empty<DeprecatedRevisionsType>() :
+                    (Model?.GetCollection<DeprecatedRevisionsType>(annotable, "Org.OData.Core.V1.Revisions") ?? 
+                    Enumerable.Empty<DeprecatedRevisionsType>());
+        }
     }
 }

src/Microsoft.OpenApi.OData.Reader/Edm/ODataDollarCountSegment.cs

@@ -4,6 +4,8 @@
 // ------------------------------------------------------------
 
 using System.Collections.Generic;
+using System.Linq;
+using Microsoft.OData.Edm.Vocabularies;
 
 namespace Microsoft.OpenApi.OData.Edm
 {
@@ -24,6 +26,12 @@ public class ODataDollarCountSegment : ODataSegment
         public override string Identifier => "$count";
 
         /// <inheritdoc />
-        public override string GetPathItemName(OpenApiConvertSettings settings, HashSet<string> parameters) => "$count";
+		public override IEnumerable<IEdmVocabularyAnnotatable> GetAnnotables()
+		{
+			return Enumerable.Empty<IEdmVocabularyAnnotatable>();
+		}
+
+		/// <inheritdoc />
+		public override string GetPathItemName(OpenApiConvertSettings settings, HashSet<string> parameters) => "$count";
     }
 }

src/Microsoft.OpenApi.OData.Reader/Edm/ODataKeySegment.cs

@@ -7,6 +7,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using Microsoft.OData.Edm;
+using Microsoft.OData.Edm.Vocabularies;
 using Microsoft.OpenApi.OData.Common;
 
 namespace Microsoft.OpenApi.OData.Edm
@@ -63,7 +64,13 @@ public override string Identifier
         }
 
         /// <inheritdoc />
-        public override string GetPathItemName(OpenApiConvertSettings settings, HashSet<string> parameters)
+		public override IEnumerable<IEdmVocabularyAnnotatable> GetAnnotables()
+		{
+			return Enumerable.Empty<IEdmVocabularyAnnotatable>();
+		}
+
+		/// <inheritdoc />
+		public override string GetPathItemName(OpenApiConvertSettings settings, HashSet<string> parameters)
         {
             Utils.CheckArgumentNull(settings, nameof(settings));
 

src/Microsoft.OpenApi.OData.Reader/Edm/ODataMetadataSegment.cs

@@ -4,6 +4,8 @@
 // ------------------------------------------------------------
 
 using System.Collections.Generic;
+using System.Linq;
+using Microsoft.OData.Edm.Vocabularies;
 
 namespace Microsoft.OpenApi.OData.Edm
 {
@@ -19,6 +21,12 @@ public class ODataMetadataSegment : ODataSegment
         public override string Identifier => "$metadata";
 
         /// <inheritdoc />
-        public override string GetPathItemName(OpenApiConvertSettings settings, HashSet<string> parameters) => "$metadata";
+		public override IEnumerable<IEdmVocabularyAnnotatable> GetAnnotables()
+		{
+			return Enumerable.Empty<IEdmVocabularyAnnotatable>();
+		}
+
+		/// <inheritdoc />
+		public override string GetPathItemName(OpenApiConvertSettings settings, HashSet<string> parameters) => "$metadata";
     }
 }

src/Microsoft.OpenApi.OData.Reader/Edm/ODataNavigationPropertySegment.cs

@@ -4,7 +4,9 @@
 // ------------------------------------------------------------
 
 using System.Collections.Generic;
+using System.Linq;
 using Microsoft.OData.Edm;
+using Microsoft.OData.Edm.Vocabularies;
 using Microsoft.OpenApi.OData.Common;
 
 namespace Microsoft.OpenApi.OData.Edm
@@ -38,6 +40,12 @@ public ODataNavigationPropertySegment(IEdmNavigationProperty navigationProperty)
         public override string Identifier { get => NavigationProperty.Name; }
 
         /// <inheritdoc />
-        public override string GetPathItemName(OpenApiConvertSettings settings, HashSet<string> parameters) => NavigationProperty.Name;
+		public override IEnumerable<IEdmVocabularyAnnotatable> GetAnnotables()
+		{
+			return new IEdmVocabularyAnnotatable[] { NavigationProperty, EntityType }.Union(EntityType.FindAllBaseTypes());
+		}
+
+		/// <inheritdoc />
+		public override string GetPathItemName(OpenApiConvertSettings settings, HashSet<string> parameters) => NavigationProperty.Name;
     }
 }

src/Microsoft.OpenApi.OData.Reader/Edm/ODataNavigationSourceSegment.cs

@@ -4,7 +4,9 @@
 // ------------------------------------------------------------
 
 using System.Collections.Generic;
+using System.Linq;
 using Microsoft.OData.Edm;
+using Microsoft.OData.Edm.Vocabularies;
 using Microsoft.OpenApi.OData.Common;
 
 namespace Microsoft.OpenApi.OData.Edm
@@ -38,6 +40,12 @@ public ODataNavigationSourceSegment(IEdmNavigationSource navigationSource)
         public override ODataSegmentKind Kind => ODataSegmentKind.NavigationSource;
 
         /// <inheritdoc />
-        public override string GetPathItemName(OpenApiConvertSettings settings, HashSet<string> parameters) => NavigationSource.Name;
+		public override IEnumerable<IEdmVocabularyAnnotatable> GetAnnotables()
+		{
+			return new IEdmVocabularyAnnotatable[] { NavigationSource as IEdmVocabularyAnnotatable, EntityType }.Union(EntityType.FindAllBaseTypes());
+		}
+
+		/// <inheritdoc />
+		public override string GetPathItemName(OpenApiConvertSettings settings, HashSet<string> parameters) => NavigationSource.Name;
     }
 }

src/Microsoft.OpenApi.OData.Reader/Edm/ODataOperationImportSegment.cs

@@ -8,6 +8,7 @@
 using System.Linq;
 using System.Text;
 using Microsoft.OData.Edm;
+using Microsoft.OData.Edm.Vocabularies;
 using Microsoft.OpenApi.OData.Common;
 
 namespace Microsoft.OpenApi.OData.Edm
@@ -54,7 +55,13 @@ public ODataOperationImportSegment(IEdmOperationImport operationImport, IDiction
         public override string Identifier { get => OperationImport.Name; }
 
         /// <inheritdoc />
-        public override string GetPathItemName(OpenApiConvertSettings settings, HashSet<string> parameters)
+		public override IEnumerable<IEdmVocabularyAnnotatable> GetAnnotables()
+		{
+			return new IEdmVocabularyAnnotatable[] { OperationImport };
+		}
+
+		/// <inheritdoc />
+		public override string GetPathItemName(OpenApiConvertSettings settings, HashSet<string> parameters)
         {
             Utils.CheckArgumentNull(settings, nameof(settings));
 

src/Microsoft.OpenApi.OData.Reader/Edm/ODataOperationSegment.cs

@@ -8,6 +8,7 @@
 using System.Linq;
 using System.Text;
 using Microsoft.OData.Edm;
+using Microsoft.OData.Edm.Vocabularies;
 using Microsoft.OpenApi.OData.Common;
 
 namespace Microsoft.OpenApi.OData.Edm
@@ -169,5 +170,11 @@ private string ActionName(IEdmAction action, OpenApiConvertSettings settings)
                 return action.FullName();
             }
         }
-    }
+
+        /// <inheritdoc />
+		public override IEnumerable<IEdmVocabularyAnnotatable> GetAnnotables()
+		{
+			return new IEdmVocabularyAnnotatable[] { Operation };
+		}
+	}
 }

src/Microsoft.OpenApi.OData.Reader/Edm/ODataRefSegment.cs

@@ -4,6 +4,8 @@
 // ------------------------------------------------------------
 
 using System.Collections.Generic;
+using System.Linq;
+using Microsoft.OData.Edm.Vocabularies;
 
 namespace Microsoft.OpenApi.OData.Edm
 {
@@ -31,6 +33,12 @@ private ODataRefSegment()
         public override string Identifier => "$ref";
 
         /// <inheritdoc />
-        public override string GetPathItemName(OpenApiConvertSettings settings, HashSet<string> parameters) => "$ref";
+		public override IEnumerable<IEdmVocabularyAnnotatable> GetAnnotables()
+		{
+			return Enumerable.Empty<IEdmVocabularyAnnotatable>();
+		}
+
+		/// <inheritdoc />
+		public override string GetPathItemName(OpenApiConvertSettings settings, HashSet<string> parameters) => "$ref";
     }
 }

src/Microsoft.OpenApi.OData.Reader/Edm/ODataSegment.cs

@@ -7,8 +7,9 @@
 using System.Collections.Generic;
 using System.Linq;
 using Microsoft.OData.Edm;
-using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.OData.Common;
+using Microsoft.OData.Edm.Vocabularies;
+using Microsoft.OpenApi.OData.OpenApiExtensions;
 
 namespace Microsoft.OpenApi.OData.Edm
 {
@@ -121,5 +122,14 @@ public string GetPathHash(OpenApiConvertSettings settings, ODataPath path = defa
         /// <param name="parameters">The existing parameters.</param>
         /// <returns>The path item name.</returns>
         public abstract string GetPathItemName(OpenApiConvertSettings settings, HashSet<string> parameters);
+
+        /// <summary>
+        /// Provides any deprecation information for the segment.
+        /// </summary>
+        public OpenApiDeprecationExtension Deprecation { get; set; }
+        /// <summary>
+        /// Returns the list of <see cref="IEdmVocabularyAnnotatable"/> this segment refers to.
+        /// </summary>
+        public abstract IEnumerable<IEdmVocabularyAnnotatable> GetAnnotables();
     }
 }