Class: Committee::Drivers::Schema

Inherits:

Object

• Object
• Committee::Drivers::Schema

Defined in:

lib/committee/drivers/schema.rb

Overview

Schema is a base class for driver schema implementations.

Direct Known Subclasses

HyperSchema::Schema, OpenAPI2::Schema, OpenAPI3::Schema

Instance Method Summary

• #build_router(options) ⇒ Object
• #driver ⇒ Object

  A link back to the derivative instance of Committee::Drivers::Driver that create this schema.

• #supports_stub? ⇒ Boolean

  Stubs are supported in JSON Hyper-Schema and OpenAPI 2, but not yet in OpenAPI 3.

Instance Method Details

#build_router(options) ⇒ Object

# File 'lib/committee/drivers/schema.rb', line 13

def build_router(options)
  raise "needs implementation"
end

#driver ⇒ Object

A link back to the derivative instance of Committee::Drivers::Driver that create this schema.

# File 'lib/committee/drivers/schema.rb', line 9

def driver
  raise "needs implementation"
end

#supports_stub? ⇒ Boolean

Stubs are supported in JSON Hyper-Schema and OpenAPI 2, but not yet in OpenAPI 3

Returns:

• (Boolean)

# File 'lib/committee/drivers/schema.rb', line 18

def supports_stub?
  true
end