Class: Jdoc::Schema

Inherits:
Object
  • Object
show all
Defined in:
lib/jdoc/schema.rb

Constant Summary collapse

DEFAULT_ENDPOINT = 
"https://api.example.com"

Instance Method Summary collapse

Constructor Details

#initialize(schema) ⇒ Schema

Returns a new instance of Schema.

Parameters:

  • schema (Hash) —

    JSON Schema



6
7
8
 
# File 'lib/jdoc/schema.rb', line 6

def initialize(schema)
  @json_schema = JsonSchema.parse!(schema).tap(&:expand_references!)
end

Instance Method Details

#description ⇒ String?

Returns Description property of this schema.

Examples:

schema.description #=> "A schema for a small example API."

Returns:

  • (String, nil) —

    Description property of this schema



27
28
29
30
31
 
# File 'lib/jdoc/schema.rb', line 27

def description
  if @json_schema.description
    "#{@json_schema.description}\n\n"
  end
end

#host_with_port ⇒ String

Examples:

host_with_port #=> "api.example.com"
host_with_port #=> "api.example.com:3000"

Returns:

  • (String) 


37
38
39
40
41
42
43
 
# File 'lib/jdoc/schema.rb', line 37

def host_with_port
  if [80, 443].include?(port)
    host
  else
    "#{host}:#{port}"
  end
end

#resources ⇒ Array<Jdoc::Resource>

Returns All top-level properties in its title order.

Returns:

  • (Array<Jdoc::Resource>) —

    All top-level properties in its title order



11
12
13
14
15
 
# File 'lib/jdoc/schema.rb', line 11

def resources
  @resources ||= @json_schema.properties.map do |key, property|
    Resource.new(property)
  end.sort
end

#title ⇒ String?

Returns Title property of this schema.

Examples:

schema.title #=> "app"

Returns:

  • (String, nil) —

    Title property of this schema



20
21
22
 
# File 'lib/jdoc/schema.rb', line 20

def title
  @json_schema.title
end