Deprecated feature implementation (Azure#329)

ekaradev · web-flow · commit e36610159eef · 2022-02-10T10:38:12.000+09:00
diff --git a/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Attributes/OpenApiPropertyAttribute.cs b/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Attributes/OpenApiPropertyAttribute.cs
@@ -23,5 +23,10 @@ public class OpenApiPropertyAttribute : Attribute
         /// Gets or sets the description.
         /// </summary>
         public virtual string Description { get; set; }
+
+        /// <summary>
+        /// Gets or sets the deprecated flag.
+        /// </summary>
+        public virtual bool Deprecated { get; set; }
     }
 }
diff --git a/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Visitors/Int16EnumTypeVisitor.cs b/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Visitors/Int16EnumTypeVisitor.cs
@@ -67,6 +67,7 @@ public override void Visit(IAcceptor acceptor, KeyValuePair<string, Type> type,
                     schema.Nullable = this.GetOpenApiPropertyNullable(attr as OpenApiPropertyAttribute);
                     schema.Default = this.GetOpenApiPropertyDefault<short>(attr as OpenApiPropertyAttribute);
                     schema.Description = this.GetOpenApiPropertyDescription(attr as OpenApiPropertyAttribute);
+                    schema.Deprecated = this.GetOpenApiPropertyDeprecated(attr as OpenApiPropertyAttribute);
                 }
 
                 attr = attributes.OfType<OpenApiSchemaVisibilityAttribute>().SingleOrDefault();
diff --git a/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Visitors/Int32EnumTypeVisitor.cs b/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Visitors/Int32EnumTypeVisitor.cs
@@ -67,6 +67,7 @@ public override void Visit(IAcceptor acceptor, KeyValuePair<string, Type> type,
                     schema.Nullable = this.GetOpenApiPropertyNullable(attr as OpenApiPropertyAttribute);
                     schema.Default = this.GetOpenApiPropertyDefault<int>(attr as OpenApiPropertyAttribute);
                     schema.Description = this.GetOpenApiPropertyDescription(attr as OpenApiPropertyAttribute);
+                    schema.Deprecated = this.GetOpenApiPropertyDeprecated(attr as OpenApiPropertyAttribute);
                 }
 
                 attr = attributes.OfType<OpenApiSchemaVisibilityAttribute>().SingleOrDefault();
diff --git a/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Visitors/Int64EnumTypeVisitor.cs b/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Visitors/Int64EnumTypeVisitor.cs
@@ -67,6 +67,7 @@ public override void Visit(IAcceptor acceptor, KeyValuePair<string, Type> type,
                     schema.Nullable = this.GetOpenApiPropertyNullable(attr as OpenApiPropertyAttribute);
                     schema.Default = this.GetOpenApiPropertyDefault<long>(attr as OpenApiPropertyAttribute);
                     schema.Description = this.GetOpenApiPropertyDescription(attr as OpenApiPropertyAttribute);
+                    schema.Deprecated = this.GetOpenApiPropertyDeprecated(attr as OpenApiPropertyAttribute);
                 }
 
                 attr = attributes.OfType<OpenApiSchemaVisibilityAttribute>().SingleOrDefault();
diff --git a/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Visitors/NullableObjectTypeVisitor.cs b/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Visitors/NullableObjectTypeVisitor.cs
@@ -71,6 +71,7 @@ public override void Visit(IAcceptor acceptor, KeyValuePair<string, Type> type,
                     schema.Nullable = this.GetOpenApiPropertyNullable(attr as OpenApiPropertyAttribute);
                     schema.Default = this.GetOpenApiPropertyDefault(attr as OpenApiPropertyAttribute);
                     schema.Description = this.GetOpenApiPropertyDescription(attr as OpenApiPropertyAttribute);
+                    schema.Deprecated = this.GetOpenApiPropertyDeprecated(attr as OpenApiPropertyAttribute);
                 }
 
                 attr = attributes.OfType<OpenApiSchemaVisibilityAttribute>().SingleOrDefault();
diff --git a/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Visitors/StringEnumTypeVisitor.cs b/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Visitors/StringEnumTypeVisitor.cs
@@ -66,6 +66,7 @@ public override void Visit(IAcceptor acceptor, KeyValuePair<string, Type> type,
                     schema.Nullable = this.GetOpenApiPropertyNullable(attr as OpenApiPropertyAttribute);
                     schema.Default = this.GetOpenApiPropertyDefault<string>(attr as OpenApiPropertyAttribute);
                     schema.Description = this.GetOpenApiPropertyDescription(attr as OpenApiPropertyAttribute);
+                    schema.Deprecated = this.GetOpenApiPropertyDeprecated(attr as OpenApiPropertyAttribute);
                 }
 
                 attr = attributes.OfType<OpenApiSchemaVisibilityAttribute>().SingleOrDefault();
diff --git a/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Visitors/TypeVisitor.cs b/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Visitors/TypeVisitor.cs
@@ -152,6 +152,7 @@ protected string Visit(IAcceptor acceptor, string name, string title, string dat
                         schema.Default = this.GetOpenApiPropertyDefault(attr as OpenApiPropertyAttribute);
                     }
                     schema.Description = this.GetOpenApiPropertyDescription(attr as OpenApiPropertyAttribute);
+                    schema.Deprecated = this.GetOpenApiPropertyDeprecated(attr as OpenApiPropertyAttribute);
                 }
 
                 attr = attributes.OfType<OpenApiSchemaVisibilityAttribute>().SingleOrDefault();
@@ -368,5 +369,16 @@ protected string GetOpenApiPropertyDescription(OpenApiPropertyAttribute attr)
         {
             return attr.Description;
         }
+
+
+        /// <summary>
+        /// Gets the property deprecated.
+        /// </summary>
+        /// <param name="attr"><see cref="OpenApiPropertyAttribute"/> instance.</param>
+        /// <returns>Returns the property deprecated.</returns>
+        protected bool GetOpenApiPropertyDeprecated(OpenApiPropertyAttribute attr)
+        {
+            return attr.Deprecated;
+        }
     }
 }
diff --git a/test/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Tests/Attributes/OpenApiPropertyAttributeTests.cs b/test/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Tests/Attributes/OpenApiPropertyAttributeTests.cs
@@ -9,19 +9,21 @@ namespace Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Tests.Attributes
     public class OpenApiPropertyAttributeTests
     {
         [DataTestMethod]
-        [DataRow(true, 1, "hello world")]
-        public void Given_Value_Property_Should_Return_Value(bool nullable, object @default, string description)
+        [DataRow(true, 1, "hello world", false)]
+        public void Given_Value_Property_Should_Return_Value(bool nullable, object @default, string description, bool deprecated)
         {
             var attribute = new OpenApiPropertyAttribute()
             {
                 Nullable  = nullable,
                 Default = @default,
-                Description = description
+                Description = description,
+                Deprecated = deprecated
             };
 
             attribute.Nullable.Should().Be(nullable);
             attribute.Default.Should().Be(@default);
             attribute.Description.Should().Be(description);
+            attribute.Deprecated.Should().Be(deprecated);
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -23,5 +23,10 @@ public class OpenApiPropertyAttribute : Attribute`
`23`	`23`	`/// Gets or sets the description.`
`24`	`24`	`/// </summary>`
`25`	`25`	`public virtual string Description { get; set; }`
	`26`	`+`
	`27`	`+ /// <summary>`
	`28`	`+ /// Gets or sets the deprecated flag.`
	`29`	`+ /// </summary>`
	`30`	`+ public virtual bool Deprecated { get; set; }`
`26`	`31`	`}`
`27`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,7 @@ public override void Visit(IAcceptor acceptor, KeyValuePair<string, Type> type,`
`67`	`67`	`schema.Nullable = this.GetOpenApiPropertyNullable(attr as OpenApiPropertyAttribute);`
`68`	`68`	`schema.Default = this.GetOpenApiPropertyDefault<short>(attr as OpenApiPropertyAttribute);`
`69`	`69`	`schema.Description = this.GetOpenApiPropertyDescription(attr as OpenApiPropertyAttribute);`
	`70`	`+ schema.Deprecated = this.GetOpenApiPropertyDeprecated(attr as OpenApiPropertyAttribute);`
`70`	`71`	`}`
`71`	`72`
`72`	`73`	`attr = attributes.OfType<OpenApiSchemaVisibilityAttribute>().SingleOrDefault();`
Original file line number	Diff line number	Diff line change
`@@ -71,6 +71,7 @@ public override void Visit(IAcceptor acceptor, KeyValuePair<string, Type> type,`
`71`	`71`	`schema.Nullable = this.GetOpenApiPropertyNullable(attr as OpenApiPropertyAttribute);`
`72`	`72`	`schema.Default = this.GetOpenApiPropertyDefault(attr as OpenApiPropertyAttribute);`
`73`	`73`	`schema.Description = this.GetOpenApiPropertyDescription(attr as OpenApiPropertyAttribute);`
	`74`	`+ schema.Deprecated = this.GetOpenApiPropertyDeprecated(attr as OpenApiPropertyAttribute);`
`74`	`75`	`}`
`75`	`76`
`76`	`77`	`attr = attributes.OfType<OpenApiSchemaVisibilityAttribute>().SingleOrDefault();`
Original file line number	Diff line number	Diff line change
`@@ -66,6 +66,7 @@ public override void Visit(IAcceptor acceptor, KeyValuePair<string, Type> type,`
`66`	`66`	`schema.Nullable = this.GetOpenApiPropertyNullable(attr as OpenApiPropertyAttribute);`
`67`	`67`	`schema.Default = this.GetOpenApiPropertyDefault<string>(attr as OpenApiPropertyAttribute);`
`68`	`68`	`schema.Description = this.GetOpenApiPropertyDescription(attr as OpenApiPropertyAttribute);`
	`69`	`+ schema.Deprecated = this.GetOpenApiPropertyDeprecated(attr as OpenApiPropertyAttribute);`
`69`	`70`	`}`
`70`	`71`
`71`	`72`	`attr = attributes.OfType<OpenApiSchemaVisibilityAttribute>().SingleOrDefault();`
Original file line number	Diff line number	Diff line change
`@@ -152,6 +152,7 @@ protected string Visit(IAcceptor acceptor, string name, string title, string dat`
`152`	`152`	`schema.Default = this.GetOpenApiPropertyDefault(attr as OpenApiPropertyAttribute);`
`153`	`153`	`}`
`154`	`154`	`schema.Description = this.GetOpenApiPropertyDescription(attr as OpenApiPropertyAttribute);`
	`155`	`+ schema.Deprecated = this.GetOpenApiPropertyDeprecated(attr as OpenApiPropertyAttribute);`
`155`	`156`	`}`
`156`	`157`
`157`	`158`	`attr = attributes.OfType<OpenApiSchemaVisibilityAttribute>().SingleOrDefault();`
`@@ -368,5 +369,16 @@ protected string GetOpenApiPropertyDescription(OpenApiPropertyAttribute attr)`
`368`	`369`	`{`
`369`	`370`	`return attr.Description;`
`370`	`371`	`}`
	`372`	`+`
	`373`	`+`
	`374`	`+ /// <summary>`
	`375`	`+ /// Gets the property deprecated.`
	`376`	`+ /// </summary>`
	`377`	`+ /// <param name="attr"><see cref="OpenApiPropertyAttribute"/> instance.</param>`
	`378`	`+ /// <returns>Returns the property deprecated.</returns>`
	`379`	`+ protected bool GetOpenApiPropertyDeprecated(OpenApiPropertyAttribute attr)`
	`380`	`+ {`
	`381`	`+ return attr.Deprecated;`
	`382`	`+ }`
`371`	`383`	`}`
`372`	`384`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,19 +9,21 @@ namespace Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Tests.Attributes`
`9`	`9`	`public class OpenApiPropertyAttributeTests`
`10`	`10`	`{`
`11`	`11`	`[DataTestMethod]`
`12`		`- [DataRow(true, 1, "hello world")]`
`13`		`- public void Given_Value_Property_Should_Return_Value(bool nullable, object @default, string description)`
	`12`	`+ [DataRow(true, 1, "hello world", false)]`
	`13`	`+ public void Given_Value_Property_Should_Return_Value(bool nullable, object @default, string description, bool deprecated)`
`14`	`14`	`{`
`15`	`15`	`var attribute = new OpenApiPropertyAttribute()`
`16`	`16`	`{`
`17`	`17`	`Nullable = nullable,`
`18`	`18`	`Default = @default,`
`19`		`- Description = description`
	`19`	`+ Description = description,`
	`20`	`+ Deprecated = deprecated`
`20`	`21`	`};`
`21`	`22`
`22`	`23`	`attribute.Nullable.Should().Be(nullable);`
`23`	`24`	`attribute.Default.Should().Be(@default);`
`24`	`25`	`attribute.Description.Should().Be(description);`
	`26`	`+ attribute.Deprecated.Should().Be(deprecated);`
`25`	`27`	`}`
`26`	`28`	`}`
`27`	`29`	`}`