pulp_ansible_client 0.16.2 → 0.17.0

data/docs/UnpaginatedCollectionVersionResponse.md

@@ -5,19 +5,20 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **version** | **String** |  | [optional] [readonly] 
-**href** | **String** | Get href. | [optional] [readonly] 
+**href** | **String** |  | [optional] [readonly] 
 **created_at** | **DateTime** |  | 
 **updated_at** | **DateTime** |  | 
 **requires_ansible** | **String** |  | [optional] 
+**marks** | **Array<String>** |  | [optional] [readonly] 
 **artifact** | [**ArtifactRefResponse**](ArtifactRefResponse.md) |  | [optional] [readonly] 
 **collection** | [**CollectionRefResponse**](CollectionRefResponse.md) |  | [optional] [readonly] 
-**download_url** | **String** | Get artifact download URL. | [optional] [readonly] 
+**download_url** | **String** |  | [optional] [readonly] 
 **name** | **String** |  | [optional] [readonly] 
 **namespace** | [**CollectionNamespaceResponse**](CollectionNamespaceResponse.md) |  | [optional] [readonly] 
 **signatures** | **String** |  | [optional] [readonly] 
 **metadata** | [**CollectionMetadataResponse**](CollectionMetadataResponse.md) |  | [optional] [readonly] 
-**git_url** | **String** | Get the git URL. | [optional] [readonly] 
-**git_commit_sha** | **String** | Get the git commit sha. | [optional] [readonly] 
+**git_url** | **String** |  | [optional] [readonly] 
+**git_commit_sha** | **String** |  | [optional] [readonly] 
 
 ## Code Sample
 
@@ -29,6 +30,7 @@ instance = PulpAnsibleClient::UnpaginatedCollectionVersionResponse.new(version:
                                  created_at: null,
                                  updated_at: null,
                                  requires_ansible: null,
+                                 marks: null,
                                  artifact: null,
                                  collection: null,
                                  download_url: null,

data/docs/VersionsApi.md

@@ -4,14 +4,14 @@ All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**get**](VersionsApi.md#get) | **GET** {ansible_role_href}versions/ | 
-[**get_0**](VersionsApi.md#get_0) | **GET** {ansible_collection_version_href}versions/ | 
+[**api_v1_roles_versions_list**](VersionsApi.md#api_v1_roles_versions_list) | **GET** {ansible_role_href}versions/ | 
+[**api_v2_collection_versions_list**](VersionsApi.md#api_v2_collection_versions_list) | **GET** {ansible_collection_version_href}versions/ | 
 
 
 
-## get
+## api_v1_roles_versions_list
 
-> PaginatedGalaxyRoleVersionResponseList get(ansible_role_href, opts)
+> PaginatedGalaxyRoleVersionResponseList api_v1_roles_versions_list(ansible_role_href, opts)
 
 
 
@@ -33,10 +33,10 @@ opts = {
 }
 
 begin
-  result = api_instance.get(ansible_role_href, opts)
+  result = api_instance.api_v1_roles_versions_list(ansible_role_href, opts)
   p result
 rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling VersionsApi->get: #{e}"
+  puts "Exception when calling VersionsApi->api_v1_roles_versions_list: #{e}"
 end
 ```
 
@@ -65,9 +65,9 @@ No authorization required
 - **Accept**: application/json
 
 
-## get_0
+## api_v2_collection_versions_list
 
-> PaginatedGalaxyCollectionVersionResponseList get_0(ansible_collection_version_href, opts)
+> PaginatedGalaxyCollectionVersionResponseList api_v2_collection_versions_list(ansible_collection_version_href, opts)
 
 
 
@@ -88,10 +88,10 @@ opts = {
 }
 
 begin
-  result = api_instance.get_0(ansible_collection_version_href, opts)
+  result = api_instance.api_v2_collection_versions_list(ansible_collection_version_href, opts)
   p result
 rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling VersionsApi->get_0: #{e}"
+  puts "Exception when calling VersionsApi->api_v2_collection_versions_list: #{e}"
 end
 ```
 

data/lib/pulp_ansible_client/api/ansible_collections_api.rb

@@ -19,6 +19,74 @@ module PulpAnsibleClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Add a role for this object to users/groups.
+    # @param ansible_collection_href [String] 
+    # @param nested_role [NestedRole] 
+    # @param [Hash] opts the optional parameters
+    # @return [NestedRoleResponse]
+    def add_role(ansible_collection_href, nested_role, opts = {})
+      data, _status_code, _headers = add_role_with_http_info(ansible_collection_href, nested_role, opts)
+      data
+    end
+
+    # Add a role for this object to users/groups.
+    # @param ansible_collection_href [String] 
+    # @param nested_role [NestedRole] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(NestedRoleResponse, Integer, Hash)>] NestedRoleResponse data, response status code and response headers
+    def add_role_with_http_info(ansible_collection_href, nested_role, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnsibleCollectionsApi.add_role ...'
+      end
+      # verify the required parameter 'ansible_collection_href' is set
+      if @api_client.config.client_side_validation && ansible_collection_href.nil?
+        fail ArgumentError, "Missing the required parameter 'ansible_collection_href' when calling AnsibleCollectionsApi.add_role"
+      end
+      # verify the required parameter 'nested_role' is set
+      if @api_client.config.client_side_validation && nested_role.nil?
+        fail ArgumentError, "Missing the required parameter 'nested_role' when calling AnsibleCollectionsApi.add_role"
+      end
+      # resource path
+      local_var_path = '{ansible_collection_href}add_role/'.sub('{' + 'ansible_collection_href' + '}', CGI.escape(ansible_collection_href.to_s).gsub('%2F', '/'))
+
+      # 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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(nested_role) 
+
+      # return_type
+      return_type = opts[:return_type] || 'NestedRoleResponse' 
+
+      # 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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnsibleCollectionsApi#add_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List collections
     # Viewset for Ansible Collections.
     # @param [Hash] opts the optional parameters
@@ -26,9 +94,7 @@ module PulpAnsibleClient
     # @option opts [String] :name 
     # @option opts [String] :namespace 
     # @option opts [Integer] :offset The initial index from which to return the results.
-    # @option opts [Array<String>] :ordering Ordering  * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;namespace&#x60; - Namespace * &#x60;-namespace&#x60; - Namespace (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)
-    # @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas.
-    # @option opts [Array<String>] :pulp_id__in Multiple values may be separated by commas.
+    # @option opts [Array<String>] :ordering Ordering
     # @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 [PaginatedansibleCollectionResponseList]
@@ -44,9 +110,7 @@ module PulpAnsibleClient
     # @option opts [String] :name 
     # @option opts [String] :namespace 
     # @option opts [Integer] :offset The initial index from which to return the results.
-    # @option opts [Array<String>] :ordering Ordering  * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;namespace&#x60; - Namespace * &#x60;-namespace&#x60; - Namespace (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)
-    # @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas.
-    # @option opts [Array<String>] :pulp_id__in Multiple values may be separated by commas.
+    # @option opts [Array<String>] :ordering Ordering
     # @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<(PaginatedansibleCollectionResponseList, Integer, Hash)>] PaginatedansibleCollectionResponseList data, response status code and response headers
@@ -68,8 +132,6 @@ module PulpAnsibleClient
       query_params[:'namespace'] = opts[:'namespace'] if !opts[:'namespace'].nil?
       query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
       query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
-      query_params[:'pulp_href__in'] = @api_client.build_collection_param(opts[:'pulp_href__in'], :csv) if !opts[:'pulp_href__in'].nil?
-      query_params[:'pulp_id__in'] = @api_client.build_collection_param(opts[:'pulp_id__in'], :csv) if !opts[:'pulp_id__in'].nil?
       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?
 
@@ -106,6 +168,206 @@ module PulpAnsibleClient
       return data, status_code, headers
     end
 
+    # List roles assigned to this object.
+    # @param ansible_collection_href [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 [ObjectRolesResponse]
+    def list_roles(ansible_collection_href, opts = {})
+      data, _status_code, _headers = list_roles_with_http_info(ansible_collection_href, opts)
+      data
+    end
+
+    # List roles assigned to this object.
+    # @param ansible_collection_href [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<(ObjectRolesResponse, Integer, Hash)>] ObjectRolesResponse data, response status code and response headers
+    def list_roles_with_http_info(ansible_collection_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnsibleCollectionsApi.list_roles ...'
+      end
+      # verify the required parameter 'ansible_collection_href' is set
+      if @api_client.config.client_side_validation && ansible_collection_href.nil?
+        fail ArgumentError, "Missing the required parameter 'ansible_collection_href' when calling AnsibleCollectionsApi.list_roles"
+      end
+      # resource path
+      local_var_path = '{ansible_collection_href}list_roles/'.sub('{' + 'ansible_collection_href' + '}', CGI.escape(ansible_collection_href.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] || 'ObjectRolesResponse' 
+
+      # 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: AnsibleCollectionsApi#list_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List permissions available to the current user on this object.
+    # @param ansible_collection_href [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 [MyPermissionsResponse]
+    def my_permissions(ansible_collection_href, opts = {})
+      data, _status_code, _headers = my_permissions_with_http_info(ansible_collection_href, opts)
+      data
+    end
+
+    # List permissions available to the current user on this object.
+    # @param ansible_collection_href [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<(MyPermissionsResponse, Integer, Hash)>] MyPermissionsResponse data, response status code and response headers
+    def my_permissions_with_http_info(ansible_collection_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnsibleCollectionsApi.my_permissions ...'
+      end
+      # verify the required parameter 'ansible_collection_href' is set
+      if @api_client.config.client_side_validation && ansible_collection_href.nil?
+        fail ArgumentError, "Missing the required parameter 'ansible_collection_href' when calling AnsibleCollectionsApi.my_permissions"
+      end
+      # resource path
+      local_var_path = '{ansible_collection_href}my_permissions/'.sub('{' + 'ansible_collection_href' + '}', CGI.escape(ansible_collection_href.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] || 'MyPermissionsResponse' 
+
+      # 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: AnsibleCollectionsApi#my_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Remove a role for this object from users/groups.
+    # @param ansible_collection_href [String] 
+    # @param nested_role [NestedRole] 
+    # @param [Hash] opts the optional parameters
+    # @return [NestedRoleResponse]
+    def remove_role(ansible_collection_href, nested_role, opts = {})
+      data, _status_code, _headers = remove_role_with_http_info(ansible_collection_href, nested_role, opts)
+      data
+    end
+
+    # Remove a role for this object from users/groups.
+    # @param ansible_collection_href [String] 
+    # @param nested_role [NestedRole] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(NestedRoleResponse, Integer, Hash)>] NestedRoleResponse data, response status code and response headers
+    def remove_role_with_http_info(ansible_collection_href, nested_role, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnsibleCollectionsApi.remove_role ...'
+      end
+      # verify the required parameter 'ansible_collection_href' is set
+      if @api_client.config.client_side_validation && ansible_collection_href.nil?
+        fail ArgumentError, "Missing the required parameter 'ansible_collection_href' when calling AnsibleCollectionsApi.remove_role"
+      end
+      # verify the required parameter 'nested_role' is set
+      if @api_client.config.client_side_validation && nested_role.nil?
+        fail ArgumentError, "Missing the required parameter 'nested_role' when calling AnsibleCollectionsApi.remove_role"
+      end
+      # resource path
+      local_var_path = '{ansible_collection_href}remove_role/'.sub('{' + 'ansible_collection_href' + '}', CGI.escape(ansible_collection_href.to_s).gsub('%2F', '/'))
+
+      # 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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(nested_role) 
+
+      # return_type
+      return_type = opts[:return_type] || 'NestedRoleResponse' 
+
+      # 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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnsibleCollectionsApi#remove_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Upload a collection
     # Create an artifact and trigger an asynchronous task to create Collection content from it.
     # @param file [File] The Collection tarball.

data/lib/pulp_ansible_client/api/content_collection_deprecations_api.rb

@@ -88,9 +88,7 @@ module PulpAnsibleClient
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number of results to return per page.
     # @option opts [Integer] :offset The initial index from which to return the results.
-    # @option opts [Array<String>] :ordering Ordering  * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)
-    # @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas.
-    # @option opts [Array<String>] :pulp_id__in Multiple values may be separated by commas.
+    # @option opts [Array<String>] :ordering Ordering
     # @option opts [String] :repository_version Repository Version referenced by HREF
     # @option opts [String] :repository_version_added Repository Version referenced by HREF
     # @option opts [String] :repository_version_removed Repository Version referenced by HREF
@@ -107,9 +105,7 @@ module PulpAnsibleClient
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number of results to return per page.
     # @option opts [Integer] :offset The initial index from which to return the results.
-    # @option opts [Array<String>] :ordering Ordering  * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)
-    # @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas.
-    # @option opts [Array<String>] :pulp_id__in Multiple values may be separated by commas.
+    # @option opts [Array<String>] :ordering Ordering
     # @option opts [String] :repository_version Repository Version referenced by HREF
     # @option opts [String] :repository_version_added Repository Version referenced by HREF
     # @option opts [String] :repository_version_removed Repository Version referenced by HREF
@@ -132,8 +128,6 @@ module PulpAnsibleClient
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
       query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
       query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
-      query_params[:'pulp_href__in'] = @api_client.build_collection_param(opts[:'pulp_href__in'], :csv) if !opts[:'pulp_href__in'].nil?
-      query_params[:'pulp_id__in'] = @api_client.build_collection_param(opts[:'pulp_id__in'], :csv) if !opts[:'pulp_id__in'].nil?
       query_params[:'repository_version'] = opts[:'repository_version'] if !opts[:'repository_version'].nil?
       query_params[:'repository_version_added'] = opts[:'repository_version_added'] if !opts[:'repository_version_added'].nil?
       query_params[:'repository_version_removed'] = opts[:'repository_version_removed'] if !opts[:'repository_version_removed'].nil?