pulp_ansible_client 0.16.6 → 0.17.0

data/docs/ContentCollectionMarksApi.md

@@ -0,0 +1,198 @@
+# PulpAnsibleClient::ContentCollectionMarksApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](ContentCollectionMarksApi.md#create) | **POST** /pulp/api/v3/content/ansible/collection_marks/ | Create a collection version mark
+[**list**](ContentCollectionMarksApi.md#list) | **GET** /pulp/api/v3/content/ansible/collection_marks/ | List collection version marks
+[**read**](ContentCollectionMarksApi.md#read) | **GET** {ansible_collection_version_mark_href} | Inspect a collection version mark
+
+
+
+## create
+
+> AnsibleCollectionVersionMarkResponse create(ansible_collection_version_mark)
+
+Create a collection version mark
+
+ViewSet for looking at mark objects for CollectionVersion content.
+
+### 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::ContentCollectionMarksApi.new
+ansible_collection_version_mark = PulpAnsibleClient::AnsibleCollectionVersionMark.new # AnsibleCollectionVersionMark | 
+
+begin
+  #Create a collection version mark
+  result = api_instance.create(ansible_collection_version_mark)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling ContentCollectionMarksApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_collection_version_mark** | [**AnsibleCollectionVersionMark**](AnsibleCollectionVersionMark.md)|  | 
+
+### Return type
+
+[**AnsibleCollectionVersionMarkResponse**](AnsibleCollectionVersionMarkResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## list
+
+> PaginatedansibleCollectionVersionMarkResponseList list(opts)
+
+List collection version marks
+
+ViewSet for looking at mark objects for CollectionVersion content.
+
+### 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::ContentCollectionMarksApi.new
+opts = {
+  limit: 56, # Integer | Number of results to return per page.
+  marked_collection: 'marked_collection_example', # String | Filter marks for collection version
+  offset: 56, # Integer | The initial index from which to return the results.
+  ordering: ['ordering_example'], # Array<String> | Ordering
+  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
+  repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF
+  repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF
+  value: 'value_example', # String | Filter marks by value
+  value__in: ['value__in_example'], # Array<String> | Filter results where value is in a comma-separated list of values
+  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
+  #List collection version marks
+  result = api_instance.list(opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling ContentCollectionMarksApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **marked_collection** | **String**| Filter marks for collection version | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional] 
+ **repository_version** | **String**| Repository Version referenced by HREF | [optional] 
+ **repository_version_added** | **String**| Repository Version referenced by HREF | [optional] 
+ **repository_version_removed** | **String**| Repository Version referenced by HREF | [optional] 
+ **value** | **String**| Filter marks by value | [optional] 
+ **value__in** | [**Array&lt;String&gt;**](String.md)| Filter results where value is in a comma-separated list of values | [optional] 
+ **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
+
+[**PaginatedansibleCollectionVersionMarkResponseList**](PaginatedansibleCollectionVersionMarkResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> AnsibleCollectionVersionMarkResponse read(ansible_collection_version_mark_href, opts)
+
+Inspect a collection version mark
+
+ViewSet for looking at mark objects for CollectionVersion content.
+
+### 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::ContentCollectionMarksApi.new
+ansible_collection_version_mark_href = 'ansible_collection_version_mark_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
+  #Inspect a collection version mark
+  result = api_instance.read(ansible_collection_version_mark_href, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling ContentCollectionMarksApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_collection_version_mark_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
+
+[**AnsibleCollectionVersionMarkResponse**](AnsibleCollectionVersionMarkResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ContentCollectionSignaturesApi.md

@@ -1,6 +1,6 @@
 # PulpAnsibleClient::ContentCollectionSignaturesApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/ContentCollectionVersionsApi.md

@@ -1,6 +1,6 @@
 # PulpAnsibleClient::ContentCollectionVersionsApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
@@ -32,10 +32,10 @@ end
 
 api_instance = PulpAnsibleClient::ContentCollectionVersionsApi.new
 opts = {
-  upload: 'upload_example', # String | An uncommitted upload that may be turned into the artifact of the content unit.
   file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
-  repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
   artifact: 'artifact_example', # String | Artifact file representing the physical content
+  upload: 'upload_example', # String | An uncommitted upload that may be turned into the artifact of the content unit.
+  repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
   expected_name: 'expected_name_example', # String | The name of the collection.
   expected_namespace: 'expected_namespace_example', # String | The namespace of the collection.
   expected_version: 'expected_version_example' # String | The version of the collection.
@@ -55,10 +55,10 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **upload** | **String**| An uncommitted upload that may be turned into the artifact of the content unit. | [optional] 
  **file** | **File**| An uploaded file that may be turned into the artifact of the content unit. | [optional] 
- **repository** | **String**| A URI of a repository the new content unit should be associated with. | [optional] 
  **artifact** | **String**| Artifact file representing the physical content | [optional] 
+ **upload** | **String**| An uncommitted upload that may be turned into the artifact of the content unit. | [optional] 
+ **repository** | **String**| A URI of a repository the new content unit should be associated with. | [optional] 
  **expected_name** | **String**| The name of the collection. | [optional] 
  **expected_namespace** | **String**| The namespace of the collection. | [optional] 
  **expected_version** | **String**| The version of the collection. | [optional] 

data/docs/ContentNamespacesApi.md

@@ -0,0 +1,220 @@
+# PulpAnsibleClient::ContentNamespacesApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**avatar**](ContentNamespacesApi.md#avatar) | **GET** {ansible_ansible_namespace_metadata_href}avatar/ | 
+[**list**](ContentNamespacesApi.md#list) | **GET** /pulp/api/v3/content/ansible/namespaces/ | List ansible namespace metadatas
+[**read**](ContentNamespacesApi.md#read) | **GET** {ansible_ansible_namespace_metadata_href} | Inspect an ansible namespace metadata
+
+
+
+## avatar
+
+> avatar(ansible_ansible_namespace_metadata_href, opts)
+
+
+
+Get the logo for the this namespace.
+
+### 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::ContentNamespacesApi.new
+ansible_ansible_namespace_metadata_href = 'ansible_ansible_namespace_metadata_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
+  api_instance.avatar(ansible_ansible_namespace_metadata_href, opts)
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling ContentNamespacesApi->avatar: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_ansible_namespace_metadata_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
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> PaginatedansibleAnsibleNamespaceMetadataResponseList list(opts)
+
+List ansible namespace metadatas
+
+ViewSet for AnsibleNamespace.
+
+### 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::ContentNamespacesApi.new
+opts = {
+  company: 'company_example', # String | Filter results where company matches value
+  company__contains: 'company__contains_example', # String | Filter results where company contains value
+  company__icontains: 'company__icontains_example', # String | Filter results where company contains value
+  company__in: ['company__in_example'], # Array<String> | Filter results where company is in a comma-separated list of values
+  company__startswith: 'company__startswith_example', # String | Filter results where company starts with value
+  limit: 56, # Integer | Number of results to return per page.
+  metadata_sha256: 'metadata_sha256_example', # String | Filter results where metadata_sha256 matches value
+  metadata_sha256__in: ['metadata_sha256__in_example'], # Array<String> | Filter results where metadata_sha256 is in a comma-separated list of values
+  name: 'name_example', # String | Filter results where name matches value
+  name__contains: 'name__contains_example', # String | Filter results where name contains value
+  name__icontains: 'name__icontains_example', # String | Filter results where name contains value
+  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
+  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
+  repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF
+  repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF
+  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
+  #List ansible namespace metadatas
+  result = api_instance.list(opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling ContentNamespacesApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **company** | **String**| Filter results where company matches value | [optional] 
+ **company__contains** | **String**| Filter results where company contains value | [optional] 
+ **company__icontains** | **String**| Filter results where company contains value | [optional] 
+ **company__in** | [**Array&lt;String&gt;**](String.md)| Filter results where company is in a comma-separated list of values | [optional] 
+ **company__startswith** | **String**| Filter results where company starts with value | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **metadata_sha256** | **String**| Filter results where metadata_sha256 matches value | [optional] 
+ **metadata_sha256__in** | [**Array&lt;String&gt;**](String.md)| Filter results where metadata_sha256 is in a comma-separated list of values | [optional] 
+ **name** | **String**| Filter results where name matches value | [optional] 
+ **name__contains** | **String**| Filter results where name contains value | [optional] 
+ **name__icontains** | **String**| Filter results where name contains value | [optional] 
+ **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 | [optional] 
+ **repository_version** | **String**| Repository Version referenced by HREF | [optional] 
+ **repository_version_added** | **String**| Repository Version referenced by HREF | [optional] 
+ **repository_version_removed** | **String**| Repository Version referenced by HREF | [optional] 
+ **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
+
+[**PaginatedansibleAnsibleNamespaceMetadataResponseList**](PaginatedansibleAnsibleNamespaceMetadataResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> AnsibleAnsibleNamespaceMetadataResponse read(ansible_ansible_namespace_metadata_href, opts)
+
+Inspect an ansible namespace metadata
+
+ViewSet for AnsibleNamespace.
+
+### 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::ContentNamespacesApi.new
+ansible_ansible_namespace_metadata_href = 'ansible_ansible_namespace_metadata_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
+  #Inspect an ansible namespace metadata
+  result = api_instance.read(ansible_ansible_namespace_metadata_href, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling ContentNamespacesApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_ansible_namespace_metadata_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
+
+[**AnsibleAnsibleNamespaceMetadataResponse**](AnsibleAnsibleNamespaceMetadataResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ContentRolesApi.md

@@ -1,6 +1,6 @@
 # PulpAnsibleClient::ContentRolesApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------