pulp_ansible_client 0.16.3 → 0.17.0

data/docs/DistributionsAnsibleApi.md

@@ -4,15 +4,73 @@ All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**add_role**](DistributionsAnsibleApi.md#add_role) | **POST** {ansible_ansible_distribution_href}add_role/ | 
 [**create**](DistributionsAnsibleApi.md#create) | **POST** /pulp/api/v3/distributions/ansible/ansible/ | Create an ansible distribution
 [**delete**](DistributionsAnsibleApi.md#delete) | **DELETE** {ansible_ansible_distribution_href} | Delete an ansible distribution
 [**list**](DistributionsAnsibleApi.md#list) | **GET** /pulp/api/v3/distributions/ansible/ansible/ | List ansible distributions
+[**list_roles**](DistributionsAnsibleApi.md#list_roles) | **GET** {ansible_ansible_distribution_href}list_roles/ | 
+[**my_permissions**](DistributionsAnsibleApi.md#my_permissions) | **GET** {ansible_ansible_distribution_href}my_permissions/ | 
 [**partial_update**](DistributionsAnsibleApi.md#partial_update) | **PATCH** {ansible_ansible_distribution_href} | Update an ansible distribution
 [**read**](DistributionsAnsibleApi.md#read) | **GET** {ansible_ansible_distribution_href} | Inspect an ansible distribution
+[**remove_role**](DistributionsAnsibleApi.md#remove_role) | **POST** {ansible_ansible_distribution_href}remove_role/ | 
 [**update**](DistributionsAnsibleApi.md#update) | **PUT** {ansible_ansible_distribution_href} | Update an ansible distribution
 
 
 
+## add_role
+
+> NestedRoleResponse add_role(ansible_ansible_distribution_href, nested_role)
+
+
+
+Add a role for this object to users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::DistributionsAnsibleApi.new
+ansible_ansible_distribution_href = 'ansible_ansible_distribution_href_example' # String | 
+nested_role = PulpAnsibleClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.add_role(ansible_ansible_distribution_href, nested_role)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling DistributionsAnsibleApi->add_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_ansible_distribution_href** | **String**|  | 
+ **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+
+### Return type
+
+[**NestedRoleResponse**](NestedRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## create
 
 > AsyncOperationResponse create(ansible_ansible_distribution)
@@ -152,9 +210,7 @@ opts = {
   name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
   name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
   offset: 56, # Integer | The initial index from which to return the results.
-  ordering: ['ordering_example'], # Array<String> | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `pk` - Pk * `-pk` - Pk (descending)
-  pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
-  pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
+  ordering: ['ordering_example'], # Array<String> | Ordering
   pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
   repository: 'repository_example', # String | Filter results where repository matches value
   repository__in: ['repository__in_example'], # Array<String> | Filter results where repository is in a comma-separated list of values
@@ -188,9 +244,7 @@ Name | Type | Description  | Notes
  **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional] 
  **name__startswith** | **String**| Filter results where name starts with value | [optional] 
  **offset** | **Integer**| The initial index from which to return the results. | [optional] 
- **ordering** | [**Array&lt;String&gt;**](String.md)| 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;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;base_path&#x60; - Base path * &#x60;-base_path&#x60; - Base path (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] 
- **pulp_href__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
- **pulp_id__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional] 
  **pulp_label_select** | **String**| Filter labels by search string | [optional] 
  **repository** | **String**| Filter results where repository matches value | [optional] 
  **repository__in** | [**Array&lt;String&gt;**](String.md)| Filter results where repository is in a comma-separated list of values | [optional] 
@@ -212,6 +266,122 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## list_roles
+
+> ObjectRolesResponse list_roles(ansible_ansible_distribution_href, opts)
+
+
+
+List roles assigned to this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::DistributionsAnsibleApi.new
+ansible_ansible_distribution_href = 'ansible_ansible_distribution_href_example' # String | 
+opts = {
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  result = api_instance.list_roles(ansible_ansible_distribution_href, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling DistributionsAnsibleApi->list_roles: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_ansible_distribution_href** | **String**|  | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**ObjectRolesResponse**](ObjectRolesResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## my_permissions
+
+> MyPermissionsResponse my_permissions(ansible_ansible_distribution_href, opts)
+
+
+
+List permissions available to the current user on this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::DistributionsAnsibleApi.new
+ansible_ansible_distribution_href = 'ansible_ansible_distribution_href_example' # String | 
+opts = {
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  result = api_instance.my_permissions(ansible_ansible_distribution_href, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling DistributionsAnsibleApi->my_permissions: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_ansible_distribution_href** | **String**|  | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**MyPermissionsResponse**](MyPermissionsResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## partial_update
 
 > AsyncOperationResponse partial_update(ansible_ansible_distribution_href, patchedansible_ansible_distribution)
@@ -326,6 +496,60 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## remove_role
+
+> NestedRoleResponse remove_role(ansible_ansible_distribution_href, nested_role)
+
+
+
+Remove a role for this object from users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::DistributionsAnsibleApi.new
+ansible_ansible_distribution_href = 'ansible_ansible_distribution_href_example' # String | 
+nested_role = PulpAnsibleClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.remove_role(ansible_ansible_distribution_href, nested_role)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling DistributionsAnsibleApi->remove_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_ansible_distribution_href** | **String**|  | 
+ **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+
+### Return type
+
+[**NestedRoleResponse**](NestedRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## update
 
 > AsyncOperationResponse update(ansible_ansible_distribution_href, ansible_ansible_distribution)

data/docs/GalaxyCollectionResponse.md

@@ -6,12 +6,12 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** |  | 
 **name** | **String** |  | 
-**namespace** | [**Object**](.md) | Create a namespace dict. | [optional] [readonly] 
-**href** | **String** | Get href. | [optional] [readonly] 
-**versions_url** | **String** | Get versions_url. | [optional] [readonly] 
+**namespace** | [**Object**](.md) |  | [optional] [readonly] 
+**href** | **String** |  | [optional] [readonly] 
+**versions_url** | **String** |  | [optional] [readonly] 
 **created** | **DateTime** |  | 
 **modified** | **DateTime** |  | 
-**latest_version** | [**Object**](.md) | Get latest version. | [optional] [readonly] 
+**latest_version** | [**Object**](.md) |  | [optional] [readonly] 
 
 ## Code Sample
 

data/docs/GalaxyCollectionVersionResponse.md

@@ -5,10 +5,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **version** | **String** |  | 
-**href** | **String** | Get href. | [optional] [readonly] 
-**namespace** | [**Object**](.md) | Create a namespace dict. | [optional] [readonly] 
-**collection** | [**Object**](.md) | Create a collection dict. | [optional] [readonly] 
-**artifact** | [**Object**](.md) | Create an artifact dict. | [optional] [readonly] 
+**href** | **String** |  | [optional] [readonly] 
+**namespace** | [**Object**](.md) |  | [optional] [readonly] 
+**collection** | [**Object**](.md) |  | [optional] [readonly] 
+**artifact** | [**Object**](.md) |  | [optional] [readonly] 
 **metadata** | [**CollectionMetadataResponse**](CollectionMetadataResponse.md) |  | 
 
 ## Code Sample

data/docs/GalaxyRoleResponse.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** | Get id. | [optional] [readonly] 
+**id** | **String** |  | [optional] [readonly] 
 **name** | **String** |  | 
 **namespace** | **String** |  | 
 

data/docs/GalaxyRoleVersionResponse.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** |  | 
-**source** | **String** | Get source. | [optional] [readonly] 
+**source** | **String** |  | [optional] [readonly] 
 
 ## Code Sample
 

data/docs/MyPermissionsResponse.md

@@ -0,0 +1,17 @@
+# PulpAnsibleClient::MyPermissionsResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**permissions** | **Array<String>** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpAnsibleClient'
+
+instance = PulpAnsibleClient::MyPermissionsResponse.new(permissions: null)
+```
+
+

data/docs/NamespaceLink.md

@@ -0,0 +1,19 @@
+# PulpAnsibleClient::NamespaceLink
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | 
+**name** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpAnsibleClient'
+
+instance = PulpAnsibleClient::NamespaceLink.new(url: null,
+                                 name: null)
+```
+
+

data/docs/NamespaceLinkResponse.md

@@ -0,0 +1,19 @@
+# PulpAnsibleClient::NamespaceLinkResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | 
+**name** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpAnsibleClient'
+
+instance = PulpAnsibleClient::NamespaceLinkResponse.new(url: null,
+                                 name: null)
+```
+
+

data/docs/NestedRole.md

@@ -0,0 +1,21 @@
+# PulpAnsibleClient::NestedRole
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**users** | **Array<String>** |  | [optional] 
+**groups** | **Array<String>** |  | [optional] 
+**role** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpAnsibleClient'
+
+instance = PulpAnsibleClient::NestedRole.new(users: null,
+                                 groups: null,
+                                 role: null)
+```
+
+

data/docs/NestedRoleResponse.md

@@ -0,0 +1,21 @@
+# PulpAnsibleClient::NestedRoleResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**users** | **Array<String>** |  | [optional] 
+**groups** | **Array<String>** |  | [optional] 
+**role** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpAnsibleClient'
+
+instance = PulpAnsibleClient::NestedRoleResponse.new(users: null,
+                                 groups: null,
+                                 role: null)
+```
+
+

data/docs/ObjectRolesResponse.md

@@ -0,0 +1,17 @@
+# PulpAnsibleClient::ObjectRolesResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**roles** | [**Array<NestedRoleResponse>**](NestedRoleResponse.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpAnsibleClient'
+
+instance = PulpAnsibleClient::ObjectRolesResponse.new(roles: null)
+```
+
+

data/docs/PaginatedCollectionVersionSearchListResponseList.md

@@ -0,0 +1,21 @@
+# PulpAnsibleClient::PaginatedCollectionVersionSearchListResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**PaginatedCollectionResponseListMeta**](PaginatedCollectionResponseListMeta.md) |  | [optional] 
+**links** | [**PaginatedCollectionResponseListLinks**](PaginatedCollectionResponseListLinks.md) |  | [optional] 
+**data** | [**Array<CollectionVersionSearchListResponse>**](CollectionVersionSearchListResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpAnsibleClient'
+
+instance = PulpAnsibleClient::PaginatedCollectionVersionSearchListResponseList.new(meta: null,
+                                 links: null,
+                                 data: null)
+```
+
+

data/docs/PaginatedansibleAnsibleNamespaceMetadataResponseList.md

@@ -0,0 +1,23 @@
+# PulpAnsibleClient::PaginatedansibleAnsibleNamespaceMetadataResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<AnsibleAnsibleNamespaceMetadataResponse>**](AnsibleAnsibleNamespaceMetadataResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpAnsibleClient'
+
+instance = PulpAnsibleClient::PaginatedansibleAnsibleNamespaceMetadataResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedansibleCollectionVersionMarkResponseList.md

@@ -0,0 +1,23 @@
+# PulpAnsibleClient::PaginatedansibleCollectionVersionMarkResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<AnsibleCollectionVersionMarkResponse>**](AnsibleCollectionVersionMarkResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpAnsibleClient'
+
+instance = PulpAnsibleClient::PaginatedansibleCollectionVersionMarkResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PatchedansibleAnsibleNamespaceMetadata.md

@@ -0,0 +1,29 @@
+# PulpAnsibleClient::PatchedansibleAnsibleNamespaceMetadata
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Required named, only accepts lowercase, numbers and underscores. | [optional] 
+**company** | **String** | Optional namespace company owner. | [optional] 
+**email** | **String** | Optional namespace contact email. | [optional] 
+**description** | **String** | Optional short description. | [optional] 
+**resources** | **String** | Optional resource page in markdown format. | [optional] 
+**links** | [**Array<NamespaceLink>**](NamespaceLink.md) | Labeled related links. | [optional] 
+**avatar** | **File** | Optional avatar image for Namespace | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpAnsibleClient'
+
+instance = PulpAnsibleClient::PatchedansibleAnsibleNamespaceMetadata.new(name: null,
+                                 company: null,
+                                 email: null,
+                                 description: null,
+                                 resources: null,
+                                 links: null,
+                                 avatar: null)
+```
+
+

data/docs/PatchedansibleAnsibleRepository.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **remote** | **String** | An optional remote to use by default when syncing. | [optional] 
 **last_synced_metadata_time** | **DateTime** | Last synced metadata time. | [optional] 
 **gpgkey** | **String** | Gpg public key to verify collection signatures against | [optional] 
+**private** | **Boolean** |  | [optional] 
 
 ## Code Sample
 
@@ -23,7 +24,8 @@ instance = PulpAnsibleClient::PatchedansibleAnsibleRepository.new(pulp_labels: n
                                  retain_repo_versions: null,
                                  remote: null,
                                  last_synced_metadata_time: null,
-                                 gpgkey: null)
+                                 gpgkey: null,
+                                 private: null)
 ```
 
 

data/docs/PatchedansibleCollectionRemote.md

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
 **pulp_labels** | **Hash<String, String>** |  | [optional] 
 **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] 
 **max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional] 
-**policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content.  * `immediate` - immediate * `When syncing, download all metadata and content now.` - When syncing, download all metadata and content now. | [optional] 
+**policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. | [optional] 
 **total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
 **connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
 **sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]