pulp_docker_client 4.0.0b7 → 4.0.0b8.dev01573482113
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.
Potentially problematic release.
This version of pulp_docker_client might be problematic. Click here for more details.
- checksums.yaml +4 -4
- data/README.md +24 -16
- data/docs/ContentBlobsApi.md +8 -58
- data/docs/ContentManifestsApi.md +8 -58
- data/docs/ContentTagsApi.md +8 -58
- data/docs/DistributionsDockerApi.md +14 -10
- data/docs/{Blob.md → DockerBlob.md} +5 -9
- data/docs/{DockerDistribution.md → DockerDockerDistribution.md} +11 -11
- data/docs/{DockerRemote.md → DockerDockerRemote.md} +8 -14
- data/docs/{Manifest.md → DockerManifest.md} +5 -9
- data/docs/{Tag.md → DockerTag.md} +5 -9
- data/docs/InlineResponse200.md +1 -1
- data/docs/InlineResponse2001.md +1 -1
- data/docs/InlineResponse2002.md +1 -1
- data/docs/InlineResponse2003.md +1 -1
- data/docs/InlineResponse2004.md +1 -1
- data/docs/RemotesDockerApi.md +28 -24
- data/lib/pulp_docker_client/api/content_blobs_api.rb +10 -68
- data/lib/pulp_docker_client/api/content_manifests_api.rb +10 -68
- data/lib/pulp_docker_client/api/content_tags_api.rb +10 -68
- data/lib/pulp_docker_client/api/distributions_docker_api.rb +16 -10
- data/lib/pulp_docker_client/api/docker_copy_api.rb +1 -1
- data/lib/pulp_docker_client/api/docker_recursive_add_api.rb +1 -1
- data/lib/pulp_docker_client/api/docker_recursive_remove_api.rb +1 -1
- data/lib/pulp_docker_client/api/docker_tag_api.rb +1 -1
- data/lib/pulp_docker_client/api/docker_untag_api.rb +1 -1
- data/lib/pulp_docker_client/api/remotes_docker_api.rb +37 -31
- data/lib/pulp_docker_client/api_client.rb +1 -1
- data/lib/pulp_docker_client/api_error.rb +1 -1
- data/lib/pulp_docker_client/configuration.rb +1 -1
- data/lib/pulp_docker_client/models/async_operation_response.rb +12 -2
- data/lib/pulp_docker_client/models/{blob.rb → docker_blob.rb} +28 -76
- data/lib/pulp_docker_client/models/{docker_distribution.rb → docker_docker_distribution.rb} +52 -39
- data/lib/pulp_docker_client/models/{docker_remote.rb → docker_docker_remote.rb} +44 -116
- data/lib/pulp_docker_client/models/{manifest.rb → docker_manifest.rb} +28 -76
- data/lib/pulp_docker_client/models/{tag.rb → docker_tag.rb} +28 -76
- data/lib/pulp_docker_client/models/inline_response200.rb +15 -3
- data/lib/pulp_docker_client/models/inline_response2001.rb +15 -3
- data/lib/pulp_docker_client/models/inline_response2002.rb +15 -3
- data/lib/pulp_docker_client/models/inline_response2003.rb +15 -3
- data/lib/pulp_docker_client/models/inline_response2004.rb +15 -3
- data/lib/pulp_docker_client/models/manifest_copy.rb +12 -2
- data/lib/pulp_docker_client/models/recursive_manage.rb +12 -2
- data/lib/pulp_docker_client/models/repository_sync_url.rb +12 -2
- data/lib/pulp_docker_client/models/tag_copy.rb +12 -2
- data/lib/pulp_docker_client/models/tag_image.rb +12 -2
- data/lib/pulp_docker_client/models/un_tag_image.rb +12 -2
- data/lib/pulp_docker_client/version.rb +2 -2
- data/lib/pulp_docker_client.rb +6 -6
- data/pulp_docker_client.gemspec +1 -1
- data/spec/api/content_blobs_api_spec.rb +4 -14
- data/spec/api/content_manifests_api_spec.rb +4 -14
- data/spec/api/content_tags_api_spec.rb +4 -14
- data/spec/api/distributions_docker_api_spec.rb +4 -2
- data/spec/api/docker_copy_api_spec.rb +1 -1
- data/spec/api/docker_recursive_add_api_spec.rb +1 -1
- data/spec/api/docker_recursive_remove_api_spec.rb +1 -1
- data/spec/api/docker_tag_api_spec.rb +1 -1
- data/spec/api/docker_untag_api_spec.rb +1 -1
- data/spec/api/remotes_docker_api_spec.rb +11 -9
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/async_operation_response_spec.rb +1 -1
- data/spec/models/{blob_spec.rb → docker_blob_spec.rb} +9 -21
- data/spec/models/{docker_distribution_spec.rb → docker_docker_distribution_spec.rb} +14 -14
- data/spec/models/{docker_remote_spec.rb → docker_docker_remote_spec.rb} +10 -28
- data/spec/models/{manifest_spec.rb → docker_manifest_spec.rb} +9 -21
- data/spec/models/{tag_spec.rb → docker_tag_spec.rb} +9 -21
- data/spec/models/inline_response2001_spec.rb +1 -1
- data/spec/models/inline_response2002_spec.rb +1 -1
- data/spec/models/inline_response2003_spec.rb +1 -1
- data/spec/models/inline_response2004_spec.rb +1 -1
- data/spec/models/inline_response200_spec.rb +1 -1
- data/spec/models/manifest_copy_spec.rb +1 -1
- data/spec/models/recursive_manage_spec.rb +1 -1
- data/spec/models/repository_sync_url_spec.rb +1 -1
- data/spec/models/tag_copy_spec.rb +1 -1
- data/spec/models/tag_image_spec.rb +1 -1
- data/spec/models/un_tag_image_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +22 -22
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ff16eb6ac6406b62480ac88a327b520f1bfa9f8af52347bf015f783152358fdd
|
4
|
+
data.tar.gz: d7821a96aa70bfca6f1e8514db0c2792424a182cdfdbd0f0f93d8be8ba6b79a7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3f2907f72b9962678b2e657d5d4987e0637cc16beb037e75309f9a7f7b08e6918580770e8fa99d29f28b20f289ff939b0597c4e9f62ac64b42f30b13b5a3d288
|
7
|
+
data.tar.gz: 052f8051049f653b50b9643efb13625c4971d3dd57974c355a0472a87f9aa79dee10eca1cf8286647bceb3d93bfc0b1fab5a16fe6c3ef675197f541813a9f231
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ No description provided (generated by Openapi Generator https://github.com/opena
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: v3
|
10
|
-
- Package version: 4.0.
|
10
|
+
- Package version: 4.0.0b8.dev01573482113
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,16 +23,16 @@ gem build pulp_docker_client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./pulp_docker_client-4.0.
|
26
|
+
gem install ./pulp_docker_client-4.0.0b8.dev01573482113.gem
|
27
27
|
```
|
28
28
|
|
29
|
-
(for development, run `gem install --dev ./pulp_docker_client-4.0.
|
29
|
+
(for development, run `gem install --dev ./pulp_docker_client-4.0.0b8.dev01573482113.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'pulp_docker_client', '~> 4.0.
|
35
|
+
gem 'pulp_docker_client', '~> 4.0.0b8.dev01573482113'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -64,14 +64,25 @@ PulpDockerClient.configure do |config|
|
|
64
64
|
end
|
65
65
|
|
66
66
|
api_instance = PulpDockerClient::ContentBlobsApi.new
|
67
|
-
|
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
|
+
}
|
68
79
|
|
69
80
|
begin
|
70
|
-
#
|
71
|
-
result = api_instance.
|
81
|
+
#List blobs
|
82
|
+
result = api_instance.list(opts)
|
72
83
|
p result
|
73
84
|
rescue PulpDockerClient::ApiError => e
|
74
|
-
puts "Exception when calling ContentBlobsApi->
|
85
|
+
puts "Exception when calling ContentBlobsApi->list: #{e}"
|
75
86
|
end
|
76
87
|
|
77
88
|
```
|
@@ -82,13 +93,10 @@ All URIs are relative to *http://localhost:24817*
|
|
82
93
|
|
83
94
|
Class | Method | HTTP request | Description
|
84
95
|
------------ | ------------- | ------------- | -------------
|
85
|
-
*PulpDockerClient::ContentBlobsApi* | [**create**](docs/ContentBlobsApi.md#create) | **POST** /pulp/api/v3/content/docker/blobs/ | Create a blob
|
86
96
|
*PulpDockerClient::ContentBlobsApi* | [**list**](docs/ContentBlobsApi.md#list) | **GET** /pulp/api/v3/content/docker/blobs/ | List blobs
|
87
97
|
*PulpDockerClient::ContentBlobsApi* | [**read**](docs/ContentBlobsApi.md#read) | **GET** {blob_href} | Inspect a blob
|
88
|
-
*PulpDockerClient::ContentManifestsApi* | [**create**](docs/ContentManifestsApi.md#create) | **POST** /pulp/api/v3/content/docker/manifests/ | Create a manifest
|
89
98
|
*PulpDockerClient::ContentManifestsApi* | [**list**](docs/ContentManifestsApi.md#list) | **GET** /pulp/api/v3/content/docker/manifests/ | List manifests
|
90
99
|
*PulpDockerClient::ContentManifestsApi* | [**read**](docs/ContentManifestsApi.md#read) | **GET** {manifest_href} | Inspect a manifest
|
91
|
-
*PulpDockerClient::ContentTagsApi* | [**create**](docs/ContentTagsApi.md#create) | **POST** /pulp/api/v3/content/docker/tags/ | Create a tag
|
92
100
|
*PulpDockerClient::ContentTagsApi* | [**list**](docs/ContentTagsApi.md#list) | **GET** /pulp/api/v3/content/docker/tags/ | List tags
|
93
101
|
*PulpDockerClient::ContentTagsApi* | [**read**](docs/ContentTagsApi.md#read) | **GET** {tag_href} | Inspect a tag
|
94
102
|
*PulpDockerClient::DistributionsDockerApi* | [**create**](docs/DistributionsDockerApi.md#create) | **POST** /pulp/api/v3/distributions/docker/docker/ | Create a docker distribution
|
@@ -115,19 +123,19 @@ Class | Method | HTTP request | Description
|
|
115
123
|
## Documentation for Models
|
116
124
|
|
117
125
|
- [PulpDockerClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
|
118
|
-
- [PulpDockerClient::
|
119
|
-
- [PulpDockerClient::
|
120
|
-
- [PulpDockerClient::
|
126
|
+
- [PulpDockerClient::DockerBlob](docs/DockerBlob.md)
|
127
|
+
- [PulpDockerClient::DockerDockerDistribution](docs/DockerDockerDistribution.md)
|
128
|
+
- [PulpDockerClient::DockerDockerRemote](docs/DockerDockerRemote.md)
|
129
|
+
- [PulpDockerClient::DockerManifest](docs/DockerManifest.md)
|
130
|
+
- [PulpDockerClient::DockerTag](docs/DockerTag.md)
|
121
131
|
- [PulpDockerClient::InlineResponse200](docs/InlineResponse200.md)
|
122
132
|
- [PulpDockerClient::InlineResponse2001](docs/InlineResponse2001.md)
|
123
133
|
- [PulpDockerClient::InlineResponse2002](docs/InlineResponse2002.md)
|
124
134
|
- [PulpDockerClient::InlineResponse2003](docs/InlineResponse2003.md)
|
125
135
|
- [PulpDockerClient::InlineResponse2004](docs/InlineResponse2004.md)
|
126
|
-
- [PulpDockerClient::Manifest](docs/Manifest.md)
|
127
136
|
- [PulpDockerClient::ManifestCopy](docs/ManifestCopy.md)
|
128
137
|
- [PulpDockerClient::RecursiveManage](docs/RecursiveManage.md)
|
129
138
|
- [PulpDockerClient::RepositorySyncURL](docs/RepositorySyncURL.md)
|
130
|
-
- [PulpDockerClient::Tag](docs/Tag.md)
|
131
139
|
- [PulpDockerClient::TagCopy](docs/TagCopy.md)
|
132
140
|
- [PulpDockerClient::TagImage](docs/TagImage.md)
|
133
141
|
- [PulpDockerClient::UnTagImage](docs/UnTagImage.md)
|
data/docs/ContentBlobsApi.md
CHANGED
@@ -4,65 +4,11 @@ All URIs are relative to *http://localhost:24817*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**create**](ContentBlobsApi.md#create) | **POST** /pulp/api/v3/content/docker/blobs/ | Create a blob
|
8
7
|
[**list**](ContentBlobsApi.md#list) | **GET** /pulp/api/v3/content/docker/blobs/ | List blobs
|
9
8
|
[**read**](ContentBlobsApi.md#read) | **GET** {blob_href} | Inspect a blob
|
10
9
|
|
11
10
|
|
12
11
|
|
13
|
-
## create
|
14
|
-
|
15
|
-
> Blob create(data)
|
16
|
-
|
17
|
-
Create a blob
|
18
|
-
|
19
|
-
Create a new Blob from a request.
|
20
|
-
|
21
|
-
### Example
|
22
|
-
|
23
|
-
```ruby
|
24
|
-
# load the gem
|
25
|
-
require 'pulp_docker_client'
|
26
|
-
# setup authorization
|
27
|
-
PulpDockerClient.configure do |config|
|
28
|
-
# Configure HTTP basic authorization: Basic
|
29
|
-
config.username = 'YOUR USERNAME'
|
30
|
-
config.password = 'YOUR PASSWORD'
|
31
|
-
end
|
32
|
-
|
33
|
-
api_instance = PulpDockerClient::ContentBlobsApi.new
|
34
|
-
data = PulpDockerClient::Blob.new # Blob |
|
35
|
-
|
36
|
-
begin
|
37
|
-
#Create a blob
|
38
|
-
result = api_instance.create(data)
|
39
|
-
p result
|
40
|
-
rescue PulpDockerClient::ApiError => e
|
41
|
-
puts "Exception when calling ContentBlobsApi->create: #{e}"
|
42
|
-
end
|
43
|
-
```
|
44
|
-
|
45
|
-
### Parameters
|
46
|
-
|
47
|
-
|
48
|
-
Name | Type | Description | Notes
|
49
|
-
------------- | ------------- | ------------- | -------------
|
50
|
-
**data** | [**Blob**](Blob.md)| |
|
51
|
-
|
52
|
-
### Return type
|
53
|
-
|
54
|
-
[**Blob**](Blob.md)
|
55
|
-
|
56
|
-
### Authorization
|
57
|
-
|
58
|
-
[Basic](../README.md#Basic)
|
59
|
-
|
60
|
-
### HTTP request headers
|
61
|
-
|
62
|
-
- **Content-Type**: application/json
|
63
|
-
- **Accept**: application/json
|
64
|
-
|
65
|
-
|
66
12
|
## list
|
67
13
|
|
68
14
|
> InlineResponse200 list(opts)
|
@@ -93,7 +39,8 @@ opts = {
|
|
93
39
|
media_type: 'media_type_example', # String |
|
94
40
|
limit: 56, # Integer | Number of results to return per page.
|
95
41
|
offset: 56, # Integer | The initial index from which to return the results.
|
96
|
-
fields: 'fields_example' # String | A list of fields to include in the response.
|
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.
|
97
44
|
}
|
98
45
|
|
99
46
|
begin
|
@@ -119,6 +66,7 @@ Name | Type | Description | Notes
|
|
119
66
|
**limit** | **Integer**| Number of results to return per page. | [optional]
|
120
67
|
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
121
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]
|
122
70
|
|
123
71
|
### Return type
|
124
72
|
|
@@ -136,7 +84,7 @@ Name | Type | Description | Notes
|
|
136
84
|
|
137
85
|
## read
|
138
86
|
|
139
|
-
>
|
87
|
+
> DockerBlob read(blob_href, opts)
|
140
88
|
|
141
89
|
Inspect a blob
|
142
90
|
|
@@ -157,7 +105,8 @@ end
|
|
157
105
|
api_instance = PulpDockerClient::ContentBlobsApi.new
|
158
106
|
blob_href = 'blob_href_example' # String | URI of Blob. e.g.: /pulp/api/v3/content/docker/blobs/1/
|
159
107
|
opts = {
|
160
|
-
fields: 'fields_example' # String | A list of fields to include in the response.
|
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.
|
161
110
|
}
|
162
111
|
|
163
112
|
begin
|
@@ -176,10 +125,11 @@ Name | Type | Description | Notes
|
|
176
125
|
------------- | ------------- | ------------- | -------------
|
177
126
|
**blob_href** | **String**| URI of Blob. e.g.: /pulp/api/v3/content/docker/blobs/1/ |
|
178
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]
|
179
129
|
|
180
130
|
### Return type
|
181
131
|
|
182
|
-
[**
|
132
|
+
[**DockerBlob**](DockerBlob.md)
|
183
133
|
|
184
134
|
### Authorization
|
185
135
|
|
data/docs/ContentManifestsApi.md
CHANGED
@@ -4,65 +4,11 @@ All URIs are relative to *http://localhost:24817*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**create**](ContentManifestsApi.md#create) | **POST** /pulp/api/v3/content/docker/manifests/ | Create a manifest
|
8
7
|
[**list**](ContentManifestsApi.md#list) | **GET** /pulp/api/v3/content/docker/manifests/ | List manifests
|
9
8
|
[**read**](ContentManifestsApi.md#read) | **GET** {manifest_href} | Inspect a manifest
|
10
9
|
|
11
10
|
|
12
11
|
|
13
|
-
## create
|
14
|
-
|
15
|
-
> Manifest create(data)
|
16
|
-
|
17
|
-
Create a manifest
|
18
|
-
|
19
|
-
Create a new Manifest from a request.
|
20
|
-
|
21
|
-
### Example
|
22
|
-
|
23
|
-
```ruby
|
24
|
-
# load the gem
|
25
|
-
require 'pulp_docker_client'
|
26
|
-
# setup authorization
|
27
|
-
PulpDockerClient.configure do |config|
|
28
|
-
# Configure HTTP basic authorization: Basic
|
29
|
-
config.username = 'YOUR USERNAME'
|
30
|
-
config.password = 'YOUR PASSWORD'
|
31
|
-
end
|
32
|
-
|
33
|
-
api_instance = PulpDockerClient::ContentManifestsApi.new
|
34
|
-
data = PulpDockerClient::Manifest.new # Manifest |
|
35
|
-
|
36
|
-
begin
|
37
|
-
#Create a manifest
|
38
|
-
result = api_instance.create(data)
|
39
|
-
p result
|
40
|
-
rescue PulpDockerClient::ApiError => e
|
41
|
-
puts "Exception when calling ContentManifestsApi->create: #{e}"
|
42
|
-
end
|
43
|
-
```
|
44
|
-
|
45
|
-
### Parameters
|
46
|
-
|
47
|
-
|
48
|
-
Name | Type | Description | Notes
|
49
|
-
------------- | ------------- | ------------- | -------------
|
50
|
-
**data** | [**Manifest**](Manifest.md)| |
|
51
|
-
|
52
|
-
### Return type
|
53
|
-
|
54
|
-
[**Manifest**](Manifest.md)
|
55
|
-
|
56
|
-
### Authorization
|
57
|
-
|
58
|
-
[Basic](../README.md#Basic)
|
59
|
-
|
60
|
-
### HTTP request headers
|
61
|
-
|
62
|
-
- **Content-Type**: application/json
|
63
|
-
- **Accept**: application/json
|
64
|
-
|
65
|
-
|
66
12
|
## list
|
67
13
|
|
68
14
|
> InlineResponse2001 list(opts)
|
@@ -93,7 +39,8 @@ opts = {
|
|
93
39
|
media_type: 'media_type_example', # String |
|
94
40
|
limit: 56, # Integer | Number of results to return per page.
|
95
41
|
offset: 56, # Integer | The initial index from which to return the results.
|
96
|
-
fields: 'fields_example' # String | A list of fields to include in the response.
|
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.
|
97
44
|
}
|
98
45
|
|
99
46
|
begin
|
@@ -119,6 +66,7 @@ Name | Type | Description | Notes
|
|
119
66
|
**limit** | **Integer**| Number of results to return per page. | [optional]
|
120
67
|
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
121
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]
|
122
70
|
|
123
71
|
### Return type
|
124
72
|
|
@@ -136,7 +84,7 @@ Name | Type | Description | Notes
|
|
136
84
|
|
137
85
|
## read
|
138
86
|
|
139
|
-
>
|
87
|
+
> DockerManifest read(manifest_href, opts)
|
140
88
|
|
141
89
|
Inspect a manifest
|
142
90
|
|
@@ -157,7 +105,8 @@ end
|
|
157
105
|
api_instance = PulpDockerClient::ContentManifestsApi.new
|
158
106
|
manifest_href = 'manifest_href_example' # String | URI of Manifest. e.g.: /pulp/api/v3/content/docker/manifests/1/
|
159
107
|
opts = {
|
160
|
-
fields: 'fields_example' # String | A list of fields to include in the response.
|
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.
|
161
110
|
}
|
162
111
|
|
163
112
|
begin
|
@@ -176,10 +125,11 @@ Name | Type | Description | Notes
|
|
176
125
|
------------- | ------------- | ------------- | -------------
|
177
126
|
**manifest_href** | **String**| URI of Manifest. e.g.: /pulp/api/v3/content/docker/manifests/1/ |
|
178
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]
|
179
129
|
|
180
130
|
### Return type
|
181
131
|
|
182
|
-
[**
|
132
|
+
[**DockerManifest**](DockerManifest.md)
|
183
133
|
|
184
134
|
### Authorization
|
185
135
|
|
data/docs/ContentTagsApi.md
CHANGED
@@ -4,65 +4,11 @@ All URIs are relative to *http://localhost:24817*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**create**](ContentTagsApi.md#create) | **POST** /pulp/api/v3/content/docker/tags/ | Create a tag
|
8
7
|
[**list**](ContentTagsApi.md#list) | **GET** /pulp/api/v3/content/docker/tags/ | List tags
|
9
8
|
[**read**](ContentTagsApi.md#read) | **GET** {tag_href} | Inspect a tag
|
10
9
|
|
11
10
|
|
12
11
|
|
13
|
-
## create
|
14
|
-
|
15
|
-
> Tag create(data)
|
16
|
-
|
17
|
-
Create a tag
|
18
|
-
|
19
|
-
Create a new Tag from a request.
|
20
|
-
|
21
|
-
### Example
|
22
|
-
|
23
|
-
```ruby
|
24
|
-
# load the gem
|
25
|
-
require 'pulp_docker_client'
|
26
|
-
# setup authorization
|
27
|
-
PulpDockerClient.configure do |config|
|
28
|
-
# Configure HTTP basic authorization: Basic
|
29
|
-
config.username = 'YOUR USERNAME'
|
30
|
-
config.password = 'YOUR PASSWORD'
|
31
|
-
end
|
32
|
-
|
33
|
-
api_instance = PulpDockerClient::ContentTagsApi.new
|
34
|
-
data = PulpDockerClient::Tag.new # Tag |
|
35
|
-
|
36
|
-
begin
|
37
|
-
#Create a tag
|
38
|
-
result = api_instance.create(data)
|
39
|
-
p result
|
40
|
-
rescue PulpDockerClient::ApiError => e
|
41
|
-
puts "Exception when calling ContentTagsApi->create: #{e}"
|
42
|
-
end
|
43
|
-
```
|
44
|
-
|
45
|
-
### Parameters
|
46
|
-
|
47
|
-
|
48
|
-
Name | Type | Description | Notes
|
49
|
-
------------- | ------------- | ------------- | -------------
|
50
|
-
**data** | [**Tag**](Tag.md)| |
|
51
|
-
|
52
|
-
### Return type
|
53
|
-
|
54
|
-
[**Tag**](Tag.md)
|
55
|
-
|
56
|
-
### Authorization
|
57
|
-
|
58
|
-
[Basic](../README.md#Basic)
|
59
|
-
|
60
|
-
### HTTP request headers
|
61
|
-
|
62
|
-
- **Content-Type**: application/json
|
63
|
-
- **Accept**: application/json
|
64
|
-
|
65
|
-
|
66
12
|
## list
|
67
13
|
|
68
14
|
> InlineResponse2002 list(opts)
|
@@ -94,7 +40,8 @@ opts = {
|
|
94
40
|
digest: 'digest_example', # String | Multiple values may be separated by commas.
|
95
41
|
limit: 56, # Integer | Number of results to return per page.
|
96
42
|
offset: 56, # Integer | The initial index from which to return the results.
|
97
|
-
fields: 'fields_example' # String | A list of fields to include in the response.
|
43
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
44
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
98
45
|
}
|
99
46
|
|
100
47
|
begin
|
@@ -121,6 +68,7 @@ Name | Type | Description | Notes
|
|
121
68
|
**limit** | **Integer**| Number of results to return per page. | [optional]
|
122
69
|
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
123
70
|
**fields** | **String**| A list of fields to include in the response. | [optional]
|
71
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
124
72
|
|
125
73
|
### Return type
|
126
74
|
|
@@ -138,7 +86,7 @@ Name | Type | Description | Notes
|
|
138
86
|
|
139
87
|
## read
|
140
88
|
|
141
|
-
>
|
89
|
+
> DockerTag read(tag_href, opts)
|
142
90
|
|
143
91
|
Inspect a tag
|
144
92
|
|
@@ -159,7 +107,8 @@ end
|
|
159
107
|
api_instance = PulpDockerClient::ContentTagsApi.new
|
160
108
|
tag_href = 'tag_href_example' # String | URI of Tag. e.g.: /pulp/api/v3/content/docker/tags/1/
|
161
109
|
opts = {
|
162
|
-
fields: 'fields_example' # String | A list of fields to include in the response.
|
110
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
111
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
163
112
|
}
|
164
113
|
|
165
114
|
begin
|
@@ -178,10 +127,11 @@ Name | Type | Description | Notes
|
|
178
127
|
------------- | ------------- | ------------- | -------------
|
179
128
|
**tag_href** | **String**| URI of Tag. e.g.: /pulp/api/v3/content/docker/tags/1/ |
|
180
129
|
**fields** | **String**| A list of fields to include in the response. | [optional]
|
130
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
181
131
|
|
182
132
|
### Return type
|
183
133
|
|
184
|
-
[**
|
134
|
+
[**DockerTag**](DockerTag.md)
|
185
135
|
|
186
136
|
### Authorization
|
187
137
|
|
@@ -34,7 +34,7 @@ PulpDockerClient.configure do |config|
|
|
34
34
|
end
|
35
35
|
|
36
36
|
api_instance = PulpDockerClient::DistributionsDockerApi.new
|
37
|
-
data = PulpDockerClient::
|
37
|
+
data = PulpDockerClient::DockerDockerDistribution.new # DockerDockerDistribution |
|
38
38
|
|
39
39
|
begin
|
40
40
|
#Create a docker distribution
|
@@ -50,7 +50,7 @@ end
|
|
50
50
|
|
51
51
|
Name | Type | Description | Notes
|
52
52
|
------------- | ------------- | ------------- | -------------
|
53
|
-
**data** | [**
|
53
|
+
**data** | [**DockerDockerDistribution**](DockerDockerDistribution.md)| |
|
54
54
|
|
55
55
|
### Return type
|
56
56
|
|
@@ -149,7 +149,8 @@ opts = {
|
|
149
149
|
base_path__in: 'base_path__in_example', # String | Filter results where base_path is in a comma-separated list of values
|
150
150
|
limit: 56, # Integer | Number of results to return per page.
|
151
151
|
offset: 56, # Integer | The initial index from which to return the results.
|
152
|
-
fields: 'fields_example' # String | A list of fields to include in the response.
|
152
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
153
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
153
154
|
}
|
154
155
|
|
155
156
|
begin
|
@@ -175,6 +176,7 @@ Name | Type | Description | Notes
|
|
175
176
|
**limit** | **Integer**| Number of results to return per page. | [optional]
|
176
177
|
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
177
178
|
**fields** | **String**| A list of fields to include in the response. | [optional]
|
179
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
178
180
|
|
179
181
|
### Return type
|
180
182
|
|
@@ -212,7 +214,7 @@ end
|
|
212
214
|
|
213
215
|
api_instance = PulpDockerClient::DistributionsDockerApi.new
|
214
216
|
docker_distribution_href = 'docker_distribution_href_example' # String | URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/
|
215
|
-
data = PulpDockerClient::
|
217
|
+
data = PulpDockerClient::DockerDockerDistribution.new # DockerDockerDistribution |
|
216
218
|
|
217
219
|
begin
|
218
220
|
#Partially update a docker distribution
|
@@ -229,7 +231,7 @@ end
|
|
229
231
|
Name | Type | Description | Notes
|
230
232
|
------------- | ------------- | ------------- | -------------
|
231
233
|
**docker_distribution_href** | **String**| URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/ |
|
232
|
-
**data** | [**
|
234
|
+
**data** | [**DockerDockerDistribution**](DockerDockerDistribution.md)| |
|
233
235
|
|
234
236
|
### Return type
|
235
237
|
|
@@ -247,7 +249,7 @@ Name | Type | Description | Notes
|
|
247
249
|
|
248
250
|
## read
|
249
251
|
|
250
|
-
>
|
252
|
+
> DockerDockerDistribution read(docker_distribution_href, opts)
|
251
253
|
|
252
254
|
Inspect a docker distribution
|
253
255
|
|
@@ -268,7 +270,8 @@ end
|
|
268
270
|
api_instance = PulpDockerClient::DistributionsDockerApi.new
|
269
271
|
docker_distribution_href = 'docker_distribution_href_example' # String | URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/
|
270
272
|
opts = {
|
271
|
-
fields: 'fields_example' # String | A list of fields to include in the response.
|
273
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
274
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
272
275
|
}
|
273
276
|
|
274
277
|
begin
|
@@ -287,10 +290,11 @@ Name | Type | Description | Notes
|
|
287
290
|
------------- | ------------- | ------------- | -------------
|
288
291
|
**docker_distribution_href** | **String**| URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/ |
|
289
292
|
**fields** | **String**| A list of fields to include in the response. | [optional]
|
293
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
290
294
|
|
291
295
|
### Return type
|
292
296
|
|
293
|
-
[**
|
297
|
+
[**DockerDockerDistribution**](DockerDockerDistribution.md)
|
294
298
|
|
295
299
|
### Authorization
|
296
300
|
|
@@ -324,7 +328,7 @@ end
|
|
324
328
|
|
325
329
|
api_instance = PulpDockerClient::DistributionsDockerApi.new
|
326
330
|
docker_distribution_href = 'docker_distribution_href_example' # String | URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/
|
327
|
-
data = PulpDockerClient::
|
331
|
+
data = PulpDockerClient::DockerDockerDistribution.new # DockerDockerDistribution |
|
328
332
|
|
329
333
|
begin
|
330
334
|
#Update a docker distribution
|
@@ -341,7 +345,7 @@ end
|
|
341
345
|
Name | Type | Description | Notes
|
342
346
|
------------- | ------------- | ------------- | -------------
|
343
347
|
**docker_distribution_href** | **String**| URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/ |
|
344
|
-
**data** | [**
|
348
|
+
**data** | [**DockerDockerDistribution**](DockerDockerDistribution.md)| |
|
345
349
|
|
346
350
|
### Return type
|
347
351
|
|
@@ -1,14 +1,12 @@
|
|
1
|
-
# PulpDockerClient::
|
1
|
+
# PulpDockerClient::DockerBlob
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**_type** | **String** | | [optional]
|
7
|
+
**pulp_href** | **String** | | [optional] [readonly]
|
8
|
+
**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
|
10
9
|
**artifact** | **String** | Artifact file representing the physical content |
|
11
|
-
**relative_path** | **String** | Path where the artifact is located relative to distributions base_path |
|
12
10
|
**digest** | **String** | sha256 of the Blob file |
|
13
11
|
**media_type** | **String** | Docker media type of the file |
|
14
12
|
|
@@ -17,11 +15,9 @@ Name | Type | Description | Notes
|
|
17
15
|
```ruby
|
18
16
|
require 'PulpDockerClient'
|
19
17
|
|
20
|
-
instance = PulpDockerClient::
|
21
|
-
|
22
|
-
_type: null,
|
18
|
+
instance = PulpDockerClient::DockerBlob.new(pulp_href: null,
|
19
|
+
pulp_created: null,
|
23
20
|
artifact: null,
|
24
|
-
relative_path: null,
|
25
21
|
digest: null,
|
26
22
|
media_type: null)
|
27
23
|
```
|
@@ -1,30 +1,30 @@
|
|
1
|
-
# PulpDockerClient::
|
1
|
+
# PulpDockerClient::DockerDockerDistribution
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**content_guard** | **String** | An optional content-guard. | [optional]
|
8
7
|
**repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional]
|
9
|
-
**
|
8
|
+
**repository_version** | **String** | RepositoryVersion to be served | [optional]
|
9
|
+
**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
|
10
|
+
**pulp_href** | **String** | | [optional] [readonly]
|
10
11
|
**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\") |
|
11
|
-
**
|
12
|
+
**content_guard** | **String** | An optional content-guard. | [optional]
|
12
13
|
**name** | **String** | A unique name. Ex, `rawhide` and `stable`. |
|
13
|
-
**
|
14
|
-
**registry_path** | **String** | The Registry hostame:port/name/ to use with docker pull command defined by this distribution. | [optional]
|
14
|
+
**registry_path** | **String** | The Registry hostame:port/name/ to use with docker pull command defined by this distribution. | [optional] [readonly]
|
15
15
|
|
16
16
|
## Code Sample
|
17
17
|
|
18
18
|
```ruby
|
19
19
|
require 'PulpDockerClient'
|
20
20
|
|
21
|
-
instance = PulpDockerClient::
|
22
|
-
|
23
|
-
|
21
|
+
instance = PulpDockerClient::DockerDockerDistribution.new(repository: null,
|
22
|
+
repository_version: null,
|
23
|
+
pulp_created: null,
|
24
|
+
pulp_href: null,
|
24
25
|
base_path: null,
|
25
|
-
|
26
|
+
content_guard: null,
|
26
27
|
name: null,
|
27
|
-
repository_version: null,
|
28
28
|
registry_path: null)
|
29
29
|
```
|
30
30
|
|