Module: JekyllOpenAPI::Headers

Defined in:
lib/jekyll_openapi/headers.rb

Overview

Normalizes a Response object's headers map into a flat, ordered list — the Header-object counterpart to Parameters.group. $ref'd headers read transparently through their Reference, so the caller never special-cases them.

See Also:

Class Method Summary collapse

Class Method Details

.list(response) ⇒ Array<Hash>

Returns description, required, deprecated, schema.

Parameters:

  • response (Hash, Reference) —

    a Response object

Returns:

  • (Array<Hash>) —

    description, required, deprecated, schema



12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/jekyll_openapi/headers.rb', line 12

def self.list(response)
  map = (response.is_a?(Hash) || response.is_a?(Reference)) ? response["headers"] : nil
  return [] unless map.is_a?(Hash)

  map.map do |name, header|
    {
      "name" => name,
      "description" => header["description"],
      "required" => header["required"] || false,
      "deprecated" => header["deprecated"] || false,
      "schema" => header["schema"],
    }
  end
end