Sha256: b1486bc14ec082674fc15c41d00d385db12cbbdc3985327883d335a0f2353115
Contents?: true
Size: 1.65 KB
Versions: 12
Compression:
Stored size: 1.65 KB
Contents
<%- if @spec['documentation']['description'] -%>
<%= ' '*(@namespace_depth+3) %># <%= @spec['documentation']['description'].gsub("\n", "\n#{' '*(@namespace_depth+3)}# ") -%>
<%- else %>
<%= ' '*(@namespace_depth+3) %># TODO: Description
<%- end %>
<%= stability_doc_helper(@spec['stability']) -%>
<%= ' '*(@namespace_depth+3) %>#
<%- unless @parts.nil? || @parts.empty? %><%# URL parts -%>
<%- @parts.each do |name, info| -%>
<%= docs_helper(name, info) -%>
<%- end -%>
<%- end -%><%# Body -%>
<%# URL parameters -%>
<%- @params.each do |name, info| -%>
<%= docs_helper(name, info) unless (!@parts.empty? && @parts.keys.include?(name)) -%>
<%- end -%>
# @option arguments [Hash] :headers Custom HTTP headers
<%- if @spec['body'] -%>
<%- if @method_name == 'bulk' -%>
<%= bulk_doc_helper(@spec['body']['description']) -%>
<%- else -%>
<%= ' '*(@namespace_depth+1) +
'# @option arguments [Hash] :body ' + (@spec['body']['description'] ?
@spec['body']['description'].strip : 'TODO: Description') +
(@spec['body']['required'] ? ' (*Required*)' : '') + "\n"
-%>
<%- end -%>
<%- end -%>
<% if @deprecation_note -%>
#
# *Deprecation notice*:
# <%= @deprecation_note['description'] %>
# Deprecated since version <%= @deprecation_note['version'] %>
#
<% end -%>
<%= ' '*(@namespace_depth+3) -%>#
<%# Documentation link -%>
<%= ' '*(@namespace_depth+3) %># @see <%= @spec['documentation']['url'] ? @spec['documentation']['url'].gsub(/\/(current|master)\//, "/#{Elasticsearch::API::FilesHelper.gem_version}/") : "[TODO]" %>
<%= ' '*(@namespace_depth+3) %>#
Version data entries
12 entries across 12 versions & 1 rubygems