pulp_container_client 2.14.13 → 2.14.14

data/docs/RepairApi.md

@@ -0,0 +1,62 @@
+# PulpContainerClient::RepairApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**post**](RepairApi.md#post) | **POST** /pulp/api/v3/repair/ | Repair Artifact Storage
+
+
+
+## post
+
+> AsyncOperationResponse post(repair)
+
+Repair Artifact Storage
+
+Trigger an asynchronous task that checks for missing or corrupted artifacts, and attempts to redownload them.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::RepairApi.new
+repair = PulpContainerClient::Repair.new # Repair | 
+
+begin
+  #Repair Artifact Storage
+  result = api_instance.post(repair)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling RepairApi->post: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **repair** | [**Repair**](Repair.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/docs/RepositoriesApi.md

@@ -0,0 +1,108 @@
+# PulpContainerClient::RepositoriesApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list**](RepositoriesApi.md#list) | **GET** /pulp/api/v3/repositories/ | List repositories
+
+
+
+## list
+
+> PaginatedRepositoryResponseList list(opts)
+
+List repositories
+
+Endpoint to list all repositories.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::RepositoriesApi.new
+opts = {
+  limit: 56, # Integer | Number of results to return per page.
+  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  * `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) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (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.
+  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
+  pulp_type__in: ['pulp_type__in_example'], # Array<String> | Pulp type is in  * `container.container` - container.container * `container.container-push` - container.container-push
+  remote: 'remote_example', # String | Foreign Key referenced by HREF
+  retain_repo_versions: 56, # Integer | Filter results where retain_repo_versions matches value
+  retain_repo_versions__gt: 56, # Integer | Filter results where retain_repo_versions is greater than value
+  retain_repo_versions__gte: 56, # Integer | Filter results where retain_repo_versions is greater than or equal to value
+  retain_repo_versions__isnull: true, # Boolean | Filter results where retain_repo_versions has a null value
+  retain_repo_versions__lt: 56, # Integer | Filter results where retain_repo_versions is less than value
+  retain_repo_versions__lte: 56, # Integer | Filter results where retain_repo_versions is less than or equal to value
+  retain_repo_versions__ne: 56, # Integer | Filter results where retain_repo_versions not equal to value
+  retain_repo_versions__range: [56], # Array<Integer> | Filter results where retain_repo_versions is between two comma separated 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 repositories
+  result = api_instance.list(opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling RepositoriesApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number of results to return per page. | [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  * &#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;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;next_version&#x60; - Next version * &#x60;-next_version&#x60; - Next version (descending) * &#x60;retain_repo_versions&#x60; - Retain repo versions * &#x60;-retain_repo_versions&#x60; - Retain repo versions (descending) * &#x60;user_hidden&#x60; - User hidden * &#x60;-user_hidden&#x60; - User hidden (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] 
+ **pulp_label_select** | **String**| Filter labels by search string | [optional] 
+ **pulp_type__in** | [**Array&lt;String&gt;**](String.md)| Pulp type is in  * &#x60;container.container&#x60; - container.container * &#x60;container.container-push&#x60; - container.container-push | [optional] 
+ **remote** | **String**| Foreign Key referenced by HREF | [optional] 
+ **retain_repo_versions** | **Integer**| Filter results where retain_repo_versions matches value | [optional] 
+ **retain_repo_versions__gt** | **Integer**| Filter results where retain_repo_versions is greater than value | [optional] 
+ **retain_repo_versions__gte** | **Integer**| Filter results where retain_repo_versions is greater than or equal to value | [optional] 
+ **retain_repo_versions__isnull** | **Boolean**| Filter results where retain_repo_versions has a null value | [optional] 
+ **retain_repo_versions__lt** | **Integer**| Filter results where retain_repo_versions is less than value | [optional] 
+ **retain_repo_versions__lte** | **Integer**| Filter results where retain_repo_versions is less than or equal to value | [optional] 
+ **retain_repo_versions__ne** | **Integer**| Filter results where retain_repo_versions not equal to value | [optional] 
+ **retain_repo_versions__range** | [**Array&lt;Integer&gt;**](Integer.md)| Filter results where retain_repo_versions is between two comma separated 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
+
+[**PaginatedRepositoryResponseList**](PaginatedRepositoryResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/RepositoriesReclaimSpaceApi.md

@@ -0,0 +1,61 @@
+# PulpContainerClient::RepositoriesReclaimSpaceApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**reclaim**](RepositoriesReclaimSpaceApi.md#reclaim) | **POST** /pulp/api/v3/repositories/reclaim_space/ | 
+
+
+
+## reclaim
+
+> AsyncOperationResponse reclaim(reclaim_space)
+
+
+
+Trigger an asynchronous space reclaim operation.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::RepositoriesReclaimSpaceApi.new
+reclaim_space = PulpContainerClient::ReclaimSpace.new # ReclaimSpace | 
+
+begin
+  result = api_instance.reclaim(reclaim_space)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling RepositoriesReclaimSpaceApi->reclaim: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **reclaim_space** | [**ReclaimSpace**](ReclaimSpace.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/docs/RepositoryResponse.md

@@ -0,0 +1,33 @@
+# PulpContainerClient::RepositoryResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**versions_href** | **String** |  | [optional] [readonly] 
+**pulp_labels** | **Hash<String, String>** |  | [optional] 
+**latest_version_href** | **String** |  | [optional] [readonly] 
+**name** | **String** | A unique name for this repository. | 
+**description** | **String** | An optional description. | [optional] 
+**retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. | [optional] 
+**remote** | **String** | An optional remote to use by default when syncing. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::RepositoryResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 versions_href: null,
+                                 pulp_labels: null,
+                                 latest_version_href: null,
+                                 name: null,
+                                 description: null,
+                                 retain_repo_versions: null,
+                                 remote: null)
+```
+
+

data/docs/RepositoryVersionsApi.md

@@ -0,0 +1,102 @@
+# PulpContainerClient::RepositoryVersionsApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list**](RepositoryVersionsApi.md#list) | **GET** /pulp/api/v3/repository_versions/ | List repository versions
+
+
+
+## list
+
+> PaginatedRepositoryVersionResponseList list(opts)
+
+List repository versions
+
+A mixin to hold the shared get_queryset logic used by RepositoryVersionViewSets.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::RepositoryVersionsApi.new
+opts = {
+  content: 'content_example', # String | Content Unit referenced by HREF
+  content__in: 'content__in_example', # String | Content Unit referenced by HREF
+  limit: 56, # Integer | Number of results to return per page.
+  number: 56, # Integer | Filter results where number matches value
+  number__gt: 56, # Integer | Filter results where number is greater than value
+  number__gte: 56, # Integer | Filter results where number is greater than or equal to value
+  number__lt: 56, # Integer | Filter results where number is less than value
+  number__lte: 56, # Integer | Filter results where number is less than or equal to value
+  number__range: [56], # Array<Integer> | Filter results where number is between two comma separated values
+  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) * `number` - Number * `-number` - Number (descending) * `complete` - Complete * `-complete` - Complete (descending) * `info` - Info * `-info` - Info (descending) * `pk` - Pk * `-pk` - Pk (descending)
+  pulp_created: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created matches value
+  pulp_created__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than value
+  pulp_created__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than or equal to value
+  pulp_created__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than value
+  pulp_created__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than or equal to value
+  pulp_created__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array<DateTime> | Filter results where pulp_created is between two comma separated values
+  pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
+  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 repository versions
+  result = api_instance.list(opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling RepositoryVersionsApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **content** | **String**| Content Unit referenced by HREF | [optional] 
+ **content__in** | **String**| Content Unit referenced by HREF | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **number** | **Integer**| Filter results where number matches value | [optional] 
+ **number__gt** | **Integer**| Filter results where number is greater than value | [optional] 
+ **number__gte** | **Integer**| Filter results where number is greater than or equal to value | [optional] 
+ **number__lt** | **Integer**| Filter results where number is less than value | [optional] 
+ **number__lte** | **Integer**| Filter results where number is less than or equal to value | [optional] 
+ **number__range** | [**Array&lt;Integer&gt;**](Integer.md)| Filter results where number is between two comma separated values | [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;number&#x60; - Number * &#x60;-number&#x60; - Number (descending) * &#x60;complete&#x60; - Complete * &#x60;-complete&#x60; - Complete (descending) * &#x60;info&#x60; - Info * &#x60;-info&#x60; - Info (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] 
+ **pulp_created** | **DateTime**| Filter results where pulp_created matches value | [optional] 
+ **pulp_created__gt** | **DateTime**| Filter results where pulp_created is greater than value | [optional] 
+ **pulp_created__gte** | **DateTime**| Filter results where pulp_created is greater than or equal to value | [optional] 
+ **pulp_created__lt** | **DateTime**| Filter results where pulp_created is less than value | [optional] 
+ **pulp_created__lte** | **DateTime**| Filter results where pulp_created is less than or equal to value | [optional] 
+ **pulp_created__range** | [**Array&lt;DateTime&gt;**](DateTime.md)| Filter results where pulp_created is between two comma separated values | [optional] 
+ **pulp_href__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [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
+
+[**PaginatedRepositoryVersionResponseList**](PaginatedRepositoryVersionResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Role.md

@@ -0,0 +1,21 @@
+# PulpContainerClient::Role
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of this role. | 
+**description** | **String** | An optional description. | [optional] 
+**permissions** | **Array<String>** | List of permissions defining the role. | 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::Role.new(name: null,
+                                 description: null,
+                                 permissions: null)
+```
+
+

data/docs/RoleResponse.md

@@ -0,0 +1,27 @@
+# PulpContainerClient::RoleResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**name** | **String** | The name of this role. | 
+**description** | **String** | An optional description. | [optional] 
+**permissions** | **Array<String>** | List of permissions defining the role. | 
+**locked** | **Boolean** | True if the role is system managed. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::RoleResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 name: null,
+                                 description: null,
+                                 permissions: null,
+                                 locked: null)
+```
+
+