Method: Jdoc::Property#example

Defined in:
lib/jdoc/property.rb

#exampleString?

Returns Example value, defined in example property.

Returns:

  • (String, nil)

    Example value, defined in example property



29
30
31
32
33
# File 'lib/jdoc/property.rb', line 29

def example
  if @schema.data.has_key?("example")
    %<`#{@schema.data["example"].inspect}`>
  end
end