Class: EjabberdHttpClient::DocumentationApi
- Inherits:
-
Object
- Object
- EjabberdHttpClient::DocumentationApi
- Defined in:
- lib/ejabberd_http_client/api/documentation_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#gen_html_doc_for_commands(gen_html_doc_for_commands_request, opts = {}) ⇒ Integer
Generates html documentation for ejabberd_commands.
-
#gen_html_doc_for_commands_with_http_info(gen_html_doc_for_commands_request, opts = {}) ⇒ Array<(Integer, Integer, Hash)>
Generates html documentation for ejabberd_commands.
-
#gen_markdown_doc_for_commands(gen_html_doc_for_commands_request, opts = {}) ⇒ Integer
Generates markdown documentation for ejabberd_commands.
-
#gen_markdown_doc_for_commands_with_http_info(gen_html_doc_for_commands_request, opts = {}) ⇒ Array<(Integer, Integer, Hash)>
Generates markdown documentation for ejabberd_commands.
-
#gen_markdown_doc_for_tags(gen_markdown_doc_for_tags_request, opts = {}) ⇒ Integer
Generates markdown documentation for ejabberd_commands.
-
#gen_markdown_doc_for_tags_with_http_info(gen_markdown_doc_for_tags_request, opts = {}) ⇒ Array<(Integer, Integer, Hash)>
Generates markdown documentation for ejabberd_commands.
-
#generate_manpage(opts = {}) ⇒ nil
Generate Unix manpage for current ejabberd version.
-
#generate_manpage_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>
Generate Unix manpage for current ejabberd version.
-
#initialize(api_client = ApiClient.default) ⇒ DocumentationApi
constructor
A new instance of DocumentationApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ DocumentationApi
Returns a new instance of DocumentationApi.
19 20 21 |
# File 'lib/ejabberd_http_client/api/documentation_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/ejabberd_http_client/api/documentation_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#gen_html_doc_for_commands(gen_html_doc_for_commands_request, opts = {}) ⇒ Integer
Generates html documentation for ejabberd_commands.
26 27 28 29 |
# File 'lib/ejabberd_http_client/api/documentation_api.rb', line 26 def gen_html_doc_for_commands(gen_html_doc_for_commands_request, opts = {}) data, _status_code, _headers = gen_html_doc_for_commands_with_http_info(gen_html_doc_for_commands_request, opts) data end |
#gen_html_doc_for_commands_with_http_info(gen_html_doc_for_commands_request, opts = {}) ⇒ Array<(Integer, Integer, Hash)>
Generates html documentation for ejabberd_commands.
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/ejabberd_http_client/api/documentation_api.rb', line 35 def gen_html_doc_for_commands_with_http_info(gen_html_doc_for_commands_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentationApi.gen_html_doc_for_commands ...' end # verify the required parameter 'gen_html_doc_for_commands_request' is set if @api_client.config.client_side_validation && gen_html_doc_for_commands_request.nil? fail ArgumentError, "Missing the required parameter 'gen_html_doc_for_commands_request' when calling DocumentationApi.gen_html_doc_for_commands" end # resource path local_var_path = '/api/gen_html_doc_for_commands' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(gen_html_doc_for_commands_request) # return_type return_type = opts[:debug_return_type] || 'Integer' # auth_names auth_names = opts[:debug_auth_names] || [] = opts.merge( :operation => :"DocumentationApi.gen_html_doc_for_commands", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentationApi#gen_html_doc_for_commands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#gen_markdown_doc_for_commands(gen_html_doc_for_commands_request, opts = {}) ⇒ Integer
Generates markdown documentation for ejabberd_commands.
92 93 94 95 |
# File 'lib/ejabberd_http_client/api/documentation_api.rb', line 92 def gen_markdown_doc_for_commands(gen_html_doc_for_commands_request, opts = {}) data, _status_code, _headers = gen_markdown_doc_for_commands_with_http_info(gen_html_doc_for_commands_request, opts) data end |
#gen_markdown_doc_for_commands_with_http_info(gen_html_doc_for_commands_request, opts = {}) ⇒ Array<(Integer, Integer, Hash)>
Generates markdown documentation for ejabberd_commands.
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 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 |
# File 'lib/ejabberd_http_client/api/documentation_api.rb', line 101 def gen_markdown_doc_for_commands_with_http_info(gen_html_doc_for_commands_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentationApi.gen_markdown_doc_for_commands ...' end # verify the required parameter 'gen_html_doc_for_commands_request' is set if @api_client.config.client_side_validation && gen_html_doc_for_commands_request.nil? fail ArgumentError, "Missing the required parameter 'gen_html_doc_for_commands_request' when calling DocumentationApi.gen_markdown_doc_for_commands" end # resource path local_var_path = '/api/gen_markdown_doc_for_commands' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(gen_html_doc_for_commands_request) # return_type return_type = opts[:debug_return_type] || 'Integer' # auth_names auth_names = opts[:debug_auth_names] || [] = opts.merge( :operation => :"DocumentationApi.gen_markdown_doc_for_commands", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentationApi#gen_markdown_doc_for_commands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#gen_markdown_doc_for_tags(gen_markdown_doc_for_tags_request, opts = {}) ⇒ Integer
Generates markdown documentation for ejabberd_commands.
158 159 160 161 |
# File 'lib/ejabberd_http_client/api/documentation_api.rb', line 158 def (, opts = {}) data, _status_code, _headers = (, opts) data end |
#gen_markdown_doc_for_tags_with_http_info(gen_markdown_doc_for_tags_request, opts = {}) ⇒ Array<(Integer, Integer, Hash)>
Generates markdown documentation for ejabberd_commands.
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 |
# File 'lib/ejabberd_http_client/api/documentation_api.rb', line 167 def (, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentationApi.gen_markdown_doc_for_tags ...' end # verify the required parameter 'gen_markdown_doc_for_tags_request' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'gen_markdown_doc_for_tags_request' when calling DocumentationApi.gen_markdown_doc_for_tags" end # resource path local_var_path = '/api/gen_markdown_doc_for_tags' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body() # return_type return_type = opts[:debug_return_type] || 'Integer' # auth_names auth_names = opts[:debug_auth_names] || [] = opts.merge( :operation => :"DocumentationApi.gen_markdown_doc_for_tags", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentationApi#gen_markdown_doc_for_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#generate_manpage(opts = {}) ⇒ nil
Generate Unix manpage for current ejabberd version.
223 224 225 226 |
# File 'lib/ejabberd_http_client/api/documentation_api.rb', line 223 def generate_manpage(opts = {}) generate_manpage_with_http_info(opts) nil end |
#generate_manpage_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>
Generate Unix manpage for current ejabberd version.
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 |
# File 'lib/ejabberd_http_client/api/documentation_api.rb', line 231 def generate_manpage_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentationApi.generate_manpage ...' end # resource path local_var_path = '/api/man' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || [] = opts.merge( :operation => :"DocumentationApi.generate_manpage", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentationApi#generate_manpage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |