class PulpAnsibleClient::PulpAnsibleDefaultApiV3CollectionsVersionsDocsBlobApi
Attributes
Public Class Methods
# File lib/pulp_ansible_client/api/pulp_ansible_default_api_v3_collections_versions_docs_blob_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Legacy v3 endpoint. @param name [String] @param namespace [String] @param version [String] @param [Hash] opts the optional parameters @option opts [Array<String>] :fields A list of fields to include in the response. @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response. @return [CollectionVersionDocsResponse]
# File lib/pulp_ansible_client/api/pulp_ansible_default_api_v3_collections_versions_docs_blob_api.rb, line 30 def read(name, namespace, version, opts = {}) data, _status_code, _headers = read_with_http_info(name, namespace, version, opts) data end
Legacy v3 endpoint. @param name [String] @param namespace [String] @param version [String] @param [Hash] opts the optional parameters @option opts [Array<String>] :fields A list of fields to include in the response. @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response. @return [Array<(CollectionVersionDocsResponse
, Integer, Hash)>] CollectionVersionDocsResponse
data, response status code and response headers
# File lib/pulp_ansible_client/api/pulp_ansible_default_api_v3_collections_versions_docs_blob_api.rb, line 43 def read_with_http_info(name, namespace, version, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PulpAnsibleDefaultApiV3CollectionsVersionsDocsBlobApi.read ...' end # verify the required parameter 'name' is set if @api_client.config.client_side_validation && name.nil? fail ArgumentError, "Missing the required parameter 'name' when calling PulpAnsibleDefaultApiV3CollectionsVersionsDocsBlobApi.read" end # verify the required parameter 'namespace' is set if @api_client.config.client_side_validation && namespace.nil? fail ArgumentError, "Missing the required parameter 'namespace' when calling PulpAnsibleDefaultApiV3CollectionsVersionsDocsBlobApi.read" end # verify the required parameter 'version' is set if @api_client.config.client_side_validation && version.nil? fail ArgumentError, "Missing the required parameter 'version' when calling PulpAnsibleDefaultApiV3CollectionsVersionsDocsBlobApi.read" end # resource path local_var_path = '/pulp_ansible/galaxy/default/api/v3/collections/{namespace}/{name}/versions/{version}/docs-blob/'.sub('{' + 'name' + '}', CGI.escape(name.to_s).gsub('%2F', '/')).sub('{' + 'namespace' + '}', CGI.escape(namespace.to_s).gsub('%2F', '/')).sub('{' + 'version' + '}', CGI.escape(version.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil? query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'CollectionVersionDocsResponse' # auth_names auth_names = opts[:auth_names] || ['basicAuth'] new_options = opts.merge( :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(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: PulpAnsibleDefaultApiV3CollectionsVersionsDocsBlobApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end