Merge pull request #66 from Kupferhirn/prop-example

Add example to property
abelsilva · Feb 21, 2017 · 5f5b18a · 5f5b18a
2 parents 1acda73 + c0bb417
commit 5f5b18a
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 0 deletions.
diff --git a/src/SwaggerWcf/Attributes/SwaggerWcfPropertyAttribute.cs b/src/SwaggerWcf/Attributes/SwaggerWcfPropertyAttribute.cs
@@ -47,6 +47,11 @@ public SwaggerWcfPropertyAttribute()
  /// </summary>
  public string Default { get; set; }
 
+ /// <summary>
+ /// Illustrate what the value is supposed to be like.
+ /// </summary>
+ public object Example { get; set; }
+
  /// <summary>
  /// Maximum allowed value, as modified by ExclusiveMaximum.
  /// Must be a valid JSON number, and storable as a decimal.

diff --git a/src/SwaggerWcf/Models/DefinitionProperty.cs b/src/SwaggerWcf/Models/DefinitionProperty.cs
@@ -31,6 +31,8 @@ public DefinitionProperty()
 
  public string Default { get; set; }
 
+ public object Example { get; set; }
+
  public decimal Maximum { get; set; }
 
  public bool ExclusiveMaximum { get; set; }
@@ -92,6 +94,21 @@ public void Serialize(JsonWriter writer)
  writer.WritePropertyName("default");
  writer.WriteValue(Default);
  }
+ if (Example!=null)
+ {
+ writer.WritePropertyName("example");
+ if (Example.GetType().IsArray)
+ {
+ writer.WriteStartArray();
+ foreach (var value in (object[])Example)
+ {
+ writer.WriteValue(value);
+ }
+ writer.WriteEndArray();
+ }
+ else
+ writer.WriteValue(Example);
+ }
  if (Maximum != decimal.MaxValue)
  {
  writer.WritePropertyName("maximum");

diff --git a/src/SwaggerWcf/Support/DefinitionsBuilder.cs b/src/SwaggerWcf/Support/DefinitionsBuilder.cs
@@ -308,6 +308,7 @@ private static void ApplyAttributeOptions(PropertyInfo propertyInfo, DefinitionP
  //ApplyIfValid(LastValidValue(attrs, a => a._AllowEmptyValue), x => prop.AllowEmptyValue = x.Value);
  //ApplyIfValid(LastValidValue(attrs, a => a._CollectionFormat), x => prop.CollectionFormat = x.Value);
  ApplyIfValid(LastValidValue(attrs, a => a.Default), x => prop.Default = x);
+ ApplyIfValid(LastValidValue(attrs, a => a.Example), x => prop.Example = x);
  ApplyIfValid(LastValidValue(attrs, a => a._Maximum), x => prop.Maximum = x.Value);
  ApplyIfValid(LastValidValue(attrs, a => a._ExclusiveMaximum), x => prop.ExclusiveMaximum = x.Value);
  ApplyIfValid(LastValidValue(attrs, a => a._Minimum), x => prop.Minimum = x.Value);