Class: Committee::Drivers::OpenAPI2::Link
- Inherits:
-
Object
- Object
- Committee::Drivers::OpenAPI2::Link
- Defined in:
- lib/committee/drivers/open_api_2.rb
Overview
Link abstracts an API link specifically for OpenAPI 2.
Instance Attribute Summary collapse
-
#enc_type ⇒ Object
The link’s input media type.
-
#header_schema ⇒ Object
Returns the value of attribute header_schema.
-
#href ⇒ Object
Returns the value of attribute href.
-
#media_type ⇒ Object
The link’s output media type.
-
#method ⇒ Object
Returns the value of attribute method.
-
#schema ⇒ Object
The link’s input schema.
-
#status_success ⇒ Object
Returns the value of attribute status_success.
-
#target_schema ⇒ Object
The link’s output schema.
Instance Method Summary collapse
Instance Attribute Details
#enc_type ⇒ Object
The link’s input media type. i.e. How requests should be encoded.
65 66 67 |
# File 'lib/committee/drivers/open_api_2.rb', line 65 def enc_type @enc_type end |
#header_schema ⇒ Object
Returns the value of attribute header_schema.
84 85 86 |
# File 'lib/committee/drivers/open_api_2.rb', line 84 def header_schema @header_schema end |
#href ⇒ Object
Returns the value of attribute href.
67 68 69 |
# File 'lib/committee/drivers/open_api_2.rb', line 67 def href @href end |
#media_type ⇒ Object
The link’s output media type. i.e. How responses should be encoded.
70 71 72 |
# File 'lib/committee/drivers/open_api_2.rb', line 70 def media_type @media_type end |
#method ⇒ Object
Returns the value of attribute method.
72 73 74 |
# File 'lib/committee/drivers/open_api_2.rb', line 72 def method @method end |
#schema ⇒ Object
The link’s input schema. i.e. How we validate an endpoint’s incoming parameters.
76 77 78 |
# File 'lib/committee/drivers/open_api_2.rb', line 76 def schema @schema end |
#status_success ⇒ Object
Returns the value of attribute status_success.
78 79 80 |
# File 'lib/committee/drivers/open_api_2.rb', line 78 def status_success @status_success end |
#target_schema ⇒ Object
The link’s output schema. i.e. How we validate an endpoint’s response data.
82 83 84 |
# File 'lib/committee/drivers/open_api_2.rb', line 82 def target_schema @target_schema end |
Instance Method Details
#rel ⇒ Object
86 87 88 |
# File 'lib/committee/drivers/open_api_2.rb', line 86 def rel raise "Committee: rel not implemented for OpenAPI" end |