pulp_container_client 1.0.0rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +164 -0
- data/Rakefile +10 -0
- data/docs/AsyncOperationResponse.md +17 -0
- data/docs/ContainerBlob.md +25 -0
- data/docs/ContainerContainerDistribution.md +31 -0
- data/docs/ContainerContainerRemote.md +43 -0
- data/docs/ContainerContainerRepository.md +27 -0
- data/docs/ContainerManifest.md +33 -0
- data/docs/ContainerTag.md +25 -0
- data/docs/ContentBlobsApi.md +142 -0
- data/docs/ContentManifestsApi.md +142 -0
- data/docs/ContentSummary.md +21 -0
- data/docs/ContentTagsApi.md +144 -0
- data/docs/DistributionsContainerApi.md +362 -0
- data/docs/InlineResponse200.md +23 -0
- data/docs/InlineResponse2001.md +23 -0
- data/docs/InlineResponse2002.md +23 -0
- data/docs/InlineResponse2003.md +23 -0
- data/docs/InlineResponse2004.md +23 -0
- data/docs/InlineResponse2005.md +23 -0
- data/docs/InlineResponse2006.md +23 -0
- data/docs/ManifestCopy.md +23 -0
- data/docs/RecursiveManage.md +17 -0
- data/docs/RemotesContainerApi.md +366 -0
- data/docs/RepositoriesContainerApi.md +739 -0
- data/docs/RepositoriesContainerVersionsApi.md +214 -0
- data/docs/RepositorySyncURL.md +19 -0
- data/docs/RepositoryVersion.md +25 -0
- data/docs/TagCopy.md +21 -0
- data/docs/TagImage.md +19 -0
- data/docs/UnTagImage.md +17 -0
- data/git_push.sh +58 -0
- data/lib/pulp_container_client/api/content_blobs_api.rb +176 -0
- data/lib/pulp_container_client/api/content_manifests_api.rb +176 -0
- data/lib/pulp_container_client/api/content_tags_api.rb +179 -0
- data/lib/pulp_container_client/api/distributions_container_api.rb +442 -0
- data/lib/pulp_container_client/api/remotes_container_api.rb +448 -0
- data/lib/pulp_container_client/api/repositories_container_api.rb +906 -0
- data/lib/pulp_container_client/api/repositories_container_versions_api.rb +268 -0
- data/lib/pulp_container_client/api_client.rb +402 -0
- data/lib/pulp_container_client/api_error.rb +57 -0
- data/lib/pulp_container_client/configuration.rb +243 -0
- data/lib/pulp_container_client/models/async_operation_response.rb +212 -0
- data/lib/pulp_container_client/models/container_blob.rb +299 -0
- data/lib/pulp_container_client/models/container_container_distribution.rb +342 -0
- data/lib/pulp_container_client/models/container_container_remote.rb +526 -0
- data/lib/pulp_container_client/models/container_container_repository.rb +294 -0
- data/lib/pulp_container_client/models/container_manifest.rb +363 -0
- data/lib/pulp_container_client/models/container_tag.rb +280 -0
- data/lib/pulp_container_client/models/content_summary.rb +246 -0
- data/lib/pulp_container_client/models/inline_response200.rb +247 -0
- data/lib/pulp_container_client/models/inline_response2001.rb +247 -0
- data/lib/pulp_container_client/models/inline_response2002.rb +247 -0
- data/lib/pulp_container_client/models/inline_response2003.rb +247 -0
- data/lib/pulp_container_client/models/inline_response2004.rb +247 -0
- data/lib/pulp_container_client/models/inline_response2005.rb +247 -0
- data/lib/pulp_container_client/models/inline_response2006.rb +247 -0
- data/lib/pulp_container_client/models/manifest_copy.rb +263 -0
- data/lib/pulp_container_client/models/recursive_manage.rb +209 -0
- data/lib/pulp_container_client/models/repository_sync_url.rb +224 -0
- data/lib/pulp_container_client/models/repository_version.rb +244 -0
- data/lib/pulp_container_client/models/tag_copy.rb +229 -0
- data/lib/pulp_container_client/models/tag_image.rb +265 -0
- data/lib/pulp_container_client/models/un_tag_image.rb +231 -0
- data/lib/pulp_container_client/version.rb +15 -0
- data/lib/pulp_container_client.rb +68 -0
- data/pulp_container_client.gemspec +39 -0
- data/spec/api/content_blobs_api_spec.rb +70 -0
- data/spec/api/content_manifests_api_spec.rb +70 -0
- data/spec/api/content_tags_api_spec.rb +71 -0
- data/spec/api/distributions_container_api_spec.rb +120 -0
- data/spec/api/remotes_container_api_spec.rb +122 -0
- data/spec/api/repositories_container_api_spec.rb +200 -0
- data/spec/api/repositories_container_versions_api_spec.rb +91 -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/container_blob_spec.rb +65 -0
- data/spec/models/container_container_distribution_spec.rb +83 -0
- data/spec/models/container_container_remote_spec.rb +123 -0
- data/spec/models/container_container_repository_spec.rb +71 -0
- data/spec/models/container_manifest_spec.rb +89 -0
- data/spec/models/container_tag_spec.rb +65 -0
- data/spec/models/content_summary_spec.rb +53 -0
- data/spec/models/inline_response2001_spec.rb +59 -0
- data/spec/models/inline_response2002_spec.rb +59 -0
- data/spec/models/inline_response2003_spec.rb +59 -0
- data/spec/models/inline_response2004_spec.rb +59 -0
- data/spec/models/inline_response2005_spec.rb +59 -0
- data/spec/models/inline_response2006_spec.rb +59 -0
- data/spec/models/inline_response200_spec.rb +59 -0
- data/spec/models/manifest_copy_spec.rb +63 -0
- data/spec/models/recursive_manage_spec.rb +41 -0
- data/spec/models/repository_sync_url_spec.rb +47 -0
- data/spec/models/repository_version_spec.rb +65 -0
- data/spec/models/tag_copy_spec.rb +53 -0
- data/spec/models/tag_image_spec.rb +47 -0
- data/spec/models/un_tag_image_spec.rb +41 -0
- data/spec/spec_helper.rb +111 -0
- metadata +230 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 235053871c5bf18874ad153fa5997ae833f8cc708a72fb7e71a60320f58baa42
|
4
|
+
data.tar.gz: ed839e2ff22229142b05070725b8cabbe5af562ffd8e6dfbdc87284264fd2daa
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 0fc12f47f9b20debd9f61ec2d19d3554b2693a22d1f30f9d3caa4f3a16de9cdc765bcc89977b55000d66f8a97d62d126ca73456bc9c29bdbcb798ad318aa4fce
|
7
|
+
data.tar.gz: 5536eebac785a5482044ec53f940f3eb9965bb4a2bc321e1393f1617377dea522bc647e922111cd31fca32c7763948ea5b54b9932f19a4ef4c0f7b1240aace76
|
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,164 @@
|
|
1
|
+
# pulp_container_client
|
2
|
+
|
3
|
+
PulpContainerClient - the Ruby gem for the Pulp 3 API
|
4
|
+
|
5
|
+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
|
+
|
9
|
+
- API version: v3
|
10
|
+
- Package version: 1.0.0rc1
|
11
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
|
+
|
13
|
+
## Installation
|
14
|
+
|
15
|
+
### Build a gem
|
16
|
+
|
17
|
+
To build the Ruby code into a gem:
|
18
|
+
|
19
|
+
```shell
|
20
|
+
gem build pulp_container_client.gemspec
|
21
|
+
```
|
22
|
+
|
23
|
+
Then either install the gem locally:
|
24
|
+
|
25
|
+
```shell
|
26
|
+
gem install ./pulp_container_client-1.0.0rc1.gem
|
27
|
+
```
|
28
|
+
|
29
|
+
(for development, run `gem install --dev ./pulp_container_client-1.0.0rc1.gem` to install the development dependencies)
|
30
|
+
|
31
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
|
+
|
33
|
+
Finally add this to the Gemfile:
|
34
|
+
|
35
|
+
gem 'pulp_container_client', '~> 1.0.0rc1'
|
36
|
+
|
37
|
+
### Install from Git
|
38
|
+
|
39
|
+
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:
|
40
|
+
|
41
|
+
gem 'pulp_container_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
42
|
+
|
43
|
+
### Include the Ruby code directly
|
44
|
+
|
45
|
+
Include the Ruby code directly using `-I` as follows:
|
46
|
+
|
47
|
+
```shell
|
48
|
+
ruby -Ilib script.rb
|
49
|
+
```
|
50
|
+
|
51
|
+
## Getting Started
|
52
|
+
|
53
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
54
|
+
|
55
|
+
```ruby
|
56
|
+
# Load the gem
|
57
|
+
require 'pulp_container_client'
|
58
|
+
|
59
|
+
# Setup authorization
|
60
|
+
PulpContainerClient.configure do |config|
|
61
|
+
# Configure HTTP basic authorization: Basic
|
62
|
+
config.username = 'YOUR_USERNAME'
|
63
|
+
config.password = 'YOUR_PASSWORD'
|
64
|
+
end
|
65
|
+
|
66
|
+
api_instance = PulpContainerClient::ContentBlobsApi.new
|
67
|
+
opts = {
|
68
|
+
digest: 'digest_example', # String | Filter results where digest matches value
|
69
|
+
digest__in: 'digest__in_example', # String | Filter results where digest is in a comma-separated list of values
|
70
|
+
repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
|
71
|
+
repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF
|
72
|
+
repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF
|
73
|
+
media_type: 'media_type_example', # String |
|
74
|
+
limit: 56, # Integer | Number of results to return per page.
|
75
|
+
offset: 56, # Integer | The initial index from which to return the results.
|
76
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
77
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
78
|
+
}
|
79
|
+
|
80
|
+
begin
|
81
|
+
#List blobs
|
82
|
+
result = api_instance.list(opts)
|
83
|
+
p result
|
84
|
+
rescue PulpContainerClient::ApiError => e
|
85
|
+
puts "Exception when calling ContentBlobsApi->list: #{e}"
|
86
|
+
end
|
87
|
+
|
88
|
+
```
|
89
|
+
|
90
|
+
## Documentation for API Endpoints
|
91
|
+
|
92
|
+
All URIs are relative to *http://localhost:24817*
|
93
|
+
|
94
|
+
Class | Method | HTTP request | Description
|
95
|
+
------------ | ------------- | ------------- | -------------
|
96
|
+
*PulpContainerClient::ContentBlobsApi* | [**list**](docs/ContentBlobsApi.md#list) | **GET** /pulp/api/v3/content/container/blobs/ | List blobs
|
97
|
+
*PulpContainerClient::ContentBlobsApi* | [**read**](docs/ContentBlobsApi.md#read) | **GET** {blob_href} | Inspect a blob
|
98
|
+
*PulpContainerClient::ContentManifestsApi* | [**list**](docs/ContentManifestsApi.md#list) | **GET** /pulp/api/v3/content/container/manifests/ | List manifests
|
99
|
+
*PulpContainerClient::ContentManifestsApi* | [**read**](docs/ContentManifestsApi.md#read) | **GET** {manifest_href} | Inspect a manifest
|
100
|
+
*PulpContainerClient::ContentTagsApi* | [**list**](docs/ContentTagsApi.md#list) | **GET** /pulp/api/v3/content/container/tags/ | List tags
|
101
|
+
*PulpContainerClient::ContentTagsApi* | [**read**](docs/ContentTagsApi.md#read) | **GET** {tag_href} | Inspect a tag
|
102
|
+
*PulpContainerClient::DistributionsContainerApi* | [**create**](docs/DistributionsContainerApi.md#create) | **POST** /pulp/api/v3/distributions/container/container/ | Create a container distribution
|
103
|
+
*PulpContainerClient::DistributionsContainerApi* | [**delete**](docs/DistributionsContainerApi.md#delete) | **DELETE** {container_distribution_href} | Delete a container distribution
|
104
|
+
*PulpContainerClient::DistributionsContainerApi* | [**list**](docs/DistributionsContainerApi.md#list) | **GET** /pulp/api/v3/distributions/container/container/ | List container distributions
|
105
|
+
*PulpContainerClient::DistributionsContainerApi* | [**partial_update**](docs/DistributionsContainerApi.md#partial_update) | **PATCH** {container_distribution_href} | Partially update a container distribution
|
106
|
+
*PulpContainerClient::DistributionsContainerApi* | [**read**](docs/DistributionsContainerApi.md#read) | **GET** {container_distribution_href} | Inspect a container distribution
|
107
|
+
*PulpContainerClient::DistributionsContainerApi* | [**update**](docs/DistributionsContainerApi.md#update) | **PUT** {container_distribution_href} | Update a container distribution
|
108
|
+
*PulpContainerClient::RemotesContainerApi* | [**create**](docs/RemotesContainerApi.md#create) | **POST** /pulp/api/v3/remotes/container/container/ | Create a container remote
|
109
|
+
*PulpContainerClient::RemotesContainerApi* | [**delete**](docs/RemotesContainerApi.md#delete) | **DELETE** {container_remote_href} | Delete a container remote
|
110
|
+
*PulpContainerClient::RemotesContainerApi* | [**list**](docs/RemotesContainerApi.md#list) | **GET** /pulp/api/v3/remotes/container/container/ | List container remotes
|
111
|
+
*PulpContainerClient::RemotesContainerApi* | [**partial_update**](docs/RemotesContainerApi.md#partial_update) | **PATCH** {container_remote_href} | Partially update a container remote
|
112
|
+
*PulpContainerClient::RemotesContainerApi* | [**read**](docs/RemotesContainerApi.md#read) | **GET** {container_remote_href} | Inspect a container remote
|
113
|
+
*PulpContainerClient::RemotesContainerApi* | [**update**](docs/RemotesContainerApi.md#update) | **PUT** {container_remote_href} | Update a container remote
|
114
|
+
*PulpContainerClient::RepositoriesContainerApi* | [**add**](docs/RepositoriesContainerApi.md#add) | **POST** {container_repository_href}add/ |
|
115
|
+
*PulpContainerClient::RepositoriesContainerApi* | [**copy_manifests**](docs/RepositoriesContainerApi.md#copy_manifests) | **POST** {container_repository_href}copy_manifests/ |
|
116
|
+
*PulpContainerClient::RepositoriesContainerApi* | [**copy_tags**](docs/RepositoriesContainerApi.md#copy_tags) | **POST** {container_repository_href}copy_tags/ |
|
117
|
+
*PulpContainerClient::RepositoriesContainerApi* | [**create**](docs/RepositoriesContainerApi.md#create) | **POST** /pulp/api/v3/repositories/container/container/ | Create a container repository
|
118
|
+
*PulpContainerClient::RepositoriesContainerApi* | [**delete**](docs/RepositoriesContainerApi.md#delete) | **DELETE** {container_repository_href} | Delete a container repository
|
119
|
+
*PulpContainerClient::RepositoriesContainerApi* | [**list**](docs/RepositoriesContainerApi.md#list) | **GET** /pulp/api/v3/repositories/container/container/ | List container repositorys
|
120
|
+
*PulpContainerClient::RepositoriesContainerApi* | [**partial_update**](docs/RepositoriesContainerApi.md#partial_update) | **PATCH** {container_repository_href} | Partially update a container repository
|
121
|
+
*PulpContainerClient::RepositoriesContainerApi* | [**read**](docs/RepositoriesContainerApi.md#read) | **GET** {container_repository_href} | Inspect a container repository
|
122
|
+
*PulpContainerClient::RepositoriesContainerApi* | [**remove**](docs/RepositoriesContainerApi.md#remove) | **POST** {container_repository_href}remove/ |
|
123
|
+
*PulpContainerClient::RepositoriesContainerApi* | [**sync**](docs/RepositoriesContainerApi.md#sync) | **POST** {container_repository_href}sync/ |
|
124
|
+
*PulpContainerClient::RepositoriesContainerApi* | [**tag**](docs/RepositoriesContainerApi.md#tag) | **POST** {container_repository_href}tag/ |
|
125
|
+
*PulpContainerClient::RepositoriesContainerApi* | [**untag**](docs/RepositoriesContainerApi.md#untag) | **POST** {container_repository_href}untag/ |
|
126
|
+
*PulpContainerClient::RepositoriesContainerApi* | [**update**](docs/RepositoriesContainerApi.md#update) | **PUT** {container_repository_href} | Update a container repository
|
127
|
+
*PulpContainerClient::RepositoriesContainerVersionsApi* | [**delete**](docs/RepositoriesContainerVersionsApi.md#delete) | **DELETE** {container_repository_version_href} | Delete a repository version
|
128
|
+
*PulpContainerClient::RepositoriesContainerVersionsApi* | [**list**](docs/RepositoriesContainerVersionsApi.md#list) | **GET** {container_repository_href}versions/ | List repository versions
|
129
|
+
*PulpContainerClient::RepositoriesContainerVersionsApi* | [**read**](docs/RepositoriesContainerVersionsApi.md#read) | **GET** {container_repository_version_href} | Inspect a repository version
|
130
|
+
|
131
|
+
|
132
|
+
## Documentation for Models
|
133
|
+
|
134
|
+
- [PulpContainerClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
|
135
|
+
- [PulpContainerClient::ContainerBlob](docs/ContainerBlob.md)
|
136
|
+
- [PulpContainerClient::ContainerContainerDistribution](docs/ContainerContainerDistribution.md)
|
137
|
+
- [PulpContainerClient::ContainerContainerRemote](docs/ContainerContainerRemote.md)
|
138
|
+
- [PulpContainerClient::ContainerContainerRepository](docs/ContainerContainerRepository.md)
|
139
|
+
- [PulpContainerClient::ContainerManifest](docs/ContainerManifest.md)
|
140
|
+
- [PulpContainerClient::ContainerTag](docs/ContainerTag.md)
|
141
|
+
- [PulpContainerClient::ContentSummary](docs/ContentSummary.md)
|
142
|
+
- [PulpContainerClient::InlineResponse200](docs/InlineResponse200.md)
|
143
|
+
- [PulpContainerClient::InlineResponse2001](docs/InlineResponse2001.md)
|
144
|
+
- [PulpContainerClient::InlineResponse2002](docs/InlineResponse2002.md)
|
145
|
+
- [PulpContainerClient::InlineResponse2003](docs/InlineResponse2003.md)
|
146
|
+
- [PulpContainerClient::InlineResponse2004](docs/InlineResponse2004.md)
|
147
|
+
- [PulpContainerClient::InlineResponse2005](docs/InlineResponse2005.md)
|
148
|
+
- [PulpContainerClient::InlineResponse2006](docs/InlineResponse2006.md)
|
149
|
+
- [PulpContainerClient::ManifestCopy](docs/ManifestCopy.md)
|
150
|
+
- [PulpContainerClient::RecursiveManage](docs/RecursiveManage.md)
|
151
|
+
- [PulpContainerClient::RepositorySyncURL](docs/RepositorySyncURL.md)
|
152
|
+
- [PulpContainerClient::RepositoryVersion](docs/RepositoryVersion.md)
|
153
|
+
- [PulpContainerClient::TagCopy](docs/TagCopy.md)
|
154
|
+
- [PulpContainerClient::TagImage](docs/TagImage.md)
|
155
|
+
- [PulpContainerClient::UnTagImage](docs/UnTagImage.md)
|
156
|
+
|
157
|
+
|
158
|
+
## Documentation for Authorization
|
159
|
+
|
160
|
+
|
161
|
+
### Basic
|
162
|
+
|
163
|
+
- **Type**: HTTP basic authentication
|
164
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# PulpContainerClient::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 'PulpContainerClient'
|
13
|
+
|
14
|
+
instance = PulpContainerClient::AsyncOperationResponse.new(task: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# PulpContainerClient::ContainerBlob
|
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
|
+
**artifact** | **String** | Artifact file representing the physical content |
|
10
|
+
**digest** | **String** | sha256 of the Blob file |
|
11
|
+
**media_type** | **String** | Blob media type of the file |
|
12
|
+
|
13
|
+
## Code Sample
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'PulpContainerClient'
|
17
|
+
|
18
|
+
instance = PulpContainerClient::ContainerBlob.new(pulp_href: null,
|
19
|
+
pulp_created: null,
|
20
|
+
artifact: null,
|
21
|
+
digest: null,
|
22
|
+
media_type: null)
|
23
|
+
```
|
24
|
+
|
25
|
+
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# PulpContainerClient::ContainerContainerDistribution
|
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
|
+
**name** | **String** | A unique name. Ex, `rawhide` and `stable`. |
|
9
|
+
**pulp_href** | **String** | | [optional] [readonly]
|
10
|
+
**repository_version** | **String** | RepositoryVersion to be served | [optional]
|
11
|
+
**repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional]
|
12
|
+
**content_guard** | **String** | An optional content-guard. | [optional]
|
13
|
+
**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
|
14
|
+
**registry_path** | **String** | The Registry hostame:port/name/ to use with docker pull command defined by this distribution. | [optional] [readonly]
|
15
|
+
|
16
|
+
## Code Sample
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'PulpContainerClient'
|
20
|
+
|
21
|
+
instance = PulpContainerClient::ContainerContainerDistribution.new(base_path: null,
|
22
|
+
name: null,
|
23
|
+
pulp_href: null,
|
24
|
+
repository_version: null,
|
25
|
+
repository: null,
|
26
|
+
content_guard: null,
|
27
|
+
pulp_created: null,
|
28
|
+
registry_path: null)
|
29
|
+
```
|
30
|
+
|
31
|
+
|
@@ -0,0 +1,43 @@
|
|
1
|
+
# PulpContainerClient::ContainerContainerRemote
|
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 string containing the PEM encoded CA certificate used to validate the server certificate presented by the remote server. All new line characters must be escaped. Returns SHA256 sum on GET. | [optional]
|
12
|
+
**client_cert** | **String** | A string containing the PEM encoded client certificate used for authentication. All new line characters must be escaped. Returns SHA256 sum on GET. | [optional]
|
13
|
+
**client_key** | **String** | A PEM encoded private key used for authentication. Returns SHA256 sum on GET. | [optional]
|
14
|
+
**tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional]
|
15
|
+
**proxy_url** | **String** | The proxy URL. Format: scheme://user:password@host:port | [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. | [optional]
|
18
|
+
**policy** | **String** | immediate - All manifests and blobs are downloaded and saved during a sync. on_demand - Only tags and manifests are downloaded. Blobs are not downloaded until they are requested for the first time by a client. streamed - Blobs are streamed to the client with every request and never saved. | [optional] [default to 'immediate']
|
19
|
+
**upstream_name** | **String** | Name of the upstream repository |
|
20
|
+
**whitelist_tags** | **Array<String>** | A list of whitelisted tags to sync | [optional]
|
21
|
+
|
22
|
+
## Code Sample
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
require 'PulpContainerClient'
|
26
|
+
|
27
|
+
instance = PulpContainerClient::ContainerContainerRemote.new(pulp_href: null,
|
28
|
+
pulp_created: null,
|
29
|
+
name: null,
|
30
|
+
url: null,
|
31
|
+
ca_cert: null,
|
32
|
+
client_cert: null,
|
33
|
+
client_key: null,
|
34
|
+
tls_validation: null,
|
35
|
+
proxy_url: null,
|
36
|
+
pulp_last_updated: null,
|
37
|
+
download_concurrency: null,
|
38
|
+
policy: null,
|
39
|
+
upstream_name: null,
|
40
|
+
whitelist_tags: null)
|
41
|
+
```
|
42
|
+
|
43
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# PulpContainerClient::ContainerContainerRepository
|
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
|
+
**latest_version_href** | **String** | | [optional] [readonly]
|
11
|
+
**name** | **String** | A unique name for this repository. |
|
12
|
+
**description** | **String** | An optional description. | [optional]
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'PulpContainerClient'
|
18
|
+
|
19
|
+
instance = PulpContainerClient::ContainerContainerRepository.new(pulp_href: null,
|
20
|
+
pulp_created: null,
|
21
|
+
versions_href: null,
|
22
|
+
latest_version_href: null,
|
23
|
+
name: null,
|
24
|
+
description: null)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
@@ -0,0 +1,33 @@
|
|
1
|
+
# PulpContainerClient::ContainerManifest
|
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
|
+
**artifact** | **String** | Artifact file representing the physical content |
|
10
|
+
**digest** | **String** | sha256 of the Manifest file |
|
11
|
+
**schema_version** | **Integer** | Manifest schema version |
|
12
|
+
**media_type** | **String** | Manifest media type of the file |
|
13
|
+
**listed_manifests** | **Array<String>** | Manifests that are referenced by this Manifest List |
|
14
|
+
**config_blob** | **String** | Blob that contains configuration for this Manifest |
|
15
|
+
**blobs** | **Array<String>** | Blobs that are referenced by this Manifest |
|
16
|
+
|
17
|
+
## Code Sample
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'PulpContainerClient'
|
21
|
+
|
22
|
+
instance = PulpContainerClient::ContainerManifest.new(pulp_href: null,
|
23
|
+
pulp_created: null,
|
24
|
+
artifact: null,
|
25
|
+
digest: null,
|
26
|
+
schema_version: null,
|
27
|
+
media_type: null,
|
28
|
+
listed_manifests: null,
|
29
|
+
config_blob: null,
|
30
|
+
blobs: null)
|
31
|
+
```
|
32
|
+
|
33
|
+
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# PulpContainerClient::ContainerTag
|
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
|
+
**artifact** | **String** | Artifact file representing the physical content |
|
10
|
+
**name** | **String** | Tag name |
|
11
|
+
**tagged_manifest** | **String** | Manifest that is tagged |
|
12
|
+
|
13
|
+
## Code Sample
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'PulpContainerClient'
|
17
|
+
|
18
|
+
instance = PulpContainerClient::ContainerTag.new(pulp_href: null,
|
19
|
+
pulp_created: null,
|
20
|
+
artifact: null,
|
21
|
+
name: null,
|
22
|
+
tagged_manifest: null)
|
23
|
+
```
|
24
|
+
|
25
|
+
|
@@ -0,0 +1,142 @@
|
|
1
|
+
# PulpContainerClient::ContentBlobsApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**list**](ContentBlobsApi.md#list) | **GET** /pulp/api/v3/content/container/blobs/ | List blobs
|
8
|
+
[**read**](ContentBlobsApi.md#read) | **GET** {blob_href} | Inspect a blob
|
9
|
+
|
10
|
+
|
11
|
+
|
12
|
+
## list
|
13
|
+
|
14
|
+
> InlineResponse200 list(opts)
|
15
|
+
|
16
|
+
List blobs
|
17
|
+
|
18
|
+
ViewSet for Blobs.
|
19
|
+
|
20
|
+
### Example
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
# load the gem
|
24
|
+
require 'pulp_container_client'
|
25
|
+
# setup authorization
|
26
|
+
PulpContainerClient.configure do |config|
|
27
|
+
# Configure HTTP basic authorization: Basic
|
28
|
+
config.username = 'YOUR USERNAME'
|
29
|
+
config.password = 'YOUR PASSWORD'
|
30
|
+
end
|
31
|
+
|
32
|
+
api_instance = PulpContainerClient::ContentBlobsApi.new
|
33
|
+
opts = {
|
34
|
+
digest: 'digest_example', # String | Filter results where digest matches value
|
35
|
+
digest__in: 'digest__in_example', # String | Filter results where digest is in a comma-separated list of values
|
36
|
+
repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
|
37
|
+
repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF
|
38
|
+
repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF
|
39
|
+
media_type: 'media_type_example', # String |
|
40
|
+
limit: 56, # Integer | Number of results to return per page.
|
41
|
+
offset: 56, # Integer | The initial index from which to return the results.
|
42
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
43
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
44
|
+
}
|
45
|
+
|
46
|
+
begin
|
47
|
+
#List blobs
|
48
|
+
result = api_instance.list(opts)
|
49
|
+
p result
|
50
|
+
rescue PulpContainerClient::ApiError => e
|
51
|
+
puts "Exception when calling ContentBlobsApi->list: #{e}"
|
52
|
+
end
|
53
|
+
```
|
54
|
+
|
55
|
+
### Parameters
|
56
|
+
|
57
|
+
|
58
|
+
Name | Type | Description | Notes
|
59
|
+
------------- | ------------- | ------------- | -------------
|
60
|
+
**digest** | **String**| Filter results where digest matches value | [optional]
|
61
|
+
**digest__in** | **String**| Filter results where digest is in a comma-separated list of values | [optional]
|
62
|
+
**repository_version** | **String**| Repository Version referenced by HREF | [optional]
|
63
|
+
**repository_version_added** | **String**| Repository Version referenced by HREF | [optional]
|
64
|
+
**repository_version_removed** | **String**| Repository Version referenced by HREF | [optional]
|
65
|
+
**media_type** | **String**| | [optional]
|
66
|
+
**limit** | **Integer**| Number of results to return per page. | [optional]
|
67
|
+
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
68
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
69
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
70
|
+
|
71
|
+
### Return type
|
72
|
+
|
73
|
+
[**InlineResponse200**](InlineResponse200.md)
|
74
|
+
|
75
|
+
### Authorization
|
76
|
+
|
77
|
+
[Basic](../README.md#Basic)
|
78
|
+
|
79
|
+
### HTTP request headers
|
80
|
+
|
81
|
+
- **Content-Type**: Not defined
|
82
|
+
- **Accept**: application/json
|
83
|
+
|
84
|
+
|
85
|
+
## read
|
86
|
+
|
87
|
+
> ContainerBlob read(blob_href, opts)
|
88
|
+
|
89
|
+
Inspect a blob
|
90
|
+
|
91
|
+
ViewSet for Blobs.
|
92
|
+
|
93
|
+
### Example
|
94
|
+
|
95
|
+
```ruby
|
96
|
+
# load the gem
|
97
|
+
require 'pulp_container_client'
|
98
|
+
# setup authorization
|
99
|
+
PulpContainerClient.configure do |config|
|
100
|
+
# Configure HTTP basic authorization: Basic
|
101
|
+
config.username = 'YOUR USERNAME'
|
102
|
+
config.password = 'YOUR PASSWORD'
|
103
|
+
end
|
104
|
+
|
105
|
+
api_instance = PulpContainerClient::ContentBlobsApi.new
|
106
|
+
blob_href = 'blob_href_example' # String | URI of Blob. e.g.: /pulp/api/v3/content/container/blobs/1/
|
107
|
+
opts = {
|
108
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
109
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
110
|
+
}
|
111
|
+
|
112
|
+
begin
|
113
|
+
#Inspect a blob
|
114
|
+
result = api_instance.read(blob_href, opts)
|
115
|
+
p result
|
116
|
+
rescue PulpContainerClient::ApiError => e
|
117
|
+
puts "Exception when calling ContentBlobsApi->read: #{e}"
|
118
|
+
end
|
119
|
+
```
|
120
|
+
|
121
|
+
### Parameters
|
122
|
+
|
123
|
+
|
124
|
+
Name | Type | Description | Notes
|
125
|
+
------------- | ------------- | ------------- | -------------
|
126
|
+
**blob_href** | **String**| URI of Blob. e.g.: /pulp/api/v3/content/container/blobs/1/ |
|
127
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
128
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
129
|
+
|
130
|
+
### Return type
|
131
|
+
|
132
|
+
[**ContainerBlob**](ContainerBlob.md)
|
133
|
+
|
134
|
+
### Authorization
|
135
|
+
|
136
|
+
[Basic](../README.md#Basic)
|
137
|
+
|
138
|
+
### HTTP request headers
|
139
|
+
|
140
|
+
- **Content-Type**: Not defined
|
141
|
+
- **Accept**: application/json
|
142
|
+
|