% model = false if model.nil? callback = false if callback.nil? format = nil if format.nil? %>
Key | Description | <% unless model %>Example | <% unless callback %>Default | <% end %> <% end %>||||
---|---|---|---|---|---|---|---|
<%= parameter.name %> <% if parameter.required %> Required <% end %> <% if @specification.initialization_config && @specification.initialization_config['formats'] %> <% if @specification.initialization_config['formats'].include? 'text/xml' %> <% if parameter.is_xml_attribute? %> | Attribute <% end %> <% if parameter.is_xml_text? %> | Value <% end %> <% end %> <% end %> <% if parameter.required and parameter.type %>|<% end %> <%= parameter.type %> <% if parameter.format %> | (<%= parameter.format %>) <% end %> <% if parameter.array? %> <% if parameter.items && parameter.items['type'] %> of <%= (parameter.items['type']) %>s <% end %> <% end %> |
<%
# If it's a oneOf we show a list rather than description/example/default
if parameter.oneOf?
%>
Any one of the following:<% parameter.properties.each do |property| %><%= property['description'] %><%= erb :'open_api/_parameters', locals: { parameters: property['properties'], model: model, format: format, callback: callback } %> <% end %> |
<%
# Otherwise we show the remaining 3 columns
else
%>
<% if parameter.collection? || parameter.oneOf? %>
<% if parameter.raw['x-nexmo-developer-collection-description-shown'] %>
<%= (parameter.description ? "#{parameter.description}" : 'None').render_markdown %>
<% end %>
<% else %>
<%= (parameter.description ? "#{parameter.description}" : 'None').render_markdown %>
<% end %>
<% if parameter.enum %>
<%= (callback || model) ? "One of:" : "Must be one of:" %> <%= parameter_values(parameter.enum) %> <% end %> <% if parameter.raw['x-possible-values'] %> Will be one of: <%= parameter_values(parameter.raw['x-possible-values']) %> <% end %> <% if parameter.minimum || parameter.maximum %> <% if parameter.minimum && parameter.maximum %> Must be between <%= " #{parameter.minimum} "%> and <%= "#{parameter.maximum} "%>
<% elsif parameter.minimum %>
Must be at least <%= "#{parameter.minimum} "%>
<% else %>
Must be at most <%= "#{parameter.maximum} "%>
<% end %>
<% end %>
|
<% unless model %>
<% if parameter.collection? || parameter.oneOf? %>
<% if parameter.raw['x-nexmo-developer-collection-description-shown'] %>
<%= (parameter.example ? " " : '')%>
|
<% end %>
<% else %>
<%= (parameter.example ? "#{parameter.example.to_s.gsub("\n", " " : 'None')%>
|
<% end %>
<% end %>
<% unless model || callback %>
<% if parameter.raw['x-default-is-meta'] %>
<%= (parameter.default.nil? ? 'None' : parameter.default) %>
<% else %>
<% unless parameter.type == 'object' %>
<%= (parameter.default.nil? ? 'None' : "#{parameter.default} ")%>
<% end %>
<% end %>
|
<% end %>
<% if parameter.collection? %>
||
<% if parameter.subproperties_are_one_of_many? %>
Any one of the following:<% parameter.properties.each do |property| %><%= property['description'] %><%= erb :'open_api/_parameters', locals: { parameters: property['properties'], model: model, format: format, callback: callback } %> <% end %> |