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
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: ffca95f3a5f8ee5c8d0236861411ec6fb2ddb48ff789d96b413811e23ad81b0b
|
4
|
+
data.tar.gz: 0f4224d8c7b00d08394206a8b323f9e078c85b9616b5bf90d8cbf226cd7803d5
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: a16b4e47a2c482d7d25ce3e377e693e4d13447facbae7d506a25fa3e20780d412d180823401227a37ae9a811dba5a5d26c6fd91c2dedab5e6c93843b087fc0f1
|
7
|
+
data.tar.gz: a2f90b32639eb480dae862f4b4c2f061dc7ebf95bbfbda95f9df77f5f39df1051241968ef038aab305a35c5796c084408a338ee2f1e36937f2761f95f67be650
|
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,162 @@
|
|
1
|
+
# pulp_cookbook_client
|
2
|
+
|
3
|
+
PulpCookbookClient - the Ruby gem for the Pulp 3 API
|
4
|
+
|
5
|
+
Fetch, Upload, Organize, and Distribute Software Packages
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
|
+
|
9
|
+
- API version: v3
|
10
|
+
- Package version: 0.1.0b9
|
11
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
|
+
For more information, please visit [https://pulpproject.org](https://pulpproject.org)
|
13
|
+
|
14
|
+
## Installation
|
15
|
+
|
16
|
+
### Build a gem
|
17
|
+
|
18
|
+
To build the Ruby code into a gem:
|
19
|
+
|
20
|
+
```shell
|
21
|
+
gem build pulp_cookbook_client.gemspec
|
22
|
+
```
|
23
|
+
|
24
|
+
Then either install the gem locally:
|
25
|
+
|
26
|
+
```shell
|
27
|
+
gem install ./pulp_cookbook_client-0.1.0b9.gem
|
28
|
+
```
|
29
|
+
|
30
|
+
(for development, run `gem install --dev ./pulp_cookbook_client-0.1.0b9.gem` to install the development dependencies)
|
31
|
+
|
32
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
|
+
|
34
|
+
Finally add this to the Gemfile:
|
35
|
+
|
36
|
+
gem 'pulp_cookbook_client', '~> 0.1.0b9'
|
37
|
+
|
38
|
+
### Install from Git
|
39
|
+
|
40
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
41
|
+
|
42
|
+
gem 'pulp_cookbook_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
43
|
+
|
44
|
+
### Include the Ruby code directly
|
45
|
+
|
46
|
+
Include the Ruby code directly using `-I` as follows:
|
47
|
+
|
48
|
+
```shell
|
49
|
+
ruby -Ilib script.rb
|
50
|
+
```
|
51
|
+
|
52
|
+
## Getting Started
|
53
|
+
|
54
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
# Load the gem
|
58
|
+
require 'pulp_cookbook_client'
|
59
|
+
|
60
|
+
# Setup authorization
|
61
|
+
PulpCookbookClient.configure do |config|
|
62
|
+
# Configure HTTP basic authorization: basicAuth
|
63
|
+
config.username = 'YOUR_USERNAME'
|
64
|
+
config.password = 'YOUR_PASSWORD'
|
65
|
+
end
|
66
|
+
|
67
|
+
api_instance = PulpCookbookClient::ContentCookbooksApi.new
|
68
|
+
name = 'name_example' # String | name of the cookbook
|
69
|
+
opts = {
|
70
|
+
artifact: 'artifact_example', # String | Artifact file representing the physical content
|
71
|
+
file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
|
72
|
+
repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
|
73
|
+
version: 'version_example' # String | version of the cookbook
|
74
|
+
}
|
75
|
+
|
76
|
+
begin
|
77
|
+
#Create a cookbook package content
|
78
|
+
result = api_instance.create(name, opts)
|
79
|
+
p result
|
80
|
+
rescue PulpCookbookClient::ApiError => e
|
81
|
+
puts "Exception when calling ContentCookbooksApi->create: #{e}"
|
82
|
+
end
|
83
|
+
|
84
|
+
```
|
85
|
+
|
86
|
+
## Documentation for API Endpoints
|
87
|
+
|
88
|
+
All URIs are relative to *https://pulp*
|
89
|
+
|
90
|
+
Class | Method | HTTP request | Description
|
91
|
+
------------ | ------------- | ------------- | -------------
|
92
|
+
*PulpCookbookClient::ContentCookbooksApi* | [**create**](docs/ContentCookbooksApi.md#create) | **POST** /pulp/api/v3/content/cookbook/cookbooks/ | Create a cookbook package content
|
93
|
+
*PulpCookbookClient::ContentCookbooksApi* | [**list**](docs/ContentCookbooksApi.md#list) | **GET** /pulp/api/v3/content/cookbook/cookbooks/ | List cookbook package contents
|
94
|
+
*PulpCookbookClient::ContentCookbooksApi* | [**read**](docs/ContentCookbooksApi.md#read) | **GET** {cookbook_cookbook_package_content_href} | Inspect a cookbook package content
|
95
|
+
*PulpCookbookClient::DistributionsCookbookApi* | [**create**](docs/DistributionsCookbookApi.md#create) | **POST** /pulp/api/v3/distributions/cookbook/cookbook/ | Create a cookbook distribution
|
96
|
+
*PulpCookbookClient::DistributionsCookbookApi* | [**delete**](docs/DistributionsCookbookApi.md#delete) | **DELETE** {cookbook_cookbook_distribution_href} | Delete a cookbook distribution
|
97
|
+
*PulpCookbookClient::DistributionsCookbookApi* | [**list**](docs/DistributionsCookbookApi.md#list) | **GET** /pulp/api/v3/distributions/cookbook/cookbook/ | List cookbook distributions
|
98
|
+
*PulpCookbookClient::DistributionsCookbookApi* | [**partial_update**](docs/DistributionsCookbookApi.md#partial_update) | **PATCH** {cookbook_cookbook_distribution_href} | Update a cookbook distribution
|
99
|
+
*PulpCookbookClient::DistributionsCookbookApi* | [**read**](docs/DistributionsCookbookApi.md#read) | **GET** {cookbook_cookbook_distribution_href} | Inspect a cookbook distribution
|
100
|
+
*PulpCookbookClient::DistributionsCookbookApi* | [**update**](docs/DistributionsCookbookApi.md#update) | **PUT** {cookbook_cookbook_distribution_href} | Update a cookbook distribution
|
101
|
+
*PulpCookbookClient::PublicationsCookbookApi* | [**create**](docs/PublicationsCookbookApi.md#create) | **POST** /pulp/api/v3/publications/cookbook/cookbook/ | Create a cookbook publication
|
102
|
+
*PulpCookbookClient::PublicationsCookbookApi* | [**delete**](docs/PublicationsCookbookApi.md#delete) | **DELETE** {cookbook_cookbook_publication_href} | Delete a cookbook publication
|
103
|
+
*PulpCookbookClient::PublicationsCookbookApi* | [**list**](docs/PublicationsCookbookApi.md#list) | **GET** /pulp/api/v3/publications/cookbook/cookbook/ | List cookbook publications
|
104
|
+
*PulpCookbookClient::PublicationsCookbookApi* | [**read**](docs/PublicationsCookbookApi.md#read) | **GET** {cookbook_cookbook_publication_href} | Inspect a cookbook publication
|
105
|
+
*PulpCookbookClient::RemotesCookbookApi* | [**create**](docs/RemotesCookbookApi.md#create) | **POST** /pulp/api/v3/remotes/cookbook/cookbook/ | Create a cookbook remote
|
106
|
+
*PulpCookbookClient::RemotesCookbookApi* | [**delete**](docs/RemotesCookbookApi.md#delete) | **DELETE** {cookbook_cookbook_remote_href} | Delete a cookbook remote
|
107
|
+
*PulpCookbookClient::RemotesCookbookApi* | [**list**](docs/RemotesCookbookApi.md#list) | **GET** /pulp/api/v3/remotes/cookbook/cookbook/ | List cookbook remotes
|
108
|
+
*PulpCookbookClient::RemotesCookbookApi* | [**partial_update**](docs/RemotesCookbookApi.md#partial_update) | **PATCH** {cookbook_cookbook_remote_href} | Update a cookbook remote
|
109
|
+
*PulpCookbookClient::RemotesCookbookApi* | [**read**](docs/RemotesCookbookApi.md#read) | **GET** {cookbook_cookbook_remote_href} | Inspect a cookbook remote
|
110
|
+
*PulpCookbookClient::RemotesCookbookApi* | [**update**](docs/RemotesCookbookApi.md#update) | **PUT** {cookbook_cookbook_remote_href} | Update a cookbook remote
|
111
|
+
*PulpCookbookClient::RepositoriesCookbookApi* | [**create**](docs/RepositoriesCookbookApi.md#create) | **POST** /pulp/api/v3/repositories/cookbook/cookbook/ | Create a cookbook repository
|
112
|
+
*PulpCookbookClient::RepositoriesCookbookApi* | [**delete**](docs/RepositoriesCookbookApi.md#delete) | **DELETE** {cookbook_cookbook_repository_href} | Delete a cookbook repository
|
113
|
+
*PulpCookbookClient::RepositoriesCookbookApi* | [**list**](docs/RepositoriesCookbookApi.md#list) | **GET** /pulp/api/v3/repositories/cookbook/cookbook/ | List cookbook repositorys
|
114
|
+
*PulpCookbookClient::RepositoriesCookbookApi* | [**modify**](docs/RepositoriesCookbookApi.md#modify) | **POST** {cookbook_cookbook_repository_href}modify/ | Modify Repository Content
|
115
|
+
*PulpCookbookClient::RepositoriesCookbookApi* | [**partial_update**](docs/RepositoriesCookbookApi.md#partial_update) | **PATCH** {cookbook_cookbook_repository_href} | Update a cookbook repository
|
116
|
+
*PulpCookbookClient::RepositoriesCookbookApi* | [**read**](docs/RepositoriesCookbookApi.md#read) | **GET** {cookbook_cookbook_repository_href} | Inspect a cookbook repository
|
117
|
+
*PulpCookbookClient::RepositoriesCookbookApi* | [**sync**](docs/RepositoriesCookbookApi.md#sync) | **POST** {cookbook_cookbook_repository_href}sync/ |
|
118
|
+
*PulpCookbookClient::RepositoriesCookbookApi* | [**update**](docs/RepositoriesCookbookApi.md#update) | **PUT** {cookbook_cookbook_repository_href} | Update a cookbook repository
|
119
|
+
*PulpCookbookClient::RepositoriesCookbookVersionsApi* | [**delete**](docs/RepositoriesCookbookVersionsApi.md#delete) | **DELETE** {cookbook_cookbook_repository_version_href} | Delete a repository version
|
120
|
+
*PulpCookbookClient::RepositoriesCookbookVersionsApi* | [**list**](docs/RepositoriesCookbookVersionsApi.md#list) | **GET** {cookbook_cookbook_repository_href}versions/ | List repository versions
|
121
|
+
*PulpCookbookClient::RepositoriesCookbookVersionsApi* | [**read**](docs/RepositoriesCookbookVersionsApi.md#read) | **GET** {cookbook_cookbook_repository_version_href} | Inspect a repository version
|
122
|
+
*PulpCookbookClient::RepositoriesCookbookVersionsApi* | [**repair**](docs/RepositoriesCookbookVersionsApi.md#repair) | **POST** {cookbook_cookbook_repository_version_href}repair/ |
|
123
|
+
|
124
|
+
|
125
|
+
## Documentation for Models
|
126
|
+
|
127
|
+
- [PulpCookbookClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
|
128
|
+
- [PulpCookbookClient::ContentSummary](docs/ContentSummary.md)
|
129
|
+
- [PulpCookbookClient::ContentSummaryResponse](docs/ContentSummaryResponse.md)
|
130
|
+
- [PulpCookbookClient::CookbookCookbookDistribution](docs/CookbookCookbookDistribution.md)
|
131
|
+
- [PulpCookbookClient::CookbookCookbookDistributionResponse](docs/CookbookCookbookDistributionResponse.md)
|
132
|
+
- [PulpCookbookClient::CookbookCookbookPackageContent](docs/CookbookCookbookPackageContent.md)
|
133
|
+
- [PulpCookbookClient::CookbookCookbookPackageContentResponse](docs/CookbookCookbookPackageContentResponse.md)
|
134
|
+
- [PulpCookbookClient::CookbookCookbookPublication](docs/CookbookCookbookPublication.md)
|
135
|
+
- [PulpCookbookClient::CookbookCookbookPublicationResponse](docs/CookbookCookbookPublicationResponse.md)
|
136
|
+
- [PulpCookbookClient::CookbookCookbookRemote](docs/CookbookCookbookRemote.md)
|
137
|
+
- [PulpCookbookClient::CookbookCookbookRemoteResponse](docs/CookbookCookbookRemoteResponse.md)
|
138
|
+
- [PulpCookbookClient::CookbookCookbookRepository](docs/CookbookCookbookRepository.md)
|
139
|
+
- [PulpCookbookClient::CookbookCookbookRepositoryResponse](docs/CookbookCookbookRepositoryResponse.md)
|
140
|
+
- [PulpCookbookClient::PaginatedRepositoryVersionResponseList](docs/PaginatedRepositoryVersionResponseList.md)
|
141
|
+
- [PulpCookbookClient::PaginatedcookbookCookbookDistributionResponseList](docs/PaginatedcookbookCookbookDistributionResponseList.md)
|
142
|
+
- [PulpCookbookClient::PaginatedcookbookCookbookPackageContentResponseList](docs/PaginatedcookbookCookbookPackageContentResponseList.md)
|
143
|
+
- [PulpCookbookClient::PaginatedcookbookCookbookPublicationResponseList](docs/PaginatedcookbookCookbookPublicationResponseList.md)
|
144
|
+
- [PulpCookbookClient::PaginatedcookbookCookbookRemoteResponseList](docs/PaginatedcookbookCookbookRemoteResponseList.md)
|
145
|
+
- [PulpCookbookClient::PaginatedcookbookCookbookRepositoryResponseList](docs/PaginatedcookbookCookbookRepositoryResponseList.md)
|
146
|
+
- [PulpCookbookClient::PatchedcookbookCookbookDistribution](docs/PatchedcookbookCookbookDistribution.md)
|
147
|
+
- [PulpCookbookClient::PatchedcookbookCookbookRemote](docs/PatchedcookbookCookbookRemote.md)
|
148
|
+
- [PulpCookbookClient::PatchedcookbookCookbookRepository](docs/PatchedcookbookCookbookRepository.md)
|
149
|
+
- [PulpCookbookClient::PolicyEnum](docs/PolicyEnum.md)
|
150
|
+
- [PulpCookbookClient::RepositoryAddRemoveContent](docs/RepositoryAddRemoveContent.md)
|
151
|
+
- [PulpCookbookClient::RepositorySyncURL](docs/RepositorySyncURL.md)
|
152
|
+
- [PulpCookbookClient::RepositoryVersion](docs/RepositoryVersion.md)
|
153
|
+
- [PulpCookbookClient::RepositoryVersionResponse](docs/RepositoryVersionResponse.md)
|
154
|
+
|
155
|
+
|
156
|
+
## Documentation for Authorization
|
157
|
+
|
158
|
+
|
159
|
+
### basicAuth
|
160
|
+
|
161
|
+
- **Type**: HTTP basic authentication
|
162
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# PulpCookbookClient::AsyncOperationResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**task** | **String** | The href of the task. |
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'PulpCookbookClient'
|
13
|
+
|
14
|
+
instance = PulpCookbookClient::AsyncOperationResponse.new(task: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,208 @@
|
|
1
|
+
# PulpCookbookClient::ContentCookbooksApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://pulp*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create**](ContentCookbooksApi.md#create) | **POST** /pulp/api/v3/content/cookbook/cookbooks/ | Create a cookbook package content
|
8
|
+
[**list**](ContentCookbooksApi.md#list) | **GET** /pulp/api/v3/content/cookbook/cookbooks/ | List cookbook package contents
|
9
|
+
[**read**](ContentCookbooksApi.md#read) | **GET** {cookbook_cookbook_package_content_href} | Inspect a cookbook package content
|
10
|
+
|
11
|
+
|
12
|
+
|
13
|
+
## create
|
14
|
+
|
15
|
+
> AsyncOperationResponse create(name, opts)
|
16
|
+
|
17
|
+
Create a cookbook package content
|
18
|
+
|
19
|
+
Trigger an asynchronous task to create content,optionally create new repository version.
|
20
|
+
|
21
|
+
### Example
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
# load the gem
|
25
|
+
require 'pulp_cookbook_client'
|
26
|
+
# setup authorization
|
27
|
+
PulpCookbookClient.configure do |config|
|
28
|
+
# Configure HTTP basic authorization: basicAuth
|
29
|
+
config.username = 'YOUR USERNAME'
|
30
|
+
config.password = 'YOUR PASSWORD'
|
31
|
+
end
|
32
|
+
|
33
|
+
api_instance = PulpCookbookClient::ContentCookbooksApi.new
|
34
|
+
name = 'name_example' # String | name of the cookbook
|
35
|
+
opts = {
|
36
|
+
artifact: 'artifact_example', # String | Artifact file representing the physical content
|
37
|
+
file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
|
38
|
+
repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
|
39
|
+
version: 'version_example' # String | version of the cookbook
|
40
|
+
}
|
41
|
+
|
42
|
+
begin
|
43
|
+
#Create a cookbook package content
|
44
|
+
result = api_instance.create(name, opts)
|
45
|
+
p result
|
46
|
+
rescue PulpCookbookClient::ApiError => e
|
47
|
+
puts "Exception when calling ContentCookbooksApi->create: #{e}"
|
48
|
+
end
|
49
|
+
```
|
50
|
+
|
51
|
+
### Parameters
|
52
|
+
|
53
|
+
|
54
|
+
Name | Type | Description | Notes
|
55
|
+
------------- | ------------- | ------------- | -------------
|
56
|
+
**name** | **String**| name of the cookbook |
|
57
|
+
**artifact** | **String**| Artifact file representing the physical content | [optional]
|
58
|
+
**file** | **File**| An uploaded file that may be turned into the artifact of the content unit. | [optional]
|
59
|
+
**repository** | **String**| A URI of a repository the new content unit should be associated with. | [optional]
|
60
|
+
**version** | **String**| version of the cookbook | [optional]
|
61
|
+
|
62
|
+
### Return type
|
63
|
+
|
64
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
65
|
+
|
66
|
+
### Authorization
|
67
|
+
|
68
|
+
[basicAuth](../README.md#basicAuth)
|
69
|
+
|
70
|
+
### HTTP request headers
|
71
|
+
|
72
|
+
- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
|
73
|
+
- **Accept**: application/json
|
74
|
+
|
75
|
+
|
76
|
+
## list
|
77
|
+
|
78
|
+
> PaginatedcookbookCookbookPackageContentResponseList list(opts)
|
79
|
+
|
80
|
+
List cookbook package contents
|
81
|
+
|
82
|
+
Cookbook Content Endpoint. CookbookContent represents a single cookbook, which can be added and removed from repositories.
|
83
|
+
|
84
|
+
### Example
|
85
|
+
|
86
|
+
```ruby
|
87
|
+
# load the gem
|
88
|
+
require 'pulp_cookbook_client'
|
89
|
+
# setup authorization
|
90
|
+
PulpCookbookClient.configure do |config|
|
91
|
+
# Configure HTTP basic authorization: basicAuth
|
92
|
+
config.username = 'YOUR USERNAME'
|
93
|
+
config.password = 'YOUR PASSWORD'
|
94
|
+
end
|
95
|
+
|
96
|
+
api_instance = PulpCookbookClient::ContentCookbooksApi.new
|
97
|
+
opts = {
|
98
|
+
content_id: 'content_id_example', # String | Filter results where content_id matches value
|
99
|
+
limit: 56, # Integer | Number of results to return per page.
|
100
|
+
name: 'name_example', # String | Filter results where name matches value
|
101
|
+
offset: 56, # Integer | The initial index from which to return the results.
|
102
|
+
ordering: 'ordering_example', # String | Which field to use when ordering the results.
|
103
|
+
repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
|
104
|
+
repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF
|
105
|
+
repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF
|
106
|
+
version: 'version_example', # String | Filter results where version matches value
|
107
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
108
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
109
|
+
}
|
110
|
+
|
111
|
+
begin
|
112
|
+
#List cookbook package contents
|
113
|
+
result = api_instance.list(opts)
|
114
|
+
p result
|
115
|
+
rescue PulpCookbookClient::ApiError => e
|
116
|
+
puts "Exception when calling ContentCookbooksApi->list: #{e}"
|
117
|
+
end
|
118
|
+
```
|
119
|
+
|
120
|
+
### Parameters
|
121
|
+
|
122
|
+
|
123
|
+
Name | Type | Description | Notes
|
124
|
+
------------- | ------------- | ------------- | -------------
|
125
|
+
**content_id** | **String**| Filter results where content_id matches value | [optional]
|
126
|
+
**limit** | **Integer**| Number of results to return per page. | [optional]
|
127
|
+
**name** | **String**| Filter results where name matches value | [optional]
|
128
|
+
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
129
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
130
|
+
**repository_version** | **String**| Repository Version referenced by HREF | [optional]
|
131
|
+
**repository_version_added** | **String**| Repository Version referenced by HREF | [optional]
|
132
|
+
**repository_version_removed** | **String**| Repository Version referenced by HREF | [optional]
|
133
|
+
**version** | **String**| Filter results where version matches value | [optional]
|
134
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
135
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
136
|
+
|
137
|
+
### Return type
|
138
|
+
|
139
|
+
[**PaginatedcookbookCookbookPackageContentResponseList**](PaginatedcookbookCookbookPackageContentResponseList.md)
|
140
|
+
|
141
|
+
### Authorization
|
142
|
+
|
143
|
+
[basicAuth](../README.md#basicAuth)
|
144
|
+
|
145
|
+
### HTTP request headers
|
146
|
+
|
147
|
+
- **Content-Type**: Not defined
|
148
|
+
- **Accept**: application/json
|
149
|
+
|
150
|
+
|
151
|
+
## read
|
152
|
+
|
153
|
+
> CookbookCookbookPackageContentResponse read(cookbook_cookbook_package_content_href, opts)
|
154
|
+
|
155
|
+
Inspect a cookbook package content
|
156
|
+
|
157
|
+
Cookbook Content Endpoint. CookbookContent represents a single cookbook, which can be added and removed from repositories.
|
158
|
+
|
159
|
+
### Example
|
160
|
+
|
161
|
+
```ruby
|
162
|
+
# load the gem
|
163
|
+
require 'pulp_cookbook_client'
|
164
|
+
# setup authorization
|
165
|
+
PulpCookbookClient.configure do |config|
|
166
|
+
# Configure HTTP basic authorization: basicAuth
|
167
|
+
config.username = 'YOUR USERNAME'
|
168
|
+
config.password = 'YOUR PASSWORD'
|
169
|
+
end
|
170
|
+
|
171
|
+
api_instance = PulpCookbookClient::ContentCookbooksApi.new
|
172
|
+
cookbook_cookbook_package_content_href = 'cookbook_cookbook_package_content_href_example' # String |
|
173
|
+
opts = {
|
174
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
175
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
176
|
+
}
|
177
|
+
|
178
|
+
begin
|
179
|
+
#Inspect a cookbook package content
|
180
|
+
result = api_instance.read(cookbook_cookbook_package_content_href, opts)
|
181
|
+
p result
|
182
|
+
rescue PulpCookbookClient::ApiError => e
|
183
|
+
puts "Exception when calling ContentCookbooksApi->read: #{e}"
|
184
|
+
end
|
185
|
+
```
|
186
|
+
|
187
|
+
### Parameters
|
188
|
+
|
189
|
+
|
190
|
+
Name | Type | Description | Notes
|
191
|
+
------------- | ------------- | ------------- | -------------
|
192
|
+
**cookbook_cookbook_package_content_href** | **String**| |
|
193
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
194
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
195
|
+
|
196
|
+
### Return type
|
197
|
+
|
198
|
+
[**CookbookCookbookPackageContentResponse**](CookbookCookbookPackageContentResponse.md)
|
199
|
+
|
200
|
+
### Authorization
|
201
|
+
|
202
|
+
[basicAuth](../README.md#basicAuth)
|
203
|
+
|
204
|
+
### HTTP request headers
|
205
|
+
|
206
|
+
- **Content-Type**: Not defined
|
207
|
+
- **Accept**: application/json
|
208
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# PulpCookbookClient::ContentSummary
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**added** | **Hash<String, Object>** | |
|
8
|
+
**removed** | **Hash<String, Object>** | |
|
9
|
+
**present** | **Hash<String, Object>** | |
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'PulpCookbookClient'
|
15
|
+
|
16
|
+
instance = PulpCookbookClient::ContentSummary.new(added: null,
|
17
|
+
removed: null,
|
18
|
+
present: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# PulpCookbookClient::ContentSummaryResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**added** | **Hash<String, Object>** | |
|
8
|
+
**removed** | **Hash<String, Object>** | |
|
9
|
+
**present** | **Hash<String, Object>** | |
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'PulpCookbookClient'
|
15
|
+
|
16
|
+
instance = PulpCookbookClient::ContentSummaryResponse.new(added: null,
|
17
|
+
removed: null,
|
18
|
+
present: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# PulpCookbookClient::CookbookCookbookDistribution
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") |
|
8
|
+
**content_guard** | **String** | An optional content-guard. | [optional]
|
9
|
+
**pulp_labels** | [**Object**](.md) | | [optional]
|
10
|
+
**name** | **String** | A unique name. Ex, `rawhide` and `stable`. |
|
11
|
+
**repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional]
|
12
|
+
**publication** | **String** | Publication to be served | [optional]
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'PulpCookbookClient'
|
18
|
+
|
19
|
+
instance = PulpCookbookClient::CookbookCookbookDistribution.new(base_path: null,
|
20
|
+
content_guard: null,
|
21
|
+
pulp_labels: null,
|
22
|
+
name: null,
|
23
|
+
repository: null,
|
24
|
+
publication: null)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
@@ -0,0 +1,33 @@
|
|
1
|
+
# PulpCookbookClient::CookbookCookbookDistributionResponse
|
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
|
+
**base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") |
|
10
|
+
**base_url** | **String** | The URL for accessing the universe API as defined by this distribution. | [optional] [readonly]
|
11
|
+
**content_guard** | **String** | An optional content-guard. | [optional]
|
12
|
+
**pulp_labels** | [**Object**](.md) | | [optional]
|
13
|
+
**name** | **String** | A unique name. Ex, `rawhide` and `stable`. |
|
14
|
+
**repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional]
|
15
|
+
**publication** | **String** | Publication to be served | [optional]
|
16
|
+
|
17
|
+
## Code Sample
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'PulpCookbookClient'
|
21
|
+
|
22
|
+
instance = PulpCookbookClient::CookbookCookbookDistributionResponse.new(pulp_href: null,
|
23
|
+
pulp_created: null,
|
24
|
+
base_path: null,
|
25
|
+
base_url: null,
|
26
|
+
content_guard: null,
|
27
|
+
pulp_labels: null,
|
28
|
+
name: null,
|
29
|
+
repository: null,
|
30
|
+
publication: null)
|
31
|
+
```
|
32
|
+
|
33
|
+
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# PulpCookbookClient::CookbookCookbookPackageContent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**artifact** | **String** | Artifact file representing the physical content | [optional]
|
8
|
+
**file** | **File** | An uploaded file that may be turned into the artifact of the content unit. | [optional]
|
9
|
+
**repository** | **String** | A URI of a repository the new content unit should be associated with. | [optional]
|
10
|
+
**name** | **String** | name of the cookbook |
|
11
|
+
**version** | **String** | version of the cookbook | [optional]
|
12
|
+
|
13
|
+
## Code Sample
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'PulpCookbookClient'
|
17
|
+
|
18
|
+
instance = PulpCookbookClient::CookbookCookbookPackageContent.new(artifact: null,
|
19
|
+
file: null,
|
20
|
+
repository: null,
|
21
|
+
name: null,
|
22
|
+
version: null)
|
23
|
+
```
|
24
|
+
|
25
|
+
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# PulpCookbookClient::CookbookCookbookPackageContentResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**artifact** | **String** | Artifact file representing the physical content | [optional]
|
8
|
+
**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
|
9
|
+
**pulp_href** | **String** | | [optional] [readonly]
|
10
|
+
**name** | **String** | name of the cookbook |
|
11
|
+
**version** | **String** | version of the cookbook | [optional]
|
12
|
+
**dependencies** | [**Object**](.md) | dependencies of the cookbook | [optional] [readonly]
|
13
|
+
**content_id** | **String** | content_id of the cookbook (UUID (lazy download)/SHA256 (immediate download/import) | [optional] [readonly]
|
14
|
+
|
15
|
+
## Code Sample
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'PulpCookbookClient'
|
19
|
+
|
20
|
+
instance = PulpCookbookClient::CookbookCookbookPackageContentResponse.new(artifact: null,
|
21
|
+
pulp_created: null,
|
22
|
+
pulp_href: null,
|
23
|
+
name: null,
|
24
|
+
version: null,
|
25
|
+
dependencies: null,
|
26
|
+
content_id: null)
|
27
|
+
```
|
28
|
+
|
29
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# PulpCookbookClient::CookbookCookbookPublication
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**repository_version** | **String** | | [optional]
|
8
|
+
**repository** | **String** | A URI of the repository to be published. | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'PulpCookbookClient'
|
14
|
+
|
15
|
+
instance = PulpCookbookClient::CookbookCookbookPublication.new(repository_version: null,
|
16
|
+
repository: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# PulpCookbookClient::CookbookCookbookPublicationResponse
|
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
|
+
**repository_version** | **String** | | [optional]
|
10
|
+
**repository** | **String** | A URI of the repository to be published. | [optional]
|
11
|
+
**distributions** | **Array<String>** | This publication is currently being served as defined by these distributions. | [optional] [readonly]
|
12
|
+
|
13
|
+
## Code Sample
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'PulpCookbookClient'
|
17
|
+
|
18
|
+
instance = PulpCookbookClient::CookbookCookbookPublicationResponse.new(pulp_href: null,
|
19
|
+
pulp_created: null,
|
20
|
+
repository_version: null,
|
21
|
+
repository: null,
|
22
|
+
distributions: null)
|
23
|
+
```
|
24
|
+
|
25
|
+
|