Added Example property to OpenApi attribute

src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Attributes/OpenApiPropertyAttribute.cs

@@ -28,5 +28,10 @@ public class OpenApiPropertyAttribute : Attribute
         /// Gets or sets the deprecated flag.
         /// </summary>
         public virtual bool Deprecated { get; set; }
+
+        /// <summary>
+        /// Gets or sets the example value of the property.
+        /// </summary>
+        public virtual object Example { get; set; }
     }
 }

src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Visitors/NullableObjectTypeVisitor.cs

@@ -72,6 +72,7 @@ public override void Visit(IAcceptor acceptor, KeyValuePair<string, Type> type,
                     schema.Default = this.GetOpenApiPropertyDefault(attr as OpenApiPropertyAttribute);
                     schema.Description = this.GetOpenApiPropertyDescription(attr as OpenApiPropertyAttribute);
                     schema.Deprecated = this.GetOpenApiPropertyDeprecated(attr as OpenApiPropertyAttribute);
+                    schema.Example = this.GetOpenApiPropertyExample(attr as OpenApiPropertyAttribute);
                 }
 
                 attr = attributes.OfType<OpenApiSchemaVisibilityAttribute>().SingleOrDefault();

src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Visitors/TypeVisitor.cs

@@ -154,6 +154,7 @@ protected string Visit(IAcceptor acceptor, string name, string title, string dat
                     schema.Nullable = this.GetOpenApiPropertyNullable(attr as OpenApiPropertyAttribute);
                     schema.Description = this.GetOpenApiPropertyDescription(attr as OpenApiPropertyAttribute);
                     schema.Deprecated = this.GetOpenApiPropertyDeprecated(attr as OpenApiPropertyAttribute);
+                    schema.Example = this.GetOpenApiPropertyExample(attr as OpenApiPropertyAttribute);
                 }
 
                 attr = attributes.OfType<OpenApiSchemaVisibilityAttribute>().SingleOrDefault();
@@ -392,6 +393,97 @@ protected bool GetOpenApiPropertyDeprecated(OpenApiPropertyAttribute attr)
             return attr.Deprecated;
         }
 
+        /// <summary>
+        /// Gets the property example.
+        /// </summary>
+        /// <param name="attr"><see cref="OpenApiPropertyAttribute"/> instance.</param>
+        /// <returns>Returns the property example.</returns>
+        protected IOpenApiAny GetOpenApiPropertyExample(OpenApiPropertyAttribute attr)
+        {
+            var @example = attr.Example;
+            if (@example.IsNullOrDefault())
+            {
+                return null;
+            }
+
+            if (@example is bool)
+            {
+                return new OpenApiBoolean((bool)@example);
+            }
+
+            if (@example is DateTime)
+            {
+                return new OpenApiDateTime((DateTime)@example);
+            }
+
+            if (@example is TimeSpan)
+            {
+                return new OpenApiString(@example.ToString());
+            }
+
+            if (@example is DateTimeOffset)
+            {
+                return new OpenApiDateTime((DateTimeOffset)@example);
+            }
+
+            if (@example is float)
+            {
+                return new OpenApiFloat((float)@example);
+            }
+
+            if (@example is double)
+            {
+                return new OpenApiDouble((double)@example);
+            }
+
+            if (@example is decimal)
+            {
+                return new OpenApiDouble(Convert.ToDouble(@example));
+            }
+
+            if (@example is byte[])
+            {
+                return new OpenApiByte((byte[])@example);
+            }
+
+            if (@example is short)
+            {
+                return new OpenApiInteger((short)@example);
+            }
+
+            if (@example is int)
+            {
+                return new OpenApiInteger((int)@example);
+            }
+
+            if (@example is long)
+            {
+                return new OpenApiLong((long)@example);
+            }
+
+            if (@example is ushort)
+            {
+                return new OpenApiInteger(Convert.ToInt16(@example));
+            }
+
+            if (@example is uint)
+            {
+                return new OpenApiInteger(Convert.ToInt32(@example));
+            }
+
+            if (@example is ulong)
+            {
+                return new OpenApiLong(Convert.ToInt64(@example));
+            }
+
+            if (@example is Guid)
+            {
+                return new OpenApiString(Convert.ToString(@example));
+            }
+
+            return new OpenApiString((string)@example);
+        }
+
         /// <summary>
         /// Gets whether Newtonsoft Serialization allows nullability based on the JsonPropertyAttribute
         /// </summary>