1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
<%#
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
%>
<%- 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) %>#
|
