Method: Jsapi::Meta::Parameter::Model#to_openapi_parameters

Defined in:
lib/jsapi/meta/parameter/model.rb

#to_openapi_parameters(version, definitions) ⇒ Object

Returns an array of hashes representing the OpenAPI parameter objects.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/jsapi/meta/parameter/model.rb', line 79

def to_openapi_parameters(version, definitions)
  version = OpenAPI::Version.from(version)
  schema = self.schema.resolve(definitions)

  if schema.object?
    explode_object_parameter(
      name,
      schema,
      version,
      definitions,
      required: required?,
      deprecated: deprecated?
    )
  else
    parameter_name = schema.array? ? "#{name}[]" : name
    [
      with_openapi_extensions(
        if version.major == 2
          {
            name: parameter_name,
            in: self.in,
            description: description,
            required: required?.presence,
            allowEmptyValue: allow_empty_value?.presence,
            collectionFormat: ('multi' if schema.array?)
          }.merge(schema.to_openapi(version))
        else
          {
            name: parameter_name,
            in: self.in,
            description: description,
            required: required?.presence,
            allowEmptyValue: allow_empty_value?.presence,
            deprecated: deprecated?.presence,
            schema: schema.to_openapi(version),
            examples: examples.transform_values(&:to_openapi).presence

            # NOTE: collectionFormat is replaced by style and explode.
            #       The default values for query parameters are:
            #       - style: 'form'
            #       - explode: true
          }
        end
      )
    ]
  end
end