pulpcore_client 3.0.0rc2
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/Gemfile.lock +79 -0
- data/README.md +151 -0
- data/Rakefile +10 -0
- data/docs/Artifact.md +37 -0
- data/docs/ArtifactsApi.md +253 -0
- data/docs/AsyncOperationResponse.md +17 -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/OrphansApi.md +58 -0
- data/docs/ProgressReport.md +27 -0
- data/docs/RepositoriesApi.md +584 -0
- data/docs/Repository.md +27 -0
- data/docs/RepositoryVersion.md +25 -0
- data/docs/RepositoryVersionCreate.md +21 -0
- data/docs/StatusApi.md +57 -0
- data/docs/Task.md +41 -0
- data/docs/TasksApi.md +263 -0
- data/docs/Upload.md +25 -0
- data/docs/UploadsApi.md +395 -0
- data/docs/Worker.md +27 -0
- data/docs/WorkersApi.md +136 -0
- data/git_push.sh +55 -0
- data/lib/pulpcore_client/api/artifacts_api.rb +306 -0
- data/lib/pulpcore_client/api/orphans_api.rb +78 -0
- data/lib/pulpcore_client/api/repositories_api.rb +710 -0
- data/lib/pulpcore_client/api/status_api.rb +76 -0
- data/lib/pulpcore_client/api/tasks_api.rb +330 -0
- data/lib/pulpcore_client/api/uploads_api.rb +493 -0
- data/lib/pulpcore_client/api/workers_api.rb +172 -0
- data/lib/pulpcore_client/api_client.rb +387 -0
- data/lib/pulpcore_client/api_error.rb +57 -0
- data/lib/pulpcore_client/configuration.rb +251 -0
- data/lib/pulpcore_client/models/artifact.rb +296 -0
- data/lib/pulpcore_client/models/async_operation_response.rb +202 -0
- data/lib/pulpcore_client/models/inline_response200.rb +235 -0
- data/lib/pulpcore_client/models/inline_response2001.rb +235 -0
- data/lib/pulpcore_client/models/inline_response2002.rb +235 -0
- data/lib/pulpcore_client/models/inline_response2003.rb +235 -0
- data/lib/pulpcore_client/models/inline_response2004.rb +235 -0
- data/lib/pulpcore_client/models/inline_response2005.rb +235 -0
- data/lib/pulpcore_client/models/progress_report.rb +277 -0
- data/lib/pulpcore_client/models/repository.rb +268 -0
- data/lib/pulpcore_client/models/repository_version.rb +235 -0
- data/lib/pulpcore_client/models/repository_version_create.rb +231 -0
- data/lib/pulpcore_client/models/task.rb +360 -0
- data/lib/pulpcore_client/models/upload.rb +257 -0
- data/lib/pulpcore_client/models/worker.rb +261 -0
- data/lib/pulpcore_client/version.rb +15 -0
- data/lib/pulpcore_client.rb +61 -0
- data/pulpcore_client.gemspec +45 -0
- data/spec/api/artifacts_api_spec.rb +96 -0
- data/spec/api/orphans_api_spec.rb +46 -0
- data/spec/api/repositories_api_spec.rb +171 -0
- data/spec/api/status_api_spec.rb +46 -0
- data/spec/api/tasks_api_spec.rb +102 -0
- data/spec/api/uploads_api_spec.rb +123 -0
- data/spec/api/workers_api_spec.rb +68 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/artifact_spec.rb +101 -0
- data/spec/models/async_operation_response_spec.rb +41 -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_response200_spec.rb +59 -0
- data/spec/models/progress_report_spec.rb +71 -0
- data/spec/models/repository_spec.rb +71 -0
- data/spec/models/repository_version_create_spec.rb +53 -0
- data/spec/models/repository_version_spec.rb +65 -0
- data/spec/models/task_spec.rb +113 -0
- data/spec/models/upload_spec.rb +65 -0
- data/spec/models/worker_spec.rb +71 -0
- data/spec/spec_helper.rb +111 -0
- metadata +329 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 457779e31e4791fafddf984fa4026b93884b99300b1908ff7a25b9ba2e515030
|
4
|
+
data.tar.gz: 62267bf3187a66e12878529d1ab6df604478f421d10200189e792bc57603a4af
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 77f79f265bd79533e12998551190af1174968a1f2e6e771b86389cbfdd2c0b7fc18749dfe4e0ce7401a0120ab1d6f2ea57fccb581ad4e20e600a12f410c5e990
|
7
|
+
data.tar.gz: 73ccbde045d0201310848946c4853f8d74e2986b595fe55d4ef79babff89d3a0b1d8583c936ff6ca10770593c9640e23e7a5fd85a6a97edfa20d4b3ec0534784
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,79 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
pulpcore_client (3.0.0rc2)
|
5
|
+
json (~> 2.1, >= 2.1.0)
|
6
|
+
typhoeus (~> 1.0, >= 1.0.1)
|
7
|
+
|
8
|
+
GEM
|
9
|
+
remote: https://rubygems.org/
|
10
|
+
specs:
|
11
|
+
ZenTest (4.11.2)
|
12
|
+
addressable (2.5.2)
|
13
|
+
public_suffix (>= 2.0.2, < 4.0)
|
14
|
+
autotest (4.4.6)
|
15
|
+
ZenTest (>= 4.4.1)
|
16
|
+
autotest-fsevent (0.2.14)
|
17
|
+
sys-uname
|
18
|
+
autotest-growl (0.2.16)
|
19
|
+
autotest-rails-pure (4.1.2)
|
20
|
+
byebug (10.0.2)
|
21
|
+
coderay (1.1.2)
|
22
|
+
crack (0.4.3)
|
23
|
+
safe_yaml (~> 1.0.0)
|
24
|
+
diff-lcs (1.3)
|
25
|
+
ethon (0.11.0)
|
26
|
+
ffi (>= 1.3.0)
|
27
|
+
ffi (1.9.25)
|
28
|
+
hashdiff (0.3.7)
|
29
|
+
json (2.1.0)
|
30
|
+
method_source (0.9.0)
|
31
|
+
pry (0.11.3)
|
32
|
+
coderay (~> 1.1.0)
|
33
|
+
method_source (~> 0.9.0)
|
34
|
+
pry-byebug (3.6.0)
|
35
|
+
byebug (~> 10.0)
|
36
|
+
pry (~> 0.10)
|
37
|
+
public_suffix (3.0.3)
|
38
|
+
rake (12.0.0)
|
39
|
+
rspec (3.8.0)
|
40
|
+
rspec-core (~> 3.8.0)
|
41
|
+
rspec-expectations (~> 3.8.0)
|
42
|
+
rspec-mocks (~> 3.8.0)
|
43
|
+
rspec-core (3.8.0)
|
44
|
+
rspec-support (~> 3.8.0)
|
45
|
+
rspec-expectations (3.8.1)
|
46
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
47
|
+
rspec-support (~> 3.8.0)
|
48
|
+
rspec-mocks (3.8.0)
|
49
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
50
|
+
rspec-support (~> 3.8.0)
|
51
|
+
rspec-support (3.8.0)
|
52
|
+
safe_yaml (1.0.4)
|
53
|
+
sys-uname (1.0.3)
|
54
|
+
ffi (>= 1.0.0)
|
55
|
+
typhoeus (1.3.0)
|
56
|
+
ethon (>= 0.9.0)
|
57
|
+
vcr (3.0.3)
|
58
|
+
webmock (1.24.6)
|
59
|
+
addressable (>= 2.3.6)
|
60
|
+
crack (>= 0.3.2)
|
61
|
+
hashdiff
|
62
|
+
|
63
|
+
PLATFORMS
|
64
|
+
ruby
|
65
|
+
|
66
|
+
DEPENDENCIES
|
67
|
+
autotest (~> 4.4, >= 4.4.6)
|
68
|
+
autotest-fsevent (~> 0.2, >= 0.2.12)
|
69
|
+
autotest-growl (~> 0.2, >= 0.2.16)
|
70
|
+
autotest-rails-pure (~> 4.1, >= 4.1.2)
|
71
|
+
pulpcore_client!
|
72
|
+
pry-byebug
|
73
|
+
rake (~> 12.0.0)
|
74
|
+
rspec (~> 3.6, >= 3.6.0)
|
75
|
+
vcr (~> 3.0, >= 3.0.1)
|
76
|
+
webmock (~> 1.24, >= 1.24.3)
|
77
|
+
|
78
|
+
BUNDLED WITH
|
79
|
+
1.16.1
|
data/README.md
ADDED
@@ -0,0 +1,151 @@
|
|
1
|
+
# pulpcore_client
|
2
|
+
|
3
|
+
PulpcoreClient - 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: 3.0.0rc2
|
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 pulpcore_client.gemspec
|
21
|
+
```
|
22
|
+
|
23
|
+
Then either install the gem locally:
|
24
|
+
|
25
|
+
```shell
|
26
|
+
gem install ./pulpcore_client-3.0.0rc2.gem
|
27
|
+
```
|
28
|
+
|
29
|
+
(for development, run `gem install --dev ./pulpcore_client-3.0.0rc2.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 'pulpcore_client', '~> 3.0.0rc2'
|
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 'pulpcore_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 'pulpcore_client'
|
58
|
+
|
59
|
+
# Setup authorization
|
60
|
+
PulpcoreClient.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 = PulpcoreClient::ArtifactsApi.new
|
67
|
+
opts = {
|
68
|
+
file: File.new('/path/to/file'), # File | The stored file.
|
69
|
+
size: 56, # Integer | The size of the file in bytes.
|
70
|
+
md5: 'md5_example', # String | The MD5 checksum of the file if available.
|
71
|
+
sha1: 'sha1_example', # String | The SHA-1 checksum of the file if available.
|
72
|
+
sha224: 'sha224_example', # String | The SHA-224 checksum of the file if available.
|
73
|
+
sha256: 'sha256_example', # String | The SHA-256 checksum of the file if available.
|
74
|
+
sha384: 'sha384_example', # String | The SHA-384 checksum of the file if available.
|
75
|
+
sha512: 'sha512_example', # String | The SHA-512 checksum of the file if available.
|
76
|
+
upload: 'upload_example' # String | An href for an Upload.
|
77
|
+
}
|
78
|
+
|
79
|
+
begin
|
80
|
+
#Create an artifact
|
81
|
+
result = api_instance.artifacts_create(opts)
|
82
|
+
p result
|
83
|
+
rescue PulpcoreClient::ApiError => e
|
84
|
+
puts "Exception when calling ArtifactsApi->artifacts_create: #{e}"
|
85
|
+
end
|
86
|
+
|
87
|
+
```
|
88
|
+
|
89
|
+
## Documentation for API Endpoints
|
90
|
+
|
91
|
+
All URIs are relative to *http://localhost:24817*
|
92
|
+
|
93
|
+
Class | Method | HTTP request | Description
|
94
|
+
------------ | ------------- | ------------- | -------------
|
95
|
+
*PulpcoreClient::ArtifactsApi* | [**artifacts_create**](docs/ArtifactsApi.md#artifacts_create) | **POST** /pulp/api/v3/artifacts/ | Create an artifact
|
96
|
+
*PulpcoreClient::ArtifactsApi* | [**artifacts_delete**](docs/ArtifactsApi.md#artifacts_delete) | **DELETE** {artifact_href} | Delete an artifact
|
97
|
+
*PulpcoreClient::ArtifactsApi* | [**artifacts_list**](docs/ArtifactsApi.md#artifacts_list) | **GET** /pulp/api/v3/artifacts/ | List artifacts
|
98
|
+
*PulpcoreClient::ArtifactsApi* | [**artifacts_read**](docs/ArtifactsApi.md#artifacts_read) | **GET** {artifact_href} | Inspect an artifact
|
99
|
+
*PulpcoreClient::OrphansApi* | [**orphans_delete**](docs/OrphansApi.md#orphans_delete) | **DELETE** /pulp/api/v3/orphans/ | Delete orphans
|
100
|
+
*PulpcoreClient::RepositoriesApi* | [**repositories_create**](docs/RepositoriesApi.md#repositories_create) | **POST** /pulp/api/v3/repositories/ | Create a repository
|
101
|
+
*PulpcoreClient::RepositoriesApi* | [**repositories_delete**](docs/RepositoriesApi.md#repositories_delete) | **DELETE** {repository_href} | Delete a repository
|
102
|
+
*PulpcoreClient::RepositoriesApi* | [**repositories_list**](docs/RepositoriesApi.md#repositories_list) | **GET** /pulp/api/v3/repositories/ | List repositories
|
103
|
+
*PulpcoreClient::RepositoriesApi* | [**repositories_partial_update**](docs/RepositoriesApi.md#repositories_partial_update) | **PATCH** {repository_href} | Partially update a repository
|
104
|
+
*PulpcoreClient::RepositoriesApi* | [**repositories_read**](docs/RepositoriesApi.md#repositories_read) | **GET** {repository_href} | Inspect a repository
|
105
|
+
*PulpcoreClient::RepositoriesApi* | [**repositories_update**](docs/RepositoriesApi.md#repositories_update) | **PUT** {repository_href} | Update a repository
|
106
|
+
*PulpcoreClient::RepositoriesApi* | [**repositories_versions_create**](docs/RepositoriesApi.md#repositories_versions_create) | **POST** {repository_href}versions/ | Create a repository version
|
107
|
+
*PulpcoreClient::RepositoriesApi* | [**repositories_versions_delete**](docs/RepositoriesApi.md#repositories_versions_delete) | **DELETE** {repository_version_href} | Delete a repository version
|
108
|
+
*PulpcoreClient::RepositoriesApi* | [**repositories_versions_list**](docs/RepositoriesApi.md#repositories_versions_list) | **GET** {repository_href}versions/ | List repository versions
|
109
|
+
*PulpcoreClient::RepositoriesApi* | [**repositories_versions_read**](docs/RepositoriesApi.md#repositories_versions_read) | **GET** {repository_version_href} | Inspect a repository version
|
110
|
+
*PulpcoreClient::StatusApi* | [**status_list**](docs/StatusApi.md#status_list) | **GET** /pulp/api/v3/status/ | Inspect status of Pulp
|
111
|
+
*PulpcoreClient::TasksApi* | [**tasks_cancel**](docs/TasksApi.md#tasks_cancel) | **POST** {task_href}cancel/ | Cancel a task
|
112
|
+
*PulpcoreClient::TasksApi* | [**tasks_delete**](docs/TasksApi.md#tasks_delete) | **DELETE** {task_href} | Delete a task
|
113
|
+
*PulpcoreClient::TasksApi* | [**tasks_list**](docs/TasksApi.md#tasks_list) | **GET** /pulp/api/v3/tasks/ | List tasks
|
114
|
+
*PulpcoreClient::TasksApi* | [**tasks_read**](docs/TasksApi.md#tasks_read) | **GET** {task_href} | Inspect a task
|
115
|
+
*PulpcoreClient::UploadsApi* | [**uploads_create**](docs/UploadsApi.md#uploads_create) | **PUT** /pulp/api/v3/uploads/ | Start Upload
|
116
|
+
*PulpcoreClient::UploadsApi* | [**uploads_create_and_check**](docs/UploadsApi.md#uploads_create_and_check) | **POST** /pulp/api/v3/uploads/ | Create an Upload
|
117
|
+
*PulpcoreClient::UploadsApi* | [**uploads_delete**](docs/UploadsApi.md#uploads_delete) | **DELETE** {upload_href} | Delete an upload
|
118
|
+
*PulpcoreClient::UploadsApi* | [**uploads_finish**](docs/UploadsApi.md#uploads_finish) | **POST** {upload_href} | Finish an Upload
|
119
|
+
*PulpcoreClient::UploadsApi* | [**uploads_list**](docs/UploadsApi.md#uploads_list) | **GET** /pulp/api/v3/uploads/ | List uploads
|
120
|
+
*PulpcoreClient::UploadsApi* | [**uploads_read**](docs/UploadsApi.md#uploads_read) | **GET** {upload_href} | Inspect an upload
|
121
|
+
*PulpcoreClient::UploadsApi* | [**uploads_update**](docs/UploadsApi.md#uploads_update) | **PUT** {upload_href} | Continue an Upload
|
122
|
+
*PulpcoreClient::WorkersApi* | [**workers_list**](docs/WorkersApi.md#workers_list) | **GET** /pulp/api/v3/workers/ | List workers
|
123
|
+
*PulpcoreClient::WorkersApi* | [**workers_read**](docs/WorkersApi.md#workers_read) | **GET** {worker_href} | Inspect a worker
|
124
|
+
|
125
|
+
|
126
|
+
## Documentation for Models
|
127
|
+
|
128
|
+
- [PulpcoreClient::Artifact](docs/Artifact.md)
|
129
|
+
- [PulpcoreClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
|
130
|
+
- [PulpcoreClient::InlineResponse200](docs/InlineResponse200.md)
|
131
|
+
- [PulpcoreClient::InlineResponse2001](docs/InlineResponse2001.md)
|
132
|
+
- [PulpcoreClient::InlineResponse2002](docs/InlineResponse2002.md)
|
133
|
+
- [PulpcoreClient::InlineResponse2003](docs/InlineResponse2003.md)
|
134
|
+
- [PulpcoreClient::InlineResponse2004](docs/InlineResponse2004.md)
|
135
|
+
- [PulpcoreClient::InlineResponse2005](docs/InlineResponse2005.md)
|
136
|
+
- [PulpcoreClient::ProgressReport](docs/ProgressReport.md)
|
137
|
+
- [PulpcoreClient::Repository](docs/Repository.md)
|
138
|
+
- [PulpcoreClient::RepositoryVersion](docs/RepositoryVersion.md)
|
139
|
+
- [PulpcoreClient::RepositoryVersionCreate](docs/RepositoryVersionCreate.md)
|
140
|
+
- [PulpcoreClient::Task](docs/Task.md)
|
141
|
+
- [PulpcoreClient::Upload](docs/Upload.md)
|
142
|
+
- [PulpcoreClient::Worker](docs/Worker.md)
|
143
|
+
|
144
|
+
|
145
|
+
## Documentation for Authorization
|
146
|
+
|
147
|
+
|
148
|
+
### Basic
|
149
|
+
|
150
|
+
- **Type**: HTTP basic authentication
|
151
|
+
|
data/Rakefile
ADDED
data/docs/Artifact.md
ADDED
@@ -0,0 +1,37 @@
|
|
1
|
+
# PulpcoreClient::Artifact
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**_href** | **String** | | [optional]
|
8
|
+
**_created** | **DateTime** | Timestamp of creation. | [optional]
|
9
|
+
**file** | **String** | The stored file. | [optional]
|
10
|
+
**size** | **Integer** | The size of the file in bytes. | [optional]
|
11
|
+
**md5** | **String** | The MD5 checksum of the file if available. | [optional]
|
12
|
+
**sha1** | **String** | The SHA-1 checksum of the file if available. | [optional]
|
13
|
+
**sha224** | **String** | The SHA-224 checksum of the file if available. | [optional]
|
14
|
+
**sha256** | **String** | The SHA-256 checksum of the file if available. | [optional]
|
15
|
+
**sha384** | **String** | The SHA-384 checksum of the file if available. | [optional]
|
16
|
+
**sha512** | **String** | The SHA-512 checksum of the file if available. | [optional]
|
17
|
+
**upload** | **String** | An href for an Upload. | [optional]
|
18
|
+
|
19
|
+
## Code Sample
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'PulpcoreClient'
|
23
|
+
|
24
|
+
instance = PulpcoreClient::Artifact.new(_href: null,
|
25
|
+
_created: null,
|
26
|
+
file: null,
|
27
|
+
size: null,
|
28
|
+
md5: null,
|
29
|
+
sha1: null,
|
30
|
+
sha224: null,
|
31
|
+
sha256: null,
|
32
|
+
sha384: null,
|
33
|
+
sha512: null,
|
34
|
+
upload: null)
|
35
|
+
```
|
36
|
+
|
37
|
+
|
@@ -0,0 +1,253 @@
|
|
1
|
+
# PulpcoreClient::ArtifactsApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**artifacts_create**](ArtifactsApi.md#artifacts_create) | **POST** /pulp/api/v3/artifacts/ | Create an artifact
|
8
|
+
[**artifacts_delete**](ArtifactsApi.md#artifacts_delete) | **DELETE** {artifact_href} | Delete an artifact
|
9
|
+
[**artifacts_list**](ArtifactsApi.md#artifacts_list) | **GET** /pulp/api/v3/artifacts/ | List artifacts
|
10
|
+
[**artifacts_read**](ArtifactsApi.md#artifacts_read) | **GET** {artifact_href} | Inspect an artifact
|
11
|
+
|
12
|
+
|
13
|
+
|
14
|
+
## artifacts_create
|
15
|
+
|
16
|
+
> Artifact artifacts_create(opts)
|
17
|
+
|
18
|
+
Create an artifact
|
19
|
+
|
20
|
+
### Example
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
# load the gem
|
24
|
+
require 'pulpcore_client'
|
25
|
+
# setup authorization
|
26
|
+
PulpcoreClient.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 = PulpcoreClient::ArtifactsApi.new
|
33
|
+
opts = {
|
34
|
+
file: File.new('/path/to/file'), # File | The stored file.
|
35
|
+
size: 56, # Integer | The size of the file in bytes.
|
36
|
+
md5: 'md5_example', # String | The MD5 checksum of the file if available.
|
37
|
+
sha1: 'sha1_example', # String | The SHA-1 checksum of the file if available.
|
38
|
+
sha224: 'sha224_example', # String | The SHA-224 checksum of the file if available.
|
39
|
+
sha256: 'sha256_example', # String | The SHA-256 checksum of the file if available.
|
40
|
+
sha384: 'sha384_example', # String | The SHA-384 checksum of the file if available.
|
41
|
+
sha512: 'sha512_example', # String | The SHA-512 checksum of the file if available.
|
42
|
+
upload: 'upload_example' # String | An href for an Upload.
|
43
|
+
}
|
44
|
+
|
45
|
+
begin
|
46
|
+
#Create an artifact
|
47
|
+
result = api_instance.artifacts_create(opts)
|
48
|
+
p result
|
49
|
+
rescue PulpcoreClient::ApiError => e
|
50
|
+
puts "Exception when calling ArtifactsApi->artifacts_create: #{e}"
|
51
|
+
end
|
52
|
+
```
|
53
|
+
|
54
|
+
### Parameters
|
55
|
+
|
56
|
+
|
57
|
+
Name | Type | Description | Notes
|
58
|
+
------------- | ------------- | ------------- | -------------
|
59
|
+
**file** | **File**| The stored file. | [optional]
|
60
|
+
**size** | **Integer**| The size of the file in bytes. | [optional]
|
61
|
+
**md5** | **String**| The MD5 checksum of the file if available. | [optional]
|
62
|
+
**sha1** | **String**| The SHA-1 checksum of the file if available. | [optional]
|
63
|
+
**sha224** | **String**| The SHA-224 checksum of the file if available. | [optional]
|
64
|
+
**sha256** | **String**| The SHA-256 checksum of the file if available. | [optional]
|
65
|
+
**sha384** | **String**| The SHA-384 checksum of the file if available. | [optional]
|
66
|
+
**sha512** | **String**| The SHA-512 checksum of the file if available. | [optional]
|
67
|
+
**upload** | **String**| An href for an Upload. | [optional]
|
68
|
+
|
69
|
+
### Return type
|
70
|
+
|
71
|
+
[**Artifact**](Artifact.md)
|
72
|
+
|
73
|
+
### Authorization
|
74
|
+
|
75
|
+
[Basic](../README.md#Basic)
|
76
|
+
|
77
|
+
### HTTP request headers
|
78
|
+
|
79
|
+
- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
|
80
|
+
- **Accept**: application/json
|
81
|
+
|
82
|
+
|
83
|
+
## artifacts_delete
|
84
|
+
|
85
|
+
> artifacts_delete(artifact_href)
|
86
|
+
|
87
|
+
Delete an artifact
|
88
|
+
|
89
|
+
Remove Artifact only if it is not associated with any Content.
|
90
|
+
|
91
|
+
### Example
|
92
|
+
|
93
|
+
```ruby
|
94
|
+
# load the gem
|
95
|
+
require 'pulpcore_client'
|
96
|
+
# setup authorization
|
97
|
+
PulpcoreClient.configure do |config|
|
98
|
+
# Configure HTTP basic authorization: Basic
|
99
|
+
config.username = 'YOUR USERNAME'
|
100
|
+
config.password = 'YOUR PASSWORD'
|
101
|
+
end
|
102
|
+
|
103
|
+
api_instance = PulpcoreClient::ArtifactsApi.new
|
104
|
+
artifact_href = 'artifact_href_example' # String | URI of Artifact. e.g.: /pulp/api/v3/artifacts/1/
|
105
|
+
|
106
|
+
begin
|
107
|
+
#Delete an artifact
|
108
|
+
api_instance.artifacts_delete(artifact_href)
|
109
|
+
rescue PulpcoreClient::ApiError => e
|
110
|
+
puts "Exception when calling ArtifactsApi->artifacts_delete: #{e}"
|
111
|
+
end
|
112
|
+
```
|
113
|
+
|
114
|
+
### Parameters
|
115
|
+
|
116
|
+
|
117
|
+
Name | Type | Description | Notes
|
118
|
+
------------- | ------------- | ------------- | -------------
|
119
|
+
**artifact_href** | **String**| URI of Artifact. e.g.: /pulp/api/v3/artifacts/1/ |
|
120
|
+
|
121
|
+
### Return type
|
122
|
+
|
123
|
+
nil (empty response body)
|
124
|
+
|
125
|
+
### Authorization
|
126
|
+
|
127
|
+
[Basic](../README.md#Basic)
|
128
|
+
|
129
|
+
### HTTP request headers
|
130
|
+
|
131
|
+
- **Content-Type**: Not defined
|
132
|
+
- **Accept**: Not defined
|
133
|
+
|
134
|
+
|
135
|
+
## artifacts_list
|
136
|
+
|
137
|
+
> InlineResponse200 artifacts_list(opts)
|
138
|
+
|
139
|
+
List artifacts
|
140
|
+
|
141
|
+
### Example
|
142
|
+
|
143
|
+
```ruby
|
144
|
+
# load the gem
|
145
|
+
require 'pulpcore_client'
|
146
|
+
# setup authorization
|
147
|
+
PulpcoreClient.configure do |config|
|
148
|
+
# Configure HTTP basic authorization: Basic
|
149
|
+
config.username = 'YOUR USERNAME'
|
150
|
+
config.password = 'YOUR PASSWORD'
|
151
|
+
end
|
152
|
+
|
153
|
+
api_instance = PulpcoreClient::ArtifactsApi.new
|
154
|
+
opts = {
|
155
|
+
repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
|
156
|
+
md5: 'md5_example', # String | Filter results where md5 matches value
|
157
|
+
sha1: 'sha1_example', # String | Filter results where sha1 matches value
|
158
|
+
sha224: 'sha224_example', # String | Filter results where sha224 matches value
|
159
|
+
sha256: 'sha256_example', # String | Filter results where sha256 matches value
|
160
|
+
sha384: 'sha384_example', # String | Filter results where sha384 matches value
|
161
|
+
sha512: 'sha512_example', # String | Filter results where sha512 matches value
|
162
|
+
page: 56, # Integer | A page number within the paginated result set.
|
163
|
+
page_size: 56 # Integer | Number of results to return per page.
|
164
|
+
}
|
165
|
+
|
166
|
+
begin
|
167
|
+
#List artifacts
|
168
|
+
result = api_instance.artifacts_list(opts)
|
169
|
+
p result
|
170
|
+
rescue PulpcoreClient::ApiError => e
|
171
|
+
puts "Exception when calling ArtifactsApi->artifacts_list: #{e}"
|
172
|
+
end
|
173
|
+
```
|
174
|
+
|
175
|
+
### Parameters
|
176
|
+
|
177
|
+
|
178
|
+
Name | Type | Description | Notes
|
179
|
+
------------- | ------------- | ------------- | -------------
|
180
|
+
**repository_version** | **String**| Repository Version referenced by HREF | [optional]
|
181
|
+
**md5** | **String**| Filter results where md5 matches value | [optional]
|
182
|
+
**sha1** | **String**| Filter results where sha1 matches value | [optional]
|
183
|
+
**sha224** | **String**| Filter results where sha224 matches value | [optional]
|
184
|
+
**sha256** | **String**| Filter results where sha256 matches value | [optional]
|
185
|
+
**sha384** | **String**| Filter results where sha384 matches value | [optional]
|
186
|
+
**sha512** | **String**| Filter results where sha512 matches value | [optional]
|
187
|
+
**page** | **Integer**| A page number within the paginated result set. | [optional]
|
188
|
+
**page_size** | **Integer**| Number of results to return per page. | [optional]
|
189
|
+
|
190
|
+
### Return type
|
191
|
+
|
192
|
+
[**InlineResponse200**](InlineResponse200.md)
|
193
|
+
|
194
|
+
### Authorization
|
195
|
+
|
196
|
+
[Basic](../README.md#Basic)
|
197
|
+
|
198
|
+
### HTTP request headers
|
199
|
+
|
200
|
+
- **Content-Type**: Not defined
|
201
|
+
- **Accept**: application/json
|
202
|
+
|
203
|
+
|
204
|
+
## artifacts_read
|
205
|
+
|
206
|
+
> Artifact artifacts_read(artifact_href)
|
207
|
+
|
208
|
+
Inspect an artifact
|
209
|
+
|
210
|
+
### Example
|
211
|
+
|
212
|
+
```ruby
|
213
|
+
# load the gem
|
214
|
+
require 'pulpcore_client'
|
215
|
+
# setup authorization
|
216
|
+
PulpcoreClient.configure do |config|
|
217
|
+
# Configure HTTP basic authorization: Basic
|
218
|
+
config.username = 'YOUR USERNAME'
|
219
|
+
config.password = 'YOUR PASSWORD'
|
220
|
+
end
|
221
|
+
|
222
|
+
api_instance = PulpcoreClient::ArtifactsApi.new
|
223
|
+
artifact_href = 'artifact_href_example' # String | URI of Artifact. e.g.: /pulp/api/v3/artifacts/1/
|
224
|
+
|
225
|
+
begin
|
226
|
+
#Inspect an artifact
|
227
|
+
result = api_instance.artifacts_read(artifact_href)
|
228
|
+
p result
|
229
|
+
rescue PulpcoreClient::ApiError => e
|
230
|
+
puts "Exception when calling ArtifactsApi->artifacts_read: #{e}"
|
231
|
+
end
|
232
|
+
```
|
233
|
+
|
234
|
+
### Parameters
|
235
|
+
|
236
|
+
|
237
|
+
Name | Type | Description | Notes
|
238
|
+
------------- | ------------- | ------------- | -------------
|
239
|
+
**artifact_href** | **String**| URI of Artifact. e.g.: /pulp/api/v3/artifacts/1/ |
|
240
|
+
|
241
|
+
### Return type
|
242
|
+
|
243
|
+
[**Artifact**](Artifact.md)
|
244
|
+
|
245
|
+
### Authorization
|
246
|
+
|
247
|
+
[Basic](../README.md#Basic)
|
248
|
+
|
249
|
+
### HTTP request headers
|
250
|
+
|
251
|
+
- **Content-Type**: Not defined
|
252
|
+
- **Accept**: application/json
|
253
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# PulpcoreClient::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 'PulpcoreClient'
|
13
|
+
|
14
|
+
instance = PulpcoreClient::AsyncOperationResponse.new(task: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# PulpcoreClient::InlineResponse200
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**_next** | **String** | | [optional]
|
8
|
+
**previous** | **String** | | [optional]
|
9
|
+
**count** | **Integer** | |
|
10
|
+
**results** | [**Array<Artifact>**](Artifact.md) | |
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'PulpcoreClient'
|
16
|
+
|
17
|
+
instance = PulpcoreClient::InlineResponse200.new(_next: null,
|
18
|
+
previous: null,
|
19
|
+
count: null,
|
20
|
+
results: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# PulpcoreClient::InlineResponse2001
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**_next** | **String** | | [optional]
|
8
|
+
**previous** | **String** | | [optional]
|
9
|
+
**count** | **Integer** | |
|
10
|
+
**results** | [**Array<Repository>**](Repository.md) | |
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'PulpcoreClient'
|
16
|
+
|
17
|
+
instance = PulpcoreClient::InlineResponse2001.new(_next: null,
|
18
|
+
previous: null,
|
19
|
+
count: null,
|
20
|
+
results: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# PulpcoreClient::InlineResponse2002
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**_next** | **String** | | [optional]
|
8
|
+
**previous** | **String** | | [optional]
|
9
|
+
**count** | **Integer** | |
|
10
|
+
**results** | [**Array<RepositoryVersion>**](RepositoryVersion.md) | |
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'PulpcoreClient'
|
16
|
+
|
17
|
+
instance = PulpcoreClient::InlineResponse2002.new(_next: null,
|
18
|
+
previous: null,
|
19
|
+
count: null,
|
20
|
+
results: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# PulpcoreClient::InlineResponse2003
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**_next** | **String** | | [optional]
|
8
|
+
**previous** | **String** | | [optional]
|
9
|
+
**count** | **Integer** | |
|
10
|
+
**results** | [**Array<Task>**](Task.md) | |
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'PulpcoreClient'
|
16
|
+
|
17
|
+
instance = PulpcoreClient::InlineResponse2003.new(_next: null,
|
18
|
+
previous: null,
|
19
|
+
count: null,
|
20
|
+
results: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# PulpcoreClient::InlineResponse2004
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**_next** | **String** | | [optional]
|
8
|
+
**previous** | **String** | | [optional]
|
9
|
+
**count** | **Integer** | |
|
10
|
+
**results** | [**Array<Upload>**](Upload.md) | |
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'PulpcoreClient'
|
16
|
+
|
17
|
+
instance = PulpcoreClient::InlineResponse2004.new(_next: null,
|
18
|
+
previous: null,
|
19
|
+
count: null,
|
20
|
+
results: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|