pulp_cookbook_client 0.1.0b9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +162 -0
- data/Rakefile +10 -0
- data/docs/AsyncOperationResponse.md +17 -0
- data/docs/ContentCookbooksApi.md +208 -0
- data/docs/ContentSummary.md +21 -0
- data/docs/ContentSummaryResponse.md +21 -0
- data/docs/CookbookCookbookDistribution.md +27 -0
- data/docs/CookbookCookbookDistributionResponse.md +33 -0
- data/docs/CookbookCookbookPackageContent.md +25 -0
- data/docs/CookbookCookbookPackageContentResponse.md +29 -0
- data/docs/CookbookCookbookPublication.md +19 -0
- data/docs/CookbookCookbookPublicationResponse.md +25 -0
- data/docs/CookbookCookbookRemote.md +59 -0
- data/docs/CookbookCookbookRemoteResponse.md +55 -0
- data/docs/CookbookCookbookRepository.md +25 -0
- data/docs/CookbookCookbookRepositoryResponse.md +33 -0
- data/docs/DistributionsCookbookApi.md +372 -0
- data/docs/PaginatedRepositoryVersionResponseList.md +23 -0
- data/docs/PaginatedcookbookCookbookDistributionResponseList.md +23 -0
- data/docs/PaginatedcookbookCookbookPackageContentResponseList.md +23 -0
- data/docs/PaginatedcookbookCookbookPublicationResponseList.md +23 -0
- data/docs/PaginatedcookbookCookbookRemoteResponseList.md +23 -0
- data/docs/PaginatedcookbookCookbookRepositoryResponseList.md +23 -0
- data/docs/PatchedcookbookCookbookDistribution.md +27 -0
- data/docs/PatchedcookbookCookbookRemote.md +59 -0
- data/docs/PatchedcookbookCookbookRepository.md +25 -0
- data/docs/PolicyEnum.md +16 -0
- data/docs/PublicationsCookbookApi.md +257 -0
- data/docs/RemotesCookbookApi.md +376 -0
- data/docs/RepositoriesCookbookApi.md +475 -0
- data/docs/RepositoriesCookbookVersionsApi.md +271 -0
- data/docs/RepositoryAddRemoveContent.md +21 -0
- data/docs/RepositorySyncURL.md +19 -0
- data/docs/RepositoryVersion.md +17 -0
- data/docs/RepositoryVersionResponse.md +27 -0
- data/git_push.sh +58 -0
- data/lib/pulp_cookbook_client/api/content_cookbooks_api.rb +264 -0
- data/lib/pulp_cookbook_client/api/distributions_cookbook_api.rb +457 -0
- data/lib/pulp_cookbook_client/api/publications_cookbook_api.rb +312 -0
- data/lib/pulp_cookbook_client/api/remotes_cookbook_api.rb +463 -0
- data/lib/pulp_cookbook_client/api/repositories_cookbook_api.rb +583 -0
- data/lib/pulp_cookbook_client/api/repositories_cookbook_versions_api.rb +339 -0
- data/lib/pulp_cookbook_client/api_client.rb +406 -0
- data/lib/pulp_cookbook_client/api_error.rb +57 -0
- data/lib/pulp_cookbook_client/configuration.rb +250 -0
- data/lib/pulp_cookbook_client/models/async_operation_response.rb +213 -0
- data/lib/pulp_cookbook_client/models/content_summary.rb +246 -0
- data/lib/pulp_cookbook_client/models/content_summary_response.rb +246 -0
- data/lib/pulp_cookbook_client/models/cookbook_cookbook_distribution.rb +308 -0
- data/lib/pulp_cookbook_client/models/cookbook_cookbook_distribution_response.rb +299 -0
- data/lib/pulp_cookbook_client/models/cookbook_cookbook_package_content.rb +287 -0
- data/lib/pulp_cookbook_client/models/cookbook_cookbook_package_content_response.rb +272 -0
- data/lib/pulp_cookbook_client/models/cookbook_cookbook_publication.rb +217 -0
- data/lib/pulp_cookbook_client/models/cookbook_cookbook_publication_response.rb +248 -0
- data/lib/pulp_cookbook_client/models/cookbook_cookbook_remote.rb +677 -0
- data/lib/pulp_cookbook_client/models/cookbook_cookbook_remote_response.rb +493 -0
- data/lib/pulp_cookbook_client/models/cookbook_cookbook_repository.rb +304 -0
- data/lib/pulp_cookbook_client/models/cookbook_cookbook_repository_response.rb +307 -0
- data/lib/pulp_cookbook_client/models/paginated_repository_version_response_list.rb +237 -0
- data/lib/pulp_cookbook_client/models/paginatedcookbook_cookbook_distribution_response_list.rb +237 -0
- data/lib/pulp_cookbook_client/models/paginatedcookbook_cookbook_package_content_response_list.rb +237 -0
- data/lib/pulp_cookbook_client/models/paginatedcookbook_cookbook_publication_response_list.rb +237 -0
- data/lib/pulp_cookbook_client/models/paginatedcookbook_cookbook_remote_response_list.rb +237 -0
- data/lib/pulp_cookbook_client/models/paginatedcookbook_cookbook_repository_response_list.rb +237 -0
- data/lib/pulp_cookbook_client/models/patchedcookbook_cookbook_distribution.rb +290 -0
- data/lib/pulp_cookbook_client/models/patchedcookbook_cookbook_remote.rb +659 -0
- data/lib/pulp_cookbook_client/models/patchedcookbook_cookbook_repository.rb +295 -0
- data/lib/pulp_cookbook_client/models/policy_enum.rb +37 -0
- data/lib/pulp_cookbook_client/models/repository_add_remove_content.rb +232 -0
- data/lib/pulp_cookbook_client/models/repository_sync_url.rb +220 -0
- data/lib/pulp_cookbook_client/models/repository_version.rb +208 -0
- data/lib/pulp_cookbook_client/models/repository_version_response.rb +255 -0
- data/lib/pulp_cookbook_client/version.rb +15 -0
- data/lib/pulp_cookbook_client.rb +72 -0
- data/pulp_cookbook_client.gemspec +39 -0
- data/spec/api/content_cookbooks_api_spec.rb +87 -0
- data/spec/api/distributions_cookbook_api_spec.rb +125 -0
- data/spec/api/publications_cookbook_api_spec.rb +98 -0
- data/spec/api/remotes_cookbook_api_spec.rb +127 -0
- data/spec/api/repositories_cookbook_api_spec.rb +146 -0
- data/spec/api/repositories_cookbook_versions_api_spec.rb +104 -0
- data/spec/api_client_spec.rb +188 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/async_operation_response_spec.rb +41 -0
- data/spec/models/content_summary_response_spec.rb +53 -0
- data/spec/models/content_summary_spec.rb +53 -0
- data/spec/models/cookbook_cookbook_distribution_response_spec.rb +89 -0
- data/spec/models/cookbook_cookbook_distribution_spec.rb +71 -0
- data/spec/models/cookbook_cookbook_package_content_response_spec.rb +77 -0
- data/spec/models/cookbook_cookbook_package_content_spec.rb +65 -0
- data/spec/models/cookbook_cookbook_publication_response_spec.rb +65 -0
- data/spec/models/cookbook_cookbook_publication_spec.rb +47 -0
- data/spec/models/cookbook_cookbook_remote_response_spec.rb +155 -0
- data/spec/models/cookbook_cookbook_remote_spec.rb +167 -0
- data/spec/models/cookbook_cookbook_repository_response_spec.rb +89 -0
- data/spec/models/cookbook_cookbook_repository_spec.rb +65 -0
- data/spec/models/paginated_repository_version_response_list_spec.rb +59 -0
- data/spec/models/paginatedcookbook_cookbook_distribution_response_list_spec.rb +59 -0
- data/spec/models/paginatedcookbook_cookbook_package_content_response_list_spec.rb +59 -0
- data/spec/models/paginatedcookbook_cookbook_publication_response_list_spec.rb +59 -0
- data/spec/models/paginatedcookbook_cookbook_remote_response_list_spec.rb +59 -0
- data/spec/models/paginatedcookbook_cookbook_repository_response_list_spec.rb +59 -0
- data/spec/models/patchedcookbook_cookbook_distribution_spec.rb +71 -0
- data/spec/models/patchedcookbook_cookbook_remote_spec.rb +167 -0
- data/spec/models/patchedcookbook_cookbook_repository_spec.rb +65 -0
- data/spec/models/policy_enum_spec.rb +35 -0
- data/spec/models/repository_add_remove_content_spec.rb +53 -0
- data/spec/models/repository_sync_url_spec.rb +47 -0
- data/spec/models/repository_version_response_spec.rb +71 -0
- data/spec/models/repository_version_spec.rb +41 -0
- data/spec/spec_helper.rb +111 -0
- metadata +251 -0
@@ -0,0 +1,59 @@
|
|
1
|
+
# PulpCookbookClient::CookbookCookbookRemote
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | A unique name for this remote. |
|
8
|
+
**url** | **String** | The URL of an external content source. |
|
9
|
+
**ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional]
|
10
|
+
**client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional]
|
11
|
+
**client_key** | **String** | A PEM encoded private key used for authentication. | [optional]
|
12
|
+
**tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional]
|
13
|
+
**proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional]
|
14
|
+
**proxy_username** | **String** | The username to authenticte to the proxy. | [optional]
|
15
|
+
**proxy_password** | **String** | The password to authenticte to the proxy. | [optional]
|
16
|
+
**username** | **String** | The username to be used for authentication when syncing. | [optional]
|
17
|
+
**password** | **String** | The password to be used for authentication when syncing. | [optional]
|
18
|
+
**pulp_labels** | [**Object**](.md) | | [optional]
|
19
|
+
**download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional]
|
20
|
+
**max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional]
|
21
|
+
**policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. | [optional]
|
22
|
+
**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]
|
23
|
+
**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]
|
24
|
+
**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]
|
25
|
+
**sock_read_timeout** | **Float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
|
26
|
+
**headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional]
|
27
|
+
**rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional]
|
28
|
+
**cookbooks** | [**Object**](.md) | An optional JSON object in the format {\"<cookbook name>\": \"<version_string>\" }. Used to limit the cookbooks to synchronize from the remote | [optional]
|
29
|
+
|
30
|
+
## Code Sample
|
31
|
+
|
32
|
+
```ruby
|
33
|
+
require 'PulpCookbookClient'
|
34
|
+
|
35
|
+
instance = PulpCookbookClient::CookbookCookbookRemote.new(name: null,
|
36
|
+
url: null,
|
37
|
+
ca_cert: null,
|
38
|
+
client_cert: null,
|
39
|
+
client_key: null,
|
40
|
+
tls_validation: null,
|
41
|
+
proxy_url: null,
|
42
|
+
proxy_username: null,
|
43
|
+
proxy_password: null,
|
44
|
+
username: null,
|
45
|
+
password: null,
|
46
|
+
pulp_labels: null,
|
47
|
+
download_concurrency: null,
|
48
|
+
max_retries: null,
|
49
|
+
policy: null,
|
50
|
+
total_timeout: null,
|
51
|
+
connect_timeout: null,
|
52
|
+
sock_connect_timeout: null,
|
53
|
+
sock_read_timeout: null,
|
54
|
+
headers: null,
|
55
|
+
rate_limit: null,
|
56
|
+
cookbooks: null)
|
57
|
+
```
|
58
|
+
|
59
|
+
|
@@ -0,0 +1,55 @@
|
|
1
|
+
# PulpCookbookClient::CookbookCookbookRemoteResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**pulp_href** | **String** | | [optional] [readonly]
|
8
|
+
**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
|
9
|
+
**name** | **String** | A unique name for this remote. |
|
10
|
+
**url** | **String** | The URL of an external content source. |
|
11
|
+
**ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional]
|
12
|
+
**client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional]
|
13
|
+
**tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional]
|
14
|
+
**proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional]
|
15
|
+
**pulp_labels** | [**Object**](.md) | | [optional]
|
16
|
+
**pulp_last_updated** | **DateTime** | Timestamp of the most recent update of the remote. | [optional] [readonly]
|
17
|
+
**download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional]
|
18
|
+
**max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional]
|
19
|
+
**policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. | [optional]
|
20
|
+
**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]
|
21
|
+
**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]
|
22
|
+
**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]
|
23
|
+
**sock_read_timeout** | **Float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
|
24
|
+
**headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional]
|
25
|
+
**rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional]
|
26
|
+
**cookbooks** | [**Object**](.md) | An optional JSON object in the format {\"<cookbook name>\": \"<version_string>\" }. Used to limit the cookbooks to synchronize from the remote | [optional]
|
27
|
+
|
28
|
+
## Code Sample
|
29
|
+
|
30
|
+
```ruby
|
31
|
+
require 'PulpCookbookClient'
|
32
|
+
|
33
|
+
instance = PulpCookbookClient::CookbookCookbookRemoteResponse.new(pulp_href: null,
|
34
|
+
pulp_created: null,
|
35
|
+
name: null,
|
36
|
+
url: null,
|
37
|
+
ca_cert: null,
|
38
|
+
client_cert: null,
|
39
|
+
tls_validation: null,
|
40
|
+
proxy_url: null,
|
41
|
+
pulp_labels: null,
|
42
|
+
pulp_last_updated: null,
|
43
|
+
download_concurrency: null,
|
44
|
+
max_retries: null,
|
45
|
+
policy: null,
|
46
|
+
total_timeout: null,
|
47
|
+
connect_timeout: null,
|
48
|
+
sock_connect_timeout: null,
|
49
|
+
sock_read_timeout: null,
|
50
|
+
headers: null,
|
51
|
+
rate_limit: null,
|
52
|
+
cookbooks: null)
|
53
|
+
```
|
54
|
+
|
55
|
+
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# PulpCookbookClient::CookbookCookbookRepository
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**pulp_labels** | [**Object**](.md) | | [optional]
|
8
|
+
**name** | **String** | A unique name for this repository. |
|
9
|
+
**description** | **String** | An optional description. | [optional]
|
10
|
+
**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]
|
11
|
+
**remote** | **String** | An optional remote to use by default when syncing. | [optional]
|
12
|
+
|
13
|
+
## Code Sample
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'PulpCookbookClient'
|
17
|
+
|
18
|
+
instance = PulpCookbookClient::CookbookCookbookRepository.new(pulp_labels: null,
|
19
|
+
name: null,
|
20
|
+
description: null,
|
21
|
+
retain_repo_versions: null,
|
22
|
+
remote: null)
|
23
|
+
```
|
24
|
+
|
25
|
+
|
@@ -0,0 +1,33 @@
|
|
1
|
+
# PulpCookbookClient::CookbookCookbookRepositoryResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**pulp_href** | **String** | | [optional] [readonly]
|
8
|
+
**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
|
9
|
+
**versions_href** | **String** | | [optional] [readonly]
|
10
|
+
**pulp_labels** | [**Object**](.md) | | [optional]
|
11
|
+
**latest_version_href** | **String** | | [optional] [readonly]
|
12
|
+
**name** | **String** | A unique name for this repository. |
|
13
|
+
**description** | **String** | An optional description. | [optional]
|
14
|
+
**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]
|
15
|
+
**remote** | **String** | An optional remote to use by default when syncing. | [optional]
|
16
|
+
|
17
|
+
## Code Sample
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'PulpCookbookClient'
|
21
|
+
|
22
|
+
instance = PulpCookbookClient::CookbookCookbookRepositoryResponse.new(pulp_href: null,
|
23
|
+
pulp_created: null,
|
24
|
+
versions_href: null,
|
25
|
+
pulp_labels: null,
|
26
|
+
latest_version_href: null,
|
27
|
+
name: null,
|
28
|
+
description: null,
|
29
|
+
retain_repo_versions: null,
|
30
|
+
remote: null)
|
31
|
+
```
|
32
|
+
|
33
|
+
|
@@ -0,0 +1,372 @@
|
|
1
|
+
# PulpCookbookClient::DistributionsCookbookApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://pulp*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create**](DistributionsCookbookApi.md#create) | **POST** /pulp/api/v3/distributions/cookbook/cookbook/ | Create a cookbook distribution
|
8
|
+
[**delete**](DistributionsCookbookApi.md#delete) | **DELETE** {cookbook_cookbook_distribution_href} | Delete a cookbook distribution
|
9
|
+
[**list**](DistributionsCookbookApi.md#list) | **GET** /pulp/api/v3/distributions/cookbook/cookbook/ | List cookbook distributions
|
10
|
+
[**partial_update**](DistributionsCookbookApi.md#partial_update) | **PATCH** {cookbook_cookbook_distribution_href} | Update a cookbook distribution
|
11
|
+
[**read**](DistributionsCookbookApi.md#read) | **GET** {cookbook_cookbook_distribution_href} | Inspect a cookbook distribution
|
12
|
+
[**update**](DistributionsCookbookApi.md#update) | **PUT** {cookbook_cookbook_distribution_href} | Update a cookbook distribution
|
13
|
+
|
14
|
+
|
15
|
+
|
16
|
+
## create
|
17
|
+
|
18
|
+
> AsyncOperationResponse create(cookbook_cookbook_distribution)
|
19
|
+
|
20
|
+
Create a cookbook distribution
|
21
|
+
|
22
|
+
Trigger an asynchronous create task
|
23
|
+
|
24
|
+
### Example
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
# load the gem
|
28
|
+
require 'pulp_cookbook_client'
|
29
|
+
# setup authorization
|
30
|
+
PulpCookbookClient.configure do |config|
|
31
|
+
# Configure HTTP basic authorization: basicAuth
|
32
|
+
config.username = 'YOUR USERNAME'
|
33
|
+
config.password = 'YOUR PASSWORD'
|
34
|
+
end
|
35
|
+
|
36
|
+
api_instance = PulpCookbookClient::DistributionsCookbookApi.new
|
37
|
+
cookbook_cookbook_distribution = PulpCookbookClient::CookbookCookbookDistribution.new # CookbookCookbookDistribution |
|
38
|
+
|
39
|
+
begin
|
40
|
+
#Create a cookbook distribution
|
41
|
+
result = api_instance.create(cookbook_cookbook_distribution)
|
42
|
+
p result
|
43
|
+
rescue PulpCookbookClient::ApiError => e
|
44
|
+
puts "Exception when calling DistributionsCookbookApi->create: #{e}"
|
45
|
+
end
|
46
|
+
```
|
47
|
+
|
48
|
+
### Parameters
|
49
|
+
|
50
|
+
|
51
|
+
Name | Type | Description | Notes
|
52
|
+
------------- | ------------- | ------------- | -------------
|
53
|
+
**cookbook_cookbook_distribution** | [**CookbookCookbookDistribution**](CookbookCookbookDistribution.md)| |
|
54
|
+
|
55
|
+
### Return type
|
56
|
+
|
57
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
58
|
+
|
59
|
+
### Authorization
|
60
|
+
|
61
|
+
[basicAuth](../README.md#basicAuth)
|
62
|
+
|
63
|
+
### HTTP request headers
|
64
|
+
|
65
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
66
|
+
- **Accept**: application/json
|
67
|
+
|
68
|
+
|
69
|
+
## delete
|
70
|
+
|
71
|
+
> AsyncOperationResponse delete(cookbook_cookbook_distribution_href)
|
72
|
+
|
73
|
+
Delete a cookbook distribution
|
74
|
+
|
75
|
+
Trigger an asynchronous delete task
|
76
|
+
|
77
|
+
### Example
|
78
|
+
|
79
|
+
```ruby
|
80
|
+
# load the gem
|
81
|
+
require 'pulp_cookbook_client'
|
82
|
+
# setup authorization
|
83
|
+
PulpCookbookClient.configure do |config|
|
84
|
+
# Configure HTTP basic authorization: basicAuth
|
85
|
+
config.username = 'YOUR USERNAME'
|
86
|
+
config.password = 'YOUR PASSWORD'
|
87
|
+
end
|
88
|
+
|
89
|
+
api_instance = PulpCookbookClient::DistributionsCookbookApi.new
|
90
|
+
cookbook_cookbook_distribution_href = 'cookbook_cookbook_distribution_href_example' # String |
|
91
|
+
|
92
|
+
begin
|
93
|
+
#Delete a cookbook distribution
|
94
|
+
result = api_instance.delete(cookbook_cookbook_distribution_href)
|
95
|
+
p result
|
96
|
+
rescue PulpCookbookClient::ApiError => e
|
97
|
+
puts "Exception when calling DistributionsCookbookApi->delete: #{e}"
|
98
|
+
end
|
99
|
+
```
|
100
|
+
|
101
|
+
### Parameters
|
102
|
+
|
103
|
+
|
104
|
+
Name | Type | Description | Notes
|
105
|
+
------------- | ------------- | ------------- | -------------
|
106
|
+
**cookbook_cookbook_distribution_href** | **String**| |
|
107
|
+
|
108
|
+
### Return type
|
109
|
+
|
110
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
111
|
+
|
112
|
+
### Authorization
|
113
|
+
|
114
|
+
[basicAuth](../README.md#basicAuth)
|
115
|
+
|
116
|
+
### HTTP request headers
|
117
|
+
|
118
|
+
- **Content-Type**: Not defined
|
119
|
+
- **Accept**: application/json
|
120
|
+
|
121
|
+
|
122
|
+
## list
|
123
|
+
|
124
|
+
> PaginatedcookbookCookbookDistributionResponseList list(opts)
|
125
|
+
|
126
|
+
List cookbook distributions
|
127
|
+
|
128
|
+
Cookbook Distreibution Endpoint. CookbookDistributions host Cookbook Publications which makes the metadata and the referenced Cookbook Content available to clients like berkshelf. Additionally, a CookbookDistribution with an associated CookbookPublication can be the target url of a Cookbook Remote , allowing another instance of Pulp to sync the content.
|
129
|
+
|
130
|
+
### Example
|
131
|
+
|
132
|
+
```ruby
|
133
|
+
# load the gem
|
134
|
+
require 'pulp_cookbook_client'
|
135
|
+
# setup authorization
|
136
|
+
PulpCookbookClient.configure do |config|
|
137
|
+
# Configure HTTP basic authorization: basicAuth
|
138
|
+
config.username = 'YOUR USERNAME'
|
139
|
+
config.password = 'YOUR PASSWORD'
|
140
|
+
end
|
141
|
+
|
142
|
+
api_instance = PulpCookbookClient::DistributionsCookbookApi.new
|
143
|
+
opts = {
|
144
|
+
base_path: 'base_path_example', # String |
|
145
|
+
base_path__contains: 'base_path__contains_example', # String | Filter results where base_path contains value
|
146
|
+
base_path__icontains: 'base_path__icontains_example', # String | Filter results where base_path contains value
|
147
|
+
base_path__in: ['base_path__in_example'], # Array<String> | Filter results where base_path is in a comma-separated list of values
|
148
|
+
limit: 56, # Integer | Number of results to return per page.
|
149
|
+
name: 'name_example', # String |
|
150
|
+
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
151
|
+
name__icontains: 'name__icontains_example', # String | Filter results where name contains value
|
152
|
+
name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
153
|
+
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
|
154
|
+
offset: 56, # Integer | The initial index from which to return the results.
|
155
|
+
ordering: 'ordering_example', # String | Which field to use when ordering the results.
|
156
|
+
pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
|
157
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
158
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
159
|
+
}
|
160
|
+
|
161
|
+
begin
|
162
|
+
#List cookbook distributions
|
163
|
+
result = api_instance.list(opts)
|
164
|
+
p result
|
165
|
+
rescue PulpCookbookClient::ApiError => e
|
166
|
+
puts "Exception when calling DistributionsCookbookApi->list: #{e}"
|
167
|
+
end
|
168
|
+
```
|
169
|
+
|
170
|
+
### Parameters
|
171
|
+
|
172
|
+
|
173
|
+
Name | Type | Description | Notes
|
174
|
+
------------- | ------------- | ------------- | -------------
|
175
|
+
**base_path** | **String**| | [optional]
|
176
|
+
**base_path__contains** | **String**| Filter results where base_path contains value | [optional]
|
177
|
+
**base_path__icontains** | **String**| Filter results where base_path contains value | [optional]
|
178
|
+
**base_path__in** | [**Array<String>**](String.md)| Filter results where base_path is in a comma-separated list of values | [optional]
|
179
|
+
**limit** | **Integer**| Number of results to return per page. | [optional]
|
180
|
+
**name** | **String**| | [optional]
|
181
|
+
**name__contains** | **String**| Filter results where name contains value | [optional]
|
182
|
+
**name__icontains** | **String**| Filter results where name contains value | [optional]
|
183
|
+
**name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
|
184
|
+
**name__startswith** | **String**| Filter results where name starts with value | [optional]
|
185
|
+
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
186
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
187
|
+
**pulp_label_select** | **String**| Filter labels by search string | [optional]
|
188
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
189
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
190
|
+
|
191
|
+
### Return type
|
192
|
+
|
193
|
+
[**PaginatedcookbookCookbookDistributionResponseList**](PaginatedcookbookCookbookDistributionResponseList.md)
|
194
|
+
|
195
|
+
### Authorization
|
196
|
+
|
197
|
+
[basicAuth](../README.md#basicAuth)
|
198
|
+
|
199
|
+
### HTTP request headers
|
200
|
+
|
201
|
+
- **Content-Type**: Not defined
|
202
|
+
- **Accept**: application/json
|
203
|
+
|
204
|
+
|
205
|
+
## partial_update
|
206
|
+
|
207
|
+
> AsyncOperationResponse partial_update(cookbook_cookbook_distribution_href, patchedcookbook_cookbook_distribution)
|
208
|
+
|
209
|
+
Update a cookbook distribution
|
210
|
+
|
211
|
+
Trigger an asynchronous partial update task
|
212
|
+
|
213
|
+
### Example
|
214
|
+
|
215
|
+
```ruby
|
216
|
+
# load the gem
|
217
|
+
require 'pulp_cookbook_client'
|
218
|
+
# setup authorization
|
219
|
+
PulpCookbookClient.configure do |config|
|
220
|
+
# Configure HTTP basic authorization: basicAuth
|
221
|
+
config.username = 'YOUR USERNAME'
|
222
|
+
config.password = 'YOUR PASSWORD'
|
223
|
+
end
|
224
|
+
|
225
|
+
api_instance = PulpCookbookClient::DistributionsCookbookApi.new
|
226
|
+
cookbook_cookbook_distribution_href = 'cookbook_cookbook_distribution_href_example' # String |
|
227
|
+
patchedcookbook_cookbook_distribution = PulpCookbookClient::PatchedcookbookCookbookDistribution.new # PatchedcookbookCookbookDistribution |
|
228
|
+
|
229
|
+
begin
|
230
|
+
#Update a cookbook distribution
|
231
|
+
result = api_instance.partial_update(cookbook_cookbook_distribution_href, patchedcookbook_cookbook_distribution)
|
232
|
+
p result
|
233
|
+
rescue PulpCookbookClient::ApiError => e
|
234
|
+
puts "Exception when calling DistributionsCookbookApi->partial_update: #{e}"
|
235
|
+
end
|
236
|
+
```
|
237
|
+
|
238
|
+
### Parameters
|
239
|
+
|
240
|
+
|
241
|
+
Name | Type | Description | Notes
|
242
|
+
------------- | ------------- | ------------- | -------------
|
243
|
+
**cookbook_cookbook_distribution_href** | **String**| |
|
244
|
+
**patchedcookbook_cookbook_distribution** | [**PatchedcookbookCookbookDistribution**](PatchedcookbookCookbookDistribution.md)| |
|
245
|
+
|
246
|
+
### Return type
|
247
|
+
|
248
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
249
|
+
|
250
|
+
### Authorization
|
251
|
+
|
252
|
+
[basicAuth](../README.md#basicAuth)
|
253
|
+
|
254
|
+
### HTTP request headers
|
255
|
+
|
256
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
257
|
+
- **Accept**: application/json
|
258
|
+
|
259
|
+
|
260
|
+
## read
|
261
|
+
|
262
|
+
> CookbookCookbookDistributionResponse read(cookbook_cookbook_distribution_href, opts)
|
263
|
+
|
264
|
+
Inspect a cookbook distribution
|
265
|
+
|
266
|
+
Cookbook Distreibution Endpoint. CookbookDistributions host Cookbook Publications which makes the metadata and the referenced Cookbook Content available to clients like berkshelf. Additionally, a CookbookDistribution with an associated CookbookPublication can be the target url of a Cookbook Remote , allowing another instance of Pulp to sync the content.
|
267
|
+
|
268
|
+
### Example
|
269
|
+
|
270
|
+
```ruby
|
271
|
+
# load the gem
|
272
|
+
require 'pulp_cookbook_client'
|
273
|
+
# setup authorization
|
274
|
+
PulpCookbookClient.configure do |config|
|
275
|
+
# Configure HTTP basic authorization: basicAuth
|
276
|
+
config.username = 'YOUR USERNAME'
|
277
|
+
config.password = 'YOUR PASSWORD'
|
278
|
+
end
|
279
|
+
|
280
|
+
api_instance = PulpCookbookClient::DistributionsCookbookApi.new
|
281
|
+
cookbook_cookbook_distribution_href = 'cookbook_cookbook_distribution_href_example' # String |
|
282
|
+
opts = {
|
283
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
284
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
285
|
+
}
|
286
|
+
|
287
|
+
begin
|
288
|
+
#Inspect a cookbook distribution
|
289
|
+
result = api_instance.read(cookbook_cookbook_distribution_href, opts)
|
290
|
+
p result
|
291
|
+
rescue PulpCookbookClient::ApiError => e
|
292
|
+
puts "Exception when calling DistributionsCookbookApi->read: #{e}"
|
293
|
+
end
|
294
|
+
```
|
295
|
+
|
296
|
+
### Parameters
|
297
|
+
|
298
|
+
|
299
|
+
Name | Type | Description | Notes
|
300
|
+
------------- | ------------- | ------------- | -------------
|
301
|
+
**cookbook_cookbook_distribution_href** | **String**| |
|
302
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
303
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
304
|
+
|
305
|
+
### Return type
|
306
|
+
|
307
|
+
[**CookbookCookbookDistributionResponse**](CookbookCookbookDistributionResponse.md)
|
308
|
+
|
309
|
+
### Authorization
|
310
|
+
|
311
|
+
[basicAuth](../README.md#basicAuth)
|
312
|
+
|
313
|
+
### HTTP request headers
|
314
|
+
|
315
|
+
- **Content-Type**: Not defined
|
316
|
+
- **Accept**: application/json
|
317
|
+
|
318
|
+
|
319
|
+
## update
|
320
|
+
|
321
|
+
> AsyncOperationResponse update(cookbook_cookbook_distribution_href, cookbook_cookbook_distribution)
|
322
|
+
|
323
|
+
Update a cookbook distribution
|
324
|
+
|
325
|
+
Trigger an asynchronous update task
|
326
|
+
|
327
|
+
### Example
|
328
|
+
|
329
|
+
```ruby
|
330
|
+
# load the gem
|
331
|
+
require 'pulp_cookbook_client'
|
332
|
+
# setup authorization
|
333
|
+
PulpCookbookClient.configure do |config|
|
334
|
+
# Configure HTTP basic authorization: basicAuth
|
335
|
+
config.username = 'YOUR USERNAME'
|
336
|
+
config.password = 'YOUR PASSWORD'
|
337
|
+
end
|
338
|
+
|
339
|
+
api_instance = PulpCookbookClient::DistributionsCookbookApi.new
|
340
|
+
cookbook_cookbook_distribution_href = 'cookbook_cookbook_distribution_href_example' # String |
|
341
|
+
cookbook_cookbook_distribution = PulpCookbookClient::CookbookCookbookDistribution.new # CookbookCookbookDistribution |
|
342
|
+
|
343
|
+
begin
|
344
|
+
#Update a cookbook distribution
|
345
|
+
result = api_instance.update(cookbook_cookbook_distribution_href, cookbook_cookbook_distribution)
|
346
|
+
p result
|
347
|
+
rescue PulpCookbookClient::ApiError => e
|
348
|
+
puts "Exception when calling DistributionsCookbookApi->update: #{e}"
|
349
|
+
end
|
350
|
+
```
|
351
|
+
|
352
|
+
### Parameters
|
353
|
+
|
354
|
+
|
355
|
+
Name | Type | Description | Notes
|
356
|
+
------------- | ------------- | ------------- | -------------
|
357
|
+
**cookbook_cookbook_distribution_href** | **String**| |
|
358
|
+
**cookbook_cookbook_distribution** | [**CookbookCookbookDistribution**](CookbookCookbookDistribution.md)| |
|
359
|
+
|
360
|
+
### Return type
|
361
|
+
|
362
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
363
|
+
|
364
|
+
### Authorization
|
365
|
+
|
366
|
+
[basicAuth](../README.md#basicAuth)
|
367
|
+
|
368
|
+
### HTTP request headers
|
369
|
+
|
370
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
371
|
+
- **Accept**: application/json
|
372
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# PulpCookbookClient::PaginatedRepositoryVersionResponseList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**count** | **Integer** | | [optional]
|
8
|
+
**_next** | **String** | | [optional]
|
9
|
+
**previous** | **String** | | [optional]
|
10
|
+
**results** | [**Array<RepositoryVersionResponse>**](RepositoryVersionResponse.md) | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'PulpCookbookClient'
|
16
|
+
|
17
|
+
instance = PulpCookbookClient::PaginatedRepositoryVersionResponseList.new(count: 123,
|
18
|
+
_next: http://api.example.org/accounts/?offset=400&limit=100,
|
19
|
+
previous: http://api.example.org/accounts/?offset=200&limit=100,
|
20
|
+
results: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# PulpCookbookClient::PaginatedcookbookCookbookDistributionResponseList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**count** | **Integer** | | [optional]
|
8
|
+
**_next** | **String** | | [optional]
|
9
|
+
**previous** | **String** | | [optional]
|
10
|
+
**results** | [**Array<CookbookCookbookDistributionResponse>**](CookbookCookbookDistributionResponse.md) | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'PulpCookbookClient'
|
16
|
+
|
17
|
+
instance = PulpCookbookClient::PaginatedcookbookCookbookDistributionResponseList.new(count: 123,
|
18
|
+
_next: http://api.example.org/accounts/?offset=400&limit=100,
|
19
|
+
previous: http://api.example.org/accounts/?offset=200&limit=100,
|
20
|
+
results: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# PulpCookbookClient::PaginatedcookbookCookbookPackageContentResponseList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**count** | **Integer** | | [optional]
|
8
|
+
**_next** | **String** | | [optional]
|
9
|
+
**previous** | **String** | | [optional]
|
10
|
+
**results** | [**Array<CookbookCookbookPackageContentResponse>**](CookbookCookbookPackageContentResponse.md) | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'PulpCookbookClient'
|
16
|
+
|
17
|
+
instance = PulpCookbookClient::PaginatedcookbookCookbookPackageContentResponseList.new(count: 123,
|
18
|
+
_next: http://api.example.org/accounts/?offset=400&limit=100,
|
19
|
+
previous: http://api.example.org/accounts/?offset=200&limit=100,
|
20
|
+
results: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# PulpCookbookClient::PaginatedcookbookCookbookPublicationResponseList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**count** | **Integer** | | [optional]
|
8
|
+
**_next** | **String** | | [optional]
|
9
|
+
**previous** | **String** | | [optional]
|
10
|
+
**results** | [**Array<CookbookCookbookPublicationResponse>**](CookbookCookbookPublicationResponse.md) | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'PulpCookbookClient'
|
16
|
+
|
17
|
+
instance = PulpCookbookClient::PaginatedcookbookCookbookPublicationResponseList.new(count: 123,
|
18
|
+
_next: http://api.example.org/accounts/?offset=400&limit=100,
|
19
|
+
previous: http://api.example.org/accounts/?offset=200&limit=100,
|
20
|
+
results: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# PulpCookbookClient::PaginatedcookbookCookbookRemoteResponseList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**count** | **Integer** | | [optional]
|
8
|
+
**_next** | **String** | | [optional]
|
9
|
+
**previous** | **String** | | [optional]
|
10
|
+
**results** | [**Array<CookbookCookbookRemoteResponse>**](CookbookCookbookRemoteResponse.md) | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'PulpCookbookClient'
|
16
|
+
|
17
|
+
instance = PulpCookbookClient::PaginatedcookbookCookbookRemoteResponseList.new(count: 123,
|
18
|
+
_next: http://api.example.org/accounts/?offset=400&limit=100,
|
19
|
+
previous: http://api.example.org/accounts/?offset=200&limit=100,
|
20
|
+
results: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|