class Raddocs::Example

Example page model

Attributes

description[R]
explanation[R]
parameters[R]
requests[R]
resource[R]
resource_explanation[R]
response_fields[R]

Public Class Methods

new(file) click to toggle source
# File lib/raddocs/models.rb, line 52
def initialize(file)
  @attrs = JSON.parse(File.read(file))
  @resource_explanation = @attrs.fetch("resource_explanation", nil)
  @resource = @attrs.fetch("resource")
  
  @description = @attrs.fetch("description")
  @explanation = @attrs.fetch("explanation", nil)
  @parameters = Parameters.new(@attrs.fetch("parameters"))
  @response_fields = ResponseFields.new(@attrs.fetch("response_fields", []))
  @requests = @attrs.fetch("requests").map { |request| Request.new(request) }
end

Public Instance Methods

explanation?() click to toggle source

@return [Boolean] true if explanation is present

# File lib/raddocs/models.rb, line 65
def explanation?
  !explanation.nil?
end
resource_explanation?() click to toggle source
# File lib/raddocs/models.rb, line 69
def resource_explanation?
  !resource_explanation.nil?
end