pulp_container_client 2.14.16 → 2.15.0

data/docs/RepositoryResponse.md

@@ -1,33 +0,0 @@
-# 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. This is provided as a tech preview in Pulp 3 and may change in the future. | [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

@@ -1,98 +0,0 @@
-# PulpContainerClient::RepositoryVersionsApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**repository_versions_list**](RepositoryVersionsApi.md#repository_versions_list) | **GET** /pulp/api/v3/repository_versions/ | List repository versions
-
-
-
-## repository_versions_list
-
-> PaginatedRepositoryVersionResponseList repository_versions_list(opts)
-
-List repository versions
-
-### 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_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
-  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.repository_versions_list(opts)
-  p result
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling RepositoryVersionsApi->repository_versions_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 | [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] 
- **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

@@ -1,21 +0,0 @@
-# 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

@@ -1,27 +0,0 @@
-# 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)
-```
-
-

data/docs/RolesApi.md

@@ -1,375 +0,0 @@
-# PulpContainerClient::RolesApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**roles_create**](RolesApi.md#roles_create) | **POST** /pulp/api/v3/roles/ | Create a role
-[**roles_delete**](RolesApi.md#roles_delete) | **DELETE** {role_href} | Delete a role
-[**roles_list**](RolesApi.md#roles_list) | **GET** /pulp/api/v3/roles/ | List roles
-[**roles_partial_update**](RolesApi.md#roles_partial_update) | **PATCH** {role_href} | Update a role
-[**roles_read**](RolesApi.md#roles_read) | **GET** {role_href} | Inspect a role
-[**roles_update**](RolesApi.md#roles_update) | **PUT** {role_href} | Update a role
-
-
-
-## roles_create
-
-> RoleResponse roles_create(role)
-
-Create a role
-
-ViewSet for Role.  NOTE: This API endpoint is in \"tech preview\" and subject to change
-
-### 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::RolesApi.new
-role = PulpContainerClient::Role.new # Role | 
-
-begin
-  #Create a role
-  result = api_instance.roles_create(role)
-  p result
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling RolesApi->roles_create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **role** | [**Role**](Role.md)|  | 
-
-### Return type
-
-[**RoleResponse**](RoleResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
-## roles_delete
-
-> roles_delete(role_href)
-
-Delete a role
-
-ViewSet for Role.  NOTE: This API endpoint is in \"tech preview\" and subject to change
-
-### 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::RolesApi.new
-role_href = 'role_href_example' # String | 
-
-begin
-  #Delete a role
-  api_instance.roles_delete(role_href)
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling RolesApi->roles_delete: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **role_href** | **String**|  | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-
-
-## roles_list
-
-> PaginatedRoleResponseList roles_list(opts)
-
-List roles
-
-ViewSet for Role.  NOTE: This API endpoint is in \"tech preview\" and subject to change
-
-### 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::RolesApi.new
-opts = {
-  contains_permission: ['contains_permission_example'], # Array<String> | Filter roles that have any of the permissions in the list.
-  description: 'description_example', # String | Filter results where description matches value
-  description__contains: 'description__contains_example', # String | Filter results where description contains value
-  description__icontains: 'description__icontains_example', # String | Filter results where description contains value
-  description__iexact: 'description__iexact_example', # String | Filter results where description matches value
-  for_object_type: 'for_object_type_example', # String | Filter roles that only have permissions for the specified object HREF.
-  limit: 56, # Integer | Number of results to return per page.
-  locked: true, # Boolean | Filter results where locked matches value
-  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
-  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 roles
-  result = api_instance.roles_list(opts)
-  p result
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling RolesApi->roles_list: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **contains_permission** | [**Array&lt;String&gt;**](String.md)| Filter roles that have any of the permissions in the list. | [optional] 
- **description** | **String**| Filter results where description matches value | [optional] 
- **description__contains** | **String**| Filter results where description contains value | [optional] 
- **description__icontains** | **String**| Filter results where description contains value | [optional] 
- **description__iexact** | **String**| Filter results where description matches value | [optional] 
- **for_object_type** | **String**| Filter roles that only have permissions for the specified object HREF. | [optional] 
- **limit** | **Integer**| Number of results to return per page. | [optional] 
- **locked** | **Boolean**| Filter results where locked matches value | [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] 
- **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
-
-[**PaginatedRoleResponseList**](PaginatedRoleResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## roles_partial_update
-
-> RoleResponse roles_partial_update(role_href, patched_role)
-
-Update a role
-
-ViewSet for Role.  NOTE: This API endpoint is in \"tech preview\" and subject to change
-
-### 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::RolesApi.new
-role_href = 'role_href_example' # String | 
-patched_role = PulpContainerClient::PatchedRole.new # PatchedRole | 
-
-begin
-  #Update a role
-  result = api_instance.roles_partial_update(role_href, patched_role)
-  p result
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling RolesApi->roles_partial_update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **role_href** | **String**|  | 
- **patched_role** | [**PatchedRole**](PatchedRole.md)|  | 
-
-### Return type
-
-[**RoleResponse**](RoleResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
-## roles_read
-
-> RoleResponse roles_read(role_href, opts)
-
-Inspect a role
-
-ViewSet for Role.  NOTE: This API endpoint is in \"tech preview\" and subject to change
-
-### 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::RolesApi.new
-role_href = 'role_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 role
-  result = api_instance.roles_read(role_href, opts)
-  p result
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling RolesApi->roles_read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **role_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
-
-[**RoleResponse**](RoleResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## roles_update
-
-> RoleResponse roles_update(role_href, role)
-
-Update a role
-
-ViewSet for Role.  NOTE: This API endpoint is in \"tech preview\" and subject to change
-
-### 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::RolesApi.new
-role_href = 'role_href_example' # String | 
-role = PulpContainerClient::Role.new # Role | 
-
-begin
-  #Update a role
-  result = api_instance.roles_update(role_href, role)
-  p result
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling RolesApi->roles_update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **role_href** | **String**|  | 
- **role** | [**Role**](Role.md)|  | 
-
-### Return type
-
-[**RoleResponse**](RoleResponse.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/SigningServiceResponse.md

@@ -1,27 +0,0 @@
-# PulpContainerClient::SigningServiceResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
-**name** | **String** | A unique name used to recognize a script. | 
-**public_key** | **String** | The value of a public key used for the repository verification. | 
-**pubkey_fingerprint** | **String** | The fingerprint of the public key. | 
-**script** | **String** | An absolute path to a script which is going to be used for the signing. | 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::SigningServiceResponse.new(pulp_href: null,
-                                 pulp_created: null,
-                                 name: null,
-                                 public_key: null,
-                                 pubkey_fingerprint: null,
-                                 script: null)
-```
-
-