Class: Committee::Drivers::OpenAPI2::Link

Inherits:
Object
  • Object
show all
Defined in:
lib/committee/drivers/open_api_2/link.rb

Overview

Link abstracts an API link specifically for OpenAPI 2.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#enc_type ⇒ Object

The link’s input media type. i.e. How requests should be encoded.



9
10
11
 
# File 'lib/committee/drivers/open_api_2/link.rb', line 9

def enc_type
  @enc_type
end

#header_schema ⇒ Object

Returns the value of attribute header_schema.



28
29
30
 
# File 'lib/committee/drivers/open_api_2/link.rb', line 28

def header_schema
  @header_schema
end

#href ⇒ Object

Returns the value of attribute href.



11
12
13
 
# File 'lib/committee/drivers/open_api_2/link.rb', line 11

def href
  @href
end

#media_type ⇒ Object

The link’s output media type. i.e. How responses should be encoded.



14
15
16
 
# File 'lib/committee/drivers/open_api_2/link.rb', line 14

def media_type
  @media_type
end

#method ⇒ Object

Returns the value of attribute method.



16
17
18
 
# File 'lib/committee/drivers/open_api_2/link.rb', line 16

def method
  @method
end

#schema ⇒ Object

The link’s input schema. i.e. How we validate an endpoint’s incoming parameters.



20
21
22
 
# File 'lib/committee/drivers/open_api_2/link.rb', line 20

def schema
  @schema
end

#status_success ⇒ Object

Returns the value of attribute status_success.



22
23
24
 
# File 'lib/committee/drivers/open_api_2/link.rb', line 22

def status_success
  @status_success
end

#target_schema ⇒ Object

The link’s output schema. i.e. How we validate an endpoint’s response data.



26
27
28
 
# File 'lib/committee/drivers/open_api_2/link.rb', line 26

def target_schema
  @target_schema
end

Instance Method Details

#rel ⇒ Object 



30
31
32
 
# File 'lib/committee/drivers/open_api_2/link.rb', line 30

def rel
  raise "Committee: rel not implemented for OpenAPI"
end