pulp_file_client 0.2.0 → 0.3.0
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 +4 -4
- data/README.md +17 -11
- data/docs/ContentFilesApi.md +2 -0
- data/docs/DistributionsFileApi.md +2 -0
- data/docs/Export.md +25 -0
- data/docs/ExportersFileExportsApi.md +243 -0
- data/docs/{FileExportersFileApi.md → ExportersFilesystemApi.md} +29 -82
- data/docs/FileFileFileSystemExporter.md +3 -3
- data/docs/InlineResponse2003.md +1 -1
- data/docs/InlineResponse2004.md +1 -1
- data/docs/InlineResponse2005.md +1 -1
- data/docs/InlineResponse2006.md +1 -1
- data/docs/InlineResponse2007.md +23 -0
- data/docs/PublicationsFileApi.md +2 -2
- data/docs/RemotesFileApi.md +4 -2
- data/docs/RepositoriesFileApi.md +4 -2
- data/docs/RepositoriesFileVersionsApi.md +57 -2
- data/lib/pulp_file_client/api/content_files_api.rb +4 -1
- data/lib/pulp_file_client/api/distributions_file_api.rb +4 -1
- data/lib/pulp_file_client/api/exporters_file_exports_api.rb +297 -0
- data/lib/pulp_file_client/api/{file_exporters_file_api.rb → exporters_filesystem_api.rb} +34 -99
- data/lib/pulp_file_client/api/publications_file_api.rb +4 -4
- data/lib/pulp_file_client/api/remotes_file_api.rb +7 -4
- data/lib/pulp_file_client/api/repositories_file_api.rb +7 -4
- data/lib/pulp_file_client/api/repositories_file_versions_api.rb +72 -4
- data/lib/pulp_file_client/api_client.rb +1 -1
- data/lib/pulp_file_client/api_error.rb +1 -1
- data/lib/pulp_file_client/configuration.rb +1 -1
- data/lib/pulp_file_client/models/async_operation_response.rb +1 -1
- data/lib/pulp_file_client/models/content_summary.rb +1 -1
- data/lib/pulp_file_client/models/export.rb +258 -0
- data/lib/pulp_file_client/models/file_file_content.rb +1 -1
- data/lib/pulp_file_client/models/file_file_distribution.rb +1 -1
- data/lib/pulp_file_client/models/file_file_file_system_exporter.rb +39 -39
- data/lib/pulp_file_client/models/file_file_publication.rb +1 -1
- data/lib/pulp_file_client/models/file_file_remote.rb +1 -1
- data/lib/pulp_file_client/models/file_file_repository.rb +1 -1
- data/lib/pulp_file_client/models/inline_response200.rb +1 -1
- data/lib/pulp_file_client/models/inline_response2001.rb +1 -1
- data/lib/pulp_file_client/models/inline_response2002.rb +1 -1
- data/lib/pulp_file_client/models/inline_response2003.rb +2 -2
- data/lib/pulp_file_client/models/inline_response2004.rb +2 -2
- data/lib/pulp_file_client/models/inline_response2005.rb +2 -2
- data/lib/pulp_file_client/models/inline_response2006.rb +2 -2
- data/lib/pulp_file_client/models/inline_response2007.rb +247 -0
- data/lib/pulp_file_client/models/publication_export.rb +1 -1
- data/lib/pulp_file_client/models/repository_add_remove_content.rb +1 -1
- data/lib/pulp_file_client/models/repository_sync_url.rb +1 -1
- data/lib/pulp_file_client/models/repository_version.rb +1 -1
- data/lib/pulp_file_client/version.rb +2 -2
- data/lib/pulp_file_client.rb +5 -2
- data/pulp_file_client.gemspec +1 -1
- data/spec/api/content_files_api_spec.rb +2 -1
- data/spec/api/distributions_file_api_spec.rb +2 -1
- data/spec/api/exporters_file_exports_api_spec.rb +91 -0
- data/spec/api/{file_exporters_file_api_spec.rb → exporters_filesystem_api_spec.rb} +12 -23
- data/spec/api/publications_file_api_spec.rb +2 -2
- data/spec/api/remotes_file_api_spec.rb +3 -2
- data/spec/api/repositories_file_api_spec.rb +3 -2
- data/spec/api/repositories_file_versions_api_spec.rb +14 -2
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/async_operation_response_spec.rb +1 -1
- data/spec/models/content_summary_spec.rb +1 -1
- data/spec/models/export_spec.rb +65 -0
- data/spec/models/file_file_content_spec.rb +1 -1
- data/spec/models/file_file_distribution_spec.rb +1 -1
- data/spec/models/file_file_file_system_exporter_spec.rb +3 -3
- data/spec/models/file_file_publication_spec.rb +1 -1
- data/spec/models/file_file_remote_spec.rb +1 -1
- data/spec/models/file_file_repository_spec.rb +1 -1
- 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_response2005_spec.rb +1 -1
- data/spec/models/inline_response2006_spec.rb +1 -1
- data/spec/models/inline_response2007_spec.rb +59 -0
- data/spec/models/inline_response200_spec.rb +1 -1
- data/spec/models/publication_export_spec.rb +1 -1
- data/spec/models/repository_add_remove_content_spec.rb +1 -1
- data/spec/models/repository_sync_url_spec.rb +1 -1
- data/spec/models/repository_version_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +18 -6
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 16ca09f59608b4ef08ad2bb8accc7cb14b37e3160b390807b4cecd83855099a8
|
|
4
|
+
data.tar.gz: 24881275197dc8144c2cecdd81a29b682b5291c6b7888e54f329b542ed151696
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6618243ca35881d1f9882098a7d2429299b2008bfc34b1857744b61bc949bb29a9e3d52137b6827a0c1b02ecf981178ef0edd738c5dd64e7a34a8c83ddb574df
|
|
7
|
+
data.tar.gz: 60484e0ddc45ec988412cf1fdd62a7c86b7792b66fab7f4ca47b80fce6a84d133629403a2bec86c8b596d5bdc25f1d80bb4358406740f226aceb5696700291b9
|
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: 0.
|
|
10
|
+
- Package version: 0.3.0
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
|
|
13
13
|
## Installation
|
|
@@ -23,16 +23,16 @@ gem build pulp_file_client.gemspec
|
|
|
23
23
|
Then either install the gem locally:
|
|
24
24
|
|
|
25
25
|
```shell
|
|
26
|
-
gem install ./pulp_file_client-0.
|
|
26
|
+
gem install ./pulp_file_client-0.3.0.gem
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
(for development, run `gem install --dev ./pulp_file_client-0.
|
|
29
|
+
(for development, run `gem install --dev ./pulp_file_client-0.3.0.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_file_client', '~> 0.
|
|
35
|
+
gem 'pulp_file_client', '~> 0.3.0'
|
|
36
36
|
|
|
37
37
|
### Install from Git
|
|
38
38
|
|
|
@@ -96,13 +96,16 @@ Class | Method | HTTP request | Description
|
|
|
96
96
|
*PulpFileClient::DistributionsFileApi* | [**partial_update**](docs/DistributionsFileApi.md#partial_update) | **PATCH** {file_distribution_href} | Partially update a file distribution
|
|
97
97
|
*PulpFileClient::DistributionsFileApi* | [**read**](docs/DistributionsFileApi.md#read) | **GET** {file_distribution_href} | Inspect a file distribution
|
|
98
98
|
*PulpFileClient::DistributionsFileApi* | [**update**](docs/DistributionsFileApi.md#update) | **PUT** {file_distribution_href} | Update a file distribution
|
|
99
|
-
*PulpFileClient::
|
|
100
|
-
*PulpFileClient::
|
|
101
|
-
*PulpFileClient::
|
|
102
|
-
*PulpFileClient::
|
|
103
|
-
*PulpFileClient::
|
|
104
|
-
*PulpFileClient::
|
|
105
|
-
*PulpFileClient::
|
|
99
|
+
*PulpFileClient::ExportersFileExportsApi* | [**create**](docs/ExportersFileExportsApi.md#create) | **POST** /pulp/api/v3/exporters/file/filesystem/{exporter_pk}/exports/ | Create an export
|
|
100
|
+
*PulpFileClient::ExportersFileExportsApi* | [**delete**](docs/ExportersFileExportsApi.md#delete) | **DELETE** {export_href} | Delete an export
|
|
101
|
+
*PulpFileClient::ExportersFileExportsApi* | [**list**](docs/ExportersFileExportsApi.md#list) | **GET** /pulp/api/v3/exporters/file/filesystem/{exporter_pk}/exports/ | List exports
|
|
102
|
+
*PulpFileClient::ExportersFileExportsApi* | [**read**](docs/ExportersFileExportsApi.md#read) | **GET** {export_href} | Inspect an export
|
|
103
|
+
*PulpFileClient::ExportersFilesystemApi* | [**create**](docs/ExportersFilesystemApi.md#create) | **POST** /pulp/api/v3/exporters/file/filesystem/ | Create a file file system exporter
|
|
104
|
+
*PulpFileClient::ExportersFilesystemApi* | [**delete**](docs/ExportersFilesystemApi.md#delete) | **DELETE** {file_file_system_exporter_href} | Delete a file file system exporter
|
|
105
|
+
*PulpFileClient::ExportersFilesystemApi* | [**list**](docs/ExportersFilesystemApi.md#list) | **GET** /pulp/api/v3/exporters/file/filesystem/ | List file file system exporters
|
|
106
|
+
*PulpFileClient::ExportersFilesystemApi* | [**partial_update**](docs/ExportersFilesystemApi.md#partial_update) | **PATCH** {file_file_system_exporter_href} | Partially update a file file system exporter
|
|
107
|
+
*PulpFileClient::ExportersFilesystemApi* | [**read**](docs/ExportersFilesystemApi.md#read) | **GET** {file_file_system_exporter_href} | Inspect a file file system exporter
|
|
108
|
+
*PulpFileClient::ExportersFilesystemApi* | [**update**](docs/ExportersFilesystemApi.md#update) | **PUT** {file_file_system_exporter_href} | Update a file file system exporter
|
|
106
109
|
*PulpFileClient::PublicationsFileApi* | [**create**](docs/PublicationsFileApi.md#create) | **POST** /pulp/api/v3/publications/file/file/ | Create a file publication
|
|
107
110
|
*PulpFileClient::PublicationsFileApi* | [**delete**](docs/PublicationsFileApi.md#delete) | **DELETE** {file_publication_href} | Delete a file publication
|
|
108
111
|
*PulpFileClient::PublicationsFileApi* | [**list**](docs/PublicationsFileApi.md#list) | **GET** /pulp/api/v3/publications/file/file/ | List file publications
|
|
@@ -124,12 +127,14 @@ Class | Method | HTTP request | Description
|
|
|
124
127
|
*PulpFileClient::RepositoriesFileVersionsApi* | [**delete**](docs/RepositoriesFileVersionsApi.md#delete) | **DELETE** {file_repository_version_href} | Delete a repository version
|
|
125
128
|
*PulpFileClient::RepositoriesFileVersionsApi* | [**list**](docs/RepositoriesFileVersionsApi.md#list) | **GET** {file_repository_href}versions/ | List repository versions
|
|
126
129
|
*PulpFileClient::RepositoriesFileVersionsApi* | [**read**](docs/RepositoriesFileVersionsApi.md#read) | **GET** {file_repository_version_href} | Inspect a repository version
|
|
130
|
+
*PulpFileClient::RepositoriesFileVersionsApi* | [**repair**](docs/RepositoriesFileVersionsApi.md#repair) | **POST** {file_repository_version_href}repair/ |
|
|
127
131
|
|
|
128
132
|
|
|
129
133
|
## Documentation for Models
|
|
130
134
|
|
|
131
135
|
- [PulpFileClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
|
|
132
136
|
- [PulpFileClient::ContentSummary](docs/ContentSummary.md)
|
|
137
|
+
- [PulpFileClient::Export](docs/Export.md)
|
|
133
138
|
- [PulpFileClient::FileFileContent](docs/FileFileContent.md)
|
|
134
139
|
- [PulpFileClient::FileFileDistribution](docs/FileFileDistribution.md)
|
|
135
140
|
- [PulpFileClient::FileFileFileSystemExporter](docs/FileFileFileSystemExporter.md)
|
|
@@ -143,6 +148,7 @@ Class | Method | HTTP request | Description
|
|
|
143
148
|
- [PulpFileClient::InlineResponse2004](docs/InlineResponse2004.md)
|
|
144
149
|
- [PulpFileClient::InlineResponse2005](docs/InlineResponse2005.md)
|
|
145
150
|
- [PulpFileClient::InlineResponse2006](docs/InlineResponse2006.md)
|
|
151
|
+
- [PulpFileClient::InlineResponse2007](docs/InlineResponse2007.md)
|
|
146
152
|
- [PulpFileClient::PublicationExport](docs/PublicationExport.md)
|
|
147
153
|
- [PulpFileClient::RepositoryAddRemoveContent](docs/RepositoryAddRemoveContent.md)
|
|
148
154
|
- [PulpFileClient::RepositorySyncURL](docs/RepositorySyncURL.md)
|
data/docs/ContentFilesApi.md
CHANGED
|
@@ -93,6 +93,7 @@ end
|
|
|
93
93
|
|
|
94
94
|
api_instance = PulpFileClient::ContentFilesApi.new
|
|
95
95
|
opts = {
|
|
96
|
+
ordering: 'ordering_example', # String | Which field to use when ordering the results.
|
|
96
97
|
relative_path: 'relative_path_example', # String | Filter results where relative_path matches value
|
|
97
98
|
sha256: 'sha256_example', # String |
|
|
98
99
|
repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
|
|
@@ -118,6 +119,7 @@ end
|
|
|
118
119
|
|
|
119
120
|
Name | Type | Description | Notes
|
|
120
121
|
------------- | ------------- | ------------- | -------------
|
|
122
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
|
121
123
|
**relative_path** | **String**| Filter results where relative_path matches value | [optional]
|
|
122
124
|
**sha256** | **String**| | [optional]
|
|
123
125
|
**repository_version** | **String**| Repository Version referenced by HREF | [optional]
|
|
@@ -141,6 +141,7 @@ end
|
|
|
141
141
|
|
|
142
142
|
api_instance = PulpFileClient::DistributionsFileApi.new
|
|
143
143
|
opts = {
|
|
144
|
+
ordering: 'ordering_example', # String | Which field to use when ordering the results.
|
|
144
145
|
name: 'name_example', # String |
|
|
145
146
|
name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
|
|
146
147
|
base_path: 'base_path_example', # String |
|
|
@@ -167,6 +168,7 @@ end
|
|
|
167
168
|
|
|
168
169
|
Name | Type | Description | Notes
|
|
169
170
|
------------- | ------------- | ------------- | -------------
|
|
171
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
|
170
172
|
**name** | **String**| | [optional]
|
|
171
173
|
**name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional]
|
|
172
174
|
**base_path** | **String**| | [optional]
|
data/docs/Export.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# PulpFileClient::Export
|
|
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
|
+
**task** | **String** | A URI of the task that ran the Export. |
|
|
10
|
+
**exported_resources** | **Array<Object>** | Resources that were exported. | [optional] [readonly]
|
|
11
|
+
**params** | [**Object**](.md) | Any additional parameters that were used to create the export. |
|
|
12
|
+
|
|
13
|
+
## Code Sample
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'PulpFileClient'
|
|
17
|
+
|
|
18
|
+
instance = PulpFileClient::Export.new(pulp_href: null,
|
|
19
|
+
pulp_created: null,
|
|
20
|
+
task: null,
|
|
21
|
+
exported_resources: null,
|
|
22
|
+
params: null)
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
|
|
@@ -0,0 +1,243 @@
|
|
|
1
|
+
# PulpFileClient::ExportersFileExportsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create**](ExportersFileExportsApi.md#create) | **POST** /pulp/api/v3/exporters/file/filesystem/{exporter_pk}/exports/ | Create an export
|
|
8
|
+
[**delete**](ExportersFileExportsApi.md#delete) | **DELETE** {export_href} | Delete an export
|
|
9
|
+
[**list**](ExportersFileExportsApi.md#list) | **GET** /pulp/api/v3/exporters/file/filesystem/{exporter_pk}/exports/ | List exports
|
|
10
|
+
[**read**](ExportersFileExportsApi.md#read) | **GET** {export_href} | Inspect an export
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## create
|
|
15
|
+
|
|
16
|
+
> AsyncOperationResponse create(exporter_pk, data)
|
|
17
|
+
|
|
18
|
+
Create an export
|
|
19
|
+
|
|
20
|
+
Trigger an asynchronous task to export a file publication.
|
|
21
|
+
|
|
22
|
+
### Example
|
|
23
|
+
|
|
24
|
+
```ruby
|
|
25
|
+
# load the gem
|
|
26
|
+
require 'pulp_file_client'
|
|
27
|
+
# setup authorization
|
|
28
|
+
PulpFileClient.configure do |config|
|
|
29
|
+
# Configure HTTP basic authorization: Basic
|
|
30
|
+
config.username = 'YOUR USERNAME'
|
|
31
|
+
config.password = 'YOUR PASSWORD'
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
api_instance = PulpFileClient::ExportersFileExportsApi.new
|
|
35
|
+
exporter_pk = 'exporter_pk_example' # String |
|
|
36
|
+
data = PulpFileClient::PublicationExport.new # PublicationExport |
|
|
37
|
+
|
|
38
|
+
begin
|
|
39
|
+
#Create an export
|
|
40
|
+
result = api_instance.create(exporter_pk, data)
|
|
41
|
+
p result
|
|
42
|
+
rescue PulpFileClient::ApiError => e
|
|
43
|
+
puts "Exception when calling ExportersFileExportsApi->create: #{e}"
|
|
44
|
+
end
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Parameters
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
Name | Type | Description | Notes
|
|
51
|
+
------------- | ------------- | ------------- | -------------
|
|
52
|
+
**exporter_pk** | **String**| |
|
|
53
|
+
**data** | [**PublicationExport**](PublicationExport.md)| |
|
|
54
|
+
|
|
55
|
+
### Return type
|
|
56
|
+
|
|
57
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
|
58
|
+
|
|
59
|
+
### Authorization
|
|
60
|
+
|
|
61
|
+
[Basic](../README.md#Basic)
|
|
62
|
+
|
|
63
|
+
### HTTP request headers
|
|
64
|
+
|
|
65
|
+
- **Content-Type**: application/json
|
|
66
|
+
- **Accept**: application/json
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
## delete
|
|
70
|
+
|
|
71
|
+
> delete(export_href)
|
|
72
|
+
|
|
73
|
+
Delete an export
|
|
74
|
+
|
|
75
|
+
FileSystemExports provide a history of previous exports.
|
|
76
|
+
|
|
77
|
+
### Example
|
|
78
|
+
|
|
79
|
+
```ruby
|
|
80
|
+
# load the gem
|
|
81
|
+
require 'pulp_file_client'
|
|
82
|
+
# setup authorization
|
|
83
|
+
PulpFileClient.configure do |config|
|
|
84
|
+
# Configure HTTP basic authorization: Basic
|
|
85
|
+
config.username = 'YOUR USERNAME'
|
|
86
|
+
config.password = 'YOUR PASSWORD'
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
api_instance = PulpFileClient::ExportersFileExportsApi.new
|
|
90
|
+
export_href = 'export_href_example' # String | URI of Export. e.g.: /pulp/api/v3/exporters/file/filesystem/1/exports/1/
|
|
91
|
+
|
|
92
|
+
begin
|
|
93
|
+
#Delete an export
|
|
94
|
+
api_instance.delete(export_href)
|
|
95
|
+
rescue PulpFileClient::ApiError => e
|
|
96
|
+
puts "Exception when calling ExportersFileExportsApi->delete: #{e}"
|
|
97
|
+
end
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Parameters
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
Name | Type | Description | Notes
|
|
104
|
+
------------- | ------------- | ------------- | -------------
|
|
105
|
+
**export_href** | **String**| URI of Export. e.g.: /pulp/api/v3/exporters/file/filesystem/1/exports/1/ |
|
|
106
|
+
|
|
107
|
+
### Return type
|
|
108
|
+
|
|
109
|
+
nil (empty response body)
|
|
110
|
+
|
|
111
|
+
### Authorization
|
|
112
|
+
|
|
113
|
+
[Basic](../README.md#Basic)
|
|
114
|
+
|
|
115
|
+
### HTTP request headers
|
|
116
|
+
|
|
117
|
+
- **Content-Type**: Not defined
|
|
118
|
+
- **Accept**: Not defined
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
## list
|
|
122
|
+
|
|
123
|
+
> InlineResponse2003 list(exporter_pk, opts)
|
|
124
|
+
|
|
125
|
+
List exports
|
|
126
|
+
|
|
127
|
+
FileSystemExports provide a history of previous exports.
|
|
128
|
+
|
|
129
|
+
### Example
|
|
130
|
+
|
|
131
|
+
```ruby
|
|
132
|
+
# load the gem
|
|
133
|
+
require 'pulp_file_client'
|
|
134
|
+
# setup authorization
|
|
135
|
+
PulpFileClient.configure do |config|
|
|
136
|
+
# Configure HTTP basic authorization: Basic
|
|
137
|
+
config.username = 'YOUR USERNAME'
|
|
138
|
+
config.password = 'YOUR PASSWORD'
|
|
139
|
+
end
|
|
140
|
+
|
|
141
|
+
api_instance = PulpFileClient::ExportersFileExportsApi.new
|
|
142
|
+
exporter_pk = 'exporter_pk_example' # String |
|
|
143
|
+
opts = {
|
|
144
|
+
ordering: 'ordering_example', # String | Which field to use when ordering the results.
|
|
145
|
+
limit: 56, # Integer | Number of results to return per page.
|
|
146
|
+
offset: 56, # Integer | The initial index from which to return the results.
|
|
147
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
|
148
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
begin
|
|
152
|
+
#List exports
|
|
153
|
+
result = api_instance.list(exporter_pk, opts)
|
|
154
|
+
p result
|
|
155
|
+
rescue PulpFileClient::ApiError => e
|
|
156
|
+
puts "Exception when calling ExportersFileExportsApi->list: #{e}"
|
|
157
|
+
end
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### Parameters
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
Name | Type | Description | Notes
|
|
164
|
+
------------- | ------------- | ------------- | -------------
|
|
165
|
+
**exporter_pk** | **String**| |
|
|
166
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
|
167
|
+
**limit** | **Integer**| Number of results to return per page. | [optional]
|
|
168
|
+
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
|
169
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
|
170
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
|
171
|
+
|
|
172
|
+
### Return type
|
|
173
|
+
|
|
174
|
+
[**InlineResponse2003**](InlineResponse2003.md)
|
|
175
|
+
|
|
176
|
+
### Authorization
|
|
177
|
+
|
|
178
|
+
[Basic](../README.md#Basic)
|
|
179
|
+
|
|
180
|
+
### HTTP request headers
|
|
181
|
+
|
|
182
|
+
- **Content-Type**: Not defined
|
|
183
|
+
- **Accept**: application/json
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
## read
|
|
187
|
+
|
|
188
|
+
> Export read(export_href, opts)
|
|
189
|
+
|
|
190
|
+
Inspect an export
|
|
191
|
+
|
|
192
|
+
FileSystemExports provide a history of previous exports.
|
|
193
|
+
|
|
194
|
+
### Example
|
|
195
|
+
|
|
196
|
+
```ruby
|
|
197
|
+
# load the gem
|
|
198
|
+
require 'pulp_file_client'
|
|
199
|
+
# setup authorization
|
|
200
|
+
PulpFileClient.configure do |config|
|
|
201
|
+
# Configure HTTP basic authorization: Basic
|
|
202
|
+
config.username = 'YOUR USERNAME'
|
|
203
|
+
config.password = 'YOUR PASSWORD'
|
|
204
|
+
end
|
|
205
|
+
|
|
206
|
+
api_instance = PulpFileClient::ExportersFileExportsApi.new
|
|
207
|
+
export_href = 'export_href_example' # String | URI of Export. e.g.: /pulp/api/v3/exporters/file/filesystem/1/exports/1/
|
|
208
|
+
opts = {
|
|
209
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
|
210
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
begin
|
|
214
|
+
#Inspect an export
|
|
215
|
+
result = api_instance.read(export_href, opts)
|
|
216
|
+
p result
|
|
217
|
+
rescue PulpFileClient::ApiError => e
|
|
218
|
+
puts "Exception when calling ExportersFileExportsApi->read: #{e}"
|
|
219
|
+
end
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### Parameters
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
Name | Type | Description | Notes
|
|
226
|
+
------------- | ------------- | ------------- | -------------
|
|
227
|
+
**export_href** | **String**| URI of Export. e.g.: /pulp/api/v3/exporters/file/filesystem/1/exports/1/ |
|
|
228
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
|
229
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
|
230
|
+
|
|
231
|
+
### Return type
|
|
232
|
+
|
|
233
|
+
[**Export**](Export.md)
|
|
234
|
+
|
|
235
|
+
### Authorization
|
|
236
|
+
|
|
237
|
+
[Basic](../README.md#Basic)
|
|
238
|
+
|
|
239
|
+
### HTTP request headers
|
|
240
|
+
|
|
241
|
+
- **Content-Type**: Not defined
|
|
242
|
+
- **Accept**: application/json
|
|
243
|
+
|
|
@@ -1,16 +1,15 @@
|
|
|
1
|
-
# PulpFileClient::
|
|
1
|
+
# PulpFileClient::ExportersFilesystemApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *http://localhost:24817*
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**create**](
|
|
8
|
-
[**delete**](
|
|
9
|
-
[**
|
|
10
|
-
[**
|
|
11
|
-
[**
|
|
12
|
-
[**
|
|
13
|
-
[**update**](FileExportersFileApi.md#update) | **PUT** {file_file_system_exporter_href} | Update a file file system exporter
|
|
7
|
+
[**create**](ExportersFilesystemApi.md#create) | **POST** /pulp/api/v3/exporters/file/filesystem/ | Create a file file system exporter
|
|
8
|
+
[**delete**](ExportersFilesystemApi.md#delete) | **DELETE** {file_file_system_exporter_href} | Delete a file file system exporter
|
|
9
|
+
[**list**](ExportersFilesystemApi.md#list) | **GET** /pulp/api/v3/exporters/file/filesystem/ | List file file system exporters
|
|
10
|
+
[**partial_update**](ExportersFilesystemApi.md#partial_update) | **PATCH** {file_file_system_exporter_href} | Partially update a file file system exporter
|
|
11
|
+
[**read**](ExportersFilesystemApi.md#read) | **GET** {file_file_system_exporter_href} | Inspect a file file system exporter
|
|
12
|
+
[**update**](ExportersFilesystemApi.md#update) | **PUT** {file_file_system_exporter_href} | Update a file file system exporter
|
|
14
13
|
|
|
15
14
|
|
|
16
15
|
|
|
@@ -34,7 +33,7 @@ PulpFileClient.configure do |config|
|
|
|
34
33
|
config.password = 'YOUR PASSWORD'
|
|
35
34
|
end
|
|
36
35
|
|
|
37
|
-
api_instance = PulpFileClient::
|
|
36
|
+
api_instance = PulpFileClient::ExportersFilesystemApi.new
|
|
38
37
|
data = PulpFileClient::FileFileFileSystemExporter.new # FileFileFileSystemExporter |
|
|
39
38
|
|
|
40
39
|
begin
|
|
@@ -42,7 +41,7 @@ begin
|
|
|
42
41
|
result = api_instance.create(data)
|
|
43
42
|
p result
|
|
44
43
|
rescue PulpFileClient::ApiError => e
|
|
45
|
-
puts "Exception when calling
|
|
44
|
+
puts "Exception when calling ExportersFilesystemApi->create: #{e}"
|
|
46
45
|
end
|
|
47
46
|
```
|
|
48
47
|
|
|
@@ -87,14 +86,14 @@ PulpFileClient.configure do |config|
|
|
|
87
86
|
config.password = 'YOUR PASSWORD'
|
|
88
87
|
end
|
|
89
88
|
|
|
90
|
-
api_instance = PulpFileClient::
|
|
91
|
-
file_file_system_exporter_href = 'file_file_system_exporter_href_example' # String | URI of File File System Exporter. e.g.: /pulp/api/v3/
|
|
89
|
+
api_instance = PulpFileClient::ExportersFilesystemApi.new
|
|
90
|
+
file_file_system_exporter_href = 'file_file_system_exporter_href_example' # String | URI of File File System Exporter. e.g.: /pulp/api/v3/exporters/file/filesystem/1/
|
|
92
91
|
|
|
93
92
|
begin
|
|
94
93
|
#Delete a file file system exporter
|
|
95
94
|
api_instance.delete(file_file_system_exporter_href)
|
|
96
95
|
rescue PulpFileClient::ApiError => e
|
|
97
|
-
puts "Exception when calling
|
|
96
|
+
puts "Exception when calling ExportersFilesystemApi->delete: #{e}"
|
|
98
97
|
end
|
|
99
98
|
```
|
|
100
99
|
|
|
@@ -103,7 +102,7 @@ end
|
|
|
103
102
|
|
|
104
103
|
Name | Type | Description | Notes
|
|
105
104
|
------------- | ------------- | ------------- | -------------
|
|
106
|
-
**file_file_system_exporter_href** | **String**| URI of File File System Exporter. e.g.: /pulp/api/v3/
|
|
105
|
+
**file_file_system_exporter_href** | **String**| URI of File File System Exporter. e.g.: /pulp/api/v3/exporters/file/filesystem/1/ |
|
|
107
106
|
|
|
108
107
|
### Return type
|
|
109
108
|
|
|
@@ -119,60 +118,6 @@ nil (empty response body)
|
|
|
119
118
|
- **Accept**: Not defined
|
|
120
119
|
|
|
121
120
|
|
|
122
|
-
## export
|
|
123
|
-
|
|
124
|
-
> AsyncOperationResponse export(file_file_system_exporter_href, data)
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
Trigger an asynchronous task to export a file publication.
|
|
129
|
-
|
|
130
|
-
### Example
|
|
131
|
-
|
|
132
|
-
```ruby
|
|
133
|
-
# load the gem
|
|
134
|
-
require 'pulp_file_client'
|
|
135
|
-
# setup authorization
|
|
136
|
-
PulpFileClient.configure do |config|
|
|
137
|
-
# Configure HTTP basic authorization: Basic
|
|
138
|
-
config.username = 'YOUR USERNAME'
|
|
139
|
-
config.password = 'YOUR PASSWORD'
|
|
140
|
-
end
|
|
141
|
-
|
|
142
|
-
api_instance = PulpFileClient::FileExportersFileApi.new
|
|
143
|
-
file_file_system_exporter_href = 'file_file_system_exporter_href_example' # String | URI of File File System Exporter. e.g.: /pulp/api/v3/file_exporters/file/file/1/
|
|
144
|
-
data = PulpFileClient::PublicationExport.new # PublicationExport |
|
|
145
|
-
|
|
146
|
-
begin
|
|
147
|
-
result = api_instance.export(file_file_system_exporter_href, data)
|
|
148
|
-
p result
|
|
149
|
-
rescue PulpFileClient::ApiError => e
|
|
150
|
-
puts "Exception when calling FileExportersFileApi->export: #{e}"
|
|
151
|
-
end
|
|
152
|
-
```
|
|
153
|
-
|
|
154
|
-
### Parameters
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
Name | Type | Description | Notes
|
|
158
|
-
------------- | ------------- | ------------- | -------------
|
|
159
|
-
**file_file_system_exporter_href** | **String**| URI of File File System Exporter. e.g.: /pulp/api/v3/file_exporters/file/file/1/ |
|
|
160
|
-
**data** | [**PublicationExport**](PublicationExport.md)| |
|
|
161
|
-
|
|
162
|
-
### Return type
|
|
163
|
-
|
|
164
|
-
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
|
165
|
-
|
|
166
|
-
### Authorization
|
|
167
|
-
|
|
168
|
-
[Basic](../README.md#Basic)
|
|
169
|
-
|
|
170
|
-
### HTTP request headers
|
|
171
|
-
|
|
172
|
-
- **Content-Type**: application/json
|
|
173
|
-
- **Accept**: application/json
|
|
174
|
-
|
|
175
|
-
|
|
176
121
|
## list
|
|
177
122
|
|
|
178
123
|
> InlineResponse2002 list(opts)
|
|
@@ -193,8 +138,9 @@ PulpFileClient.configure do |config|
|
|
|
193
138
|
config.password = 'YOUR PASSWORD'
|
|
194
139
|
end
|
|
195
140
|
|
|
196
|
-
api_instance = PulpFileClient::
|
|
141
|
+
api_instance = PulpFileClient::ExportersFilesystemApi.new
|
|
197
142
|
opts = {
|
|
143
|
+
ordering: 'ordering_example', # String | Which field to use when ordering the results.
|
|
198
144
|
name: 'name_example', # String |
|
|
199
145
|
name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
|
|
200
146
|
limit: 56, # Integer | Number of results to return per page.
|
|
@@ -208,7 +154,7 @@ begin
|
|
|
208
154
|
result = api_instance.list(opts)
|
|
209
155
|
p result
|
|
210
156
|
rescue PulpFileClient::ApiError => e
|
|
211
|
-
puts "Exception when calling
|
|
157
|
+
puts "Exception when calling ExportersFilesystemApi->list: #{e}"
|
|
212
158
|
end
|
|
213
159
|
```
|
|
214
160
|
|
|
@@ -217,6 +163,7 @@ end
|
|
|
217
163
|
|
|
218
164
|
Name | Type | Description | Notes
|
|
219
165
|
------------- | ------------- | ------------- | -------------
|
|
166
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
|
220
167
|
**name** | **String**| | [optional]
|
|
221
168
|
**name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional]
|
|
222
169
|
**limit** | **Integer**| Number of results to return per page. | [optional]
|
|
@@ -258,8 +205,8 @@ PulpFileClient.configure do |config|
|
|
|
258
205
|
config.password = 'YOUR PASSWORD'
|
|
259
206
|
end
|
|
260
207
|
|
|
261
|
-
api_instance = PulpFileClient::
|
|
262
|
-
file_file_system_exporter_href = 'file_file_system_exporter_href_example' # String | URI of File File System Exporter. e.g.: /pulp/api/v3/
|
|
208
|
+
api_instance = PulpFileClient::ExportersFilesystemApi.new
|
|
209
|
+
file_file_system_exporter_href = 'file_file_system_exporter_href_example' # String | URI of File File System Exporter. e.g.: /pulp/api/v3/exporters/file/filesystem/1/
|
|
263
210
|
data = PulpFileClient::FileFileFileSystemExporter.new # FileFileFileSystemExporter |
|
|
264
211
|
|
|
265
212
|
begin
|
|
@@ -267,7 +214,7 @@ begin
|
|
|
267
214
|
result = api_instance.partial_update(file_file_system_exporter_href, data)
|
|
268
215
|
p result
|
|
269
216
|
rescue PulpFileClient::ApiError => e
|
|
270
|
-
puts "Exception when calling
|
|
217
|
+
puts "Exception when calling ExportersFilesystemApi->partial_update: #{e}"
|
|
271
218
|
end
|
|
272
219
|
```
|
|
273
220
|
|
|
@@ -276,7 +223,7 @@ end
|
|
|
276
223
|
|
|
277
224
|
Name | Type | Description | Notes
|
|
278
225
|
------------- | ------------- | ------------- | -------------
|
|
279
|
-
**file_file_system_exporter_href** | **String**| URI of File File System Exporter. e.g.: /pulp/api/v3/
|
|
226
|
+
**file_file_system_exporter_href** | **String**| URI of File File System Exporter. e.g.: /pulp/api/v3/exporters/file/filesystem/1/ |
|
|
280
227
|
**data** | [**FileFileFileSystemExporter**](FileFileFileSystemExporter.md)| |
|
|
281
228
|
|
|
282
229
|
### Return type
|
|
@@ -313,8 +260,8 @@ PulpFileClient.configure do |config|
|
|
|
313
260
|
config.password = 'YOUR PASSWORD'
|
|
314
261
|
end
|
|
315
262
|
|
|
316
|
-
api_instance = PulpFileClient::
|
|
317
|
-
file_file_system_exporter_href = 'file_file_system_exporter_href_example' # String | URI of File File System Exporter. e.g.: /pulp/api/v3/
|
|
263
|
+
api_instance = PulpFileClient::ExportersFilesystemApi.new
|
|
264
|
+
file_file_system_exporter_href = 'file_file_system_exporter_href_example' # String | URI of File File System Exporter. e.g.: /pulp/api/v3/exporters/file/filesystem/1/
|
|
318
265
|
opts = {
|
|
319
266
|
fields: 'fields_example', # String | A list of fields to include in the response.
|
|
320
267
|
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
|
@@ -325,7 +272,7 @@ begin
|
|
|
325
272
|
result = api_instance.read(file_file_system_exporter_href, opts)
|
|
326
273
|
p result
|
|
327
274
|
rescue PulpFileClient::ApiError => e
|
|
328
|
-
puts "Exception when calling
|
|
275
|
+
puts "Exception when calling ExportersFilesystemApi->read: #{e}"
|
|
329
276
|
end
|
|
330
277
|
```
|
|
331
278
|
|
|
@@ -334,7 +281,7 @@ end
|
|
|
334
281
|
|
|
335
282
|
Name | Type | Description | Notes
|
|
336
283
|
------------- | ------------- | ------------- | -------------
|
|
337
|
-
**file_file_system_exporter_href** | **String**| URI of File File System Exporter. e.g.: /pulp/api/v3/
|
|
284
|
+
**file_file_system_exporter_href** | **String**| URI of File File System Exporter. e.g.: /pulp/api/v3/exporters/file/filesystem/1/ |
|
|
338
285
|
**fields** | **String**| A list of fields to include in the response. | [optional]
|
|
339
286
|
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
|
340
287
|
|
|
@@ -372,8 +319,8 @@ PulpFileClient.configure do |config|
|
|
|
372
319
|
config.password = 'YOUR PASSWORD'
|
|
373
320
|
end
|
|
374
321
|
|
|
375
|
-
api_instance = PulpFileClient::
|
|
376
|
-
file_file_system_exporter_href = 'file_file_system_exporter_href_example' # String | URI of File File System Exporter. e.g.: /pulp/api/v3/
|
|
322
|
+
api_instance = PulpFileClient::ExportersFilesystemApi.new
|
|
323
|
+
file_file_system_exporter_href = 'file_file_system_exporter_href_example' # String | URI of File File System Exporter. e.g.: /pulp/api/v3/exporters/file/filesystem/1/
|
|
377
324
|
data = PulpFileClient::FileFileFileSystemExporter.new # FileFileFileSystemExporter |
|
|
378
325
|
|
|
379
326
|
begin
|
|
@@ -381,7 +328,7 @@ begin
|
|
|
381
328
|
result = api_instance.update(file_file_system_exporter_href, data)
|
|
382
329
|
p result
|
|
383
330
|
rescue PulpFileClient::ApiError => e
|
|
384
|
-
puts "Exception when calling
|
|
331
|
+
puts "Exception when calling ExportersFilesystemApi->update: #{e}"
|
|
385
332
|
end
|
|
386
333
|
```
|
|
387
334
|
|
|
@@ -390,7 +337,7 @@ end
|
|
|
390
337
|
|
|
391
338
|
Name | Type | Description | Notes
|
|
392
339
|
------------- | ------------- | ------------- | -------------
|
|
393
|
-
**file_file_system_exporter_href** | **String**| URI of File File System Exporter. e.g.: /pulp/api/v3/
|
|
340
|
+
**file_file_system_exporter_href** | **String**| URI of File File System Exporter. e.g.: /pulp/api/v3/exporters/file/filesystem/1/ |
|
|
394
341
|
**data** | [**FileFileFileSystemExporter**](FileFileFileSystemExporter.md)| |
|
|
395
342
|
|
|
396
343
|
### Return type
|
|
@@ -6,8 +6,8 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**pulp_href** | **String** | | [optional] [readonly]
|
|
8
8
|
**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
|
|
9
|
-
**path** | **String** | File system location to export to. |
|
|
10
9
|
**name** | **String** | Unique name of the file system exporter. |
|
|
10
|
+
**path** | **String** | File system location to export to. |
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
@@ -16,8 +16,8 @@ require 'PulpFileClient'
|
|
|
16
16
|
|
|
17
17
|
instance = PulpFileClient::FileFileFileSystemExporter.new(pulp_href: null,
|
|
18
18
|
pulp_created: null,
|
|
19
|
-
|
|
20
|
-
|
|
19
|
+
name: null,
|
|
20
|
+
path: null)
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
|
data/docs/InlineResponse2003.md
CHANGED
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**count** | **Integer** | |
|
|
8
8
|
**_next** | **String** | | [optional]
|
|
9
9
|
**previous** | **String** | | [optional]
|
|
10
|
-
**results** | [**Array<
|
|
10
|
+
**results** | [**Array<Export>**](Export.md) | |
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|