pulp_maven_client 0.8.1 → 0.8.3
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 +11 -7
- data/docs/AsyncOperationResponse.md +8 -7
- data/docs/ContentArtifactApi.md +116 -64
- data/docs/ContentSummaryResponse.md +12 -11
- data/docs/DistributionsMavenApi.md +267 -130
- data/docs/MavenMavenArtifact.md +12 -11
- data/docs/MavenMavenArtifactResponse.md +24 -21
- data/docs/MavenMavenDistribution.md +20 -19
- data/docs/MavenMavenDistributionResponse.md +32 -27
- data/docs/MavenMavenRemote.md +48 -47
- data/docs/MavenMavenRemoteResponse.md +48 -45
- data/docs/MavenMavenRemoteResponseHiddenFieldsInner.md +20 -0
- data/docs/MavenMavenRepository.md +16 -15
- data/docs/MavenMavenRepositoryResponse.md +28 -25
- data/docs/PaginatedRepositoryVersionResponseList.md +14 -13
- data/docs/PaginatedmavenMavenArtifactResponseList.md +14 -13
- data/docs/PaginatedmavenMavenDistributionResponseList.md +14 -13
- data/docs/PaginatedmavenMavenRemoteResponseList.md +14 -13
- data/docs/PaginatedmavenMavenRepositoryResponseList.md +14 -13
- data/docs/PatchedmavenMavenDistribution.md +20 -19
- data/docs/PatchedmavenMavenRemote.md +48 -47
- data/docs/PatchedmavenMavenRepository.md +16 -15
- data/docs/PolicyEnum.md +4 -5
- data/docs/PulpMavenApi.md +61 -26
- data/docs/RemotesMavenApi.md +271 -132
- data/docs/Repair.md +8 -7
- data/docs/RepositoriesMavenApi.md +300 -146
- data/docs/RepositoriesMavenVersionsApi.md +155 -83
- data/docs/RepositoryAddCachedContent.md +8 -7
- data/docs/RepositoryVersionResponse.md +22 -19
- data/docs/SetLabel.md +10 -9
- data/docs/SetLabelResponse.md +10 -9
- data/docs/UnsetLabel.md +8 -7
- data/docs/UnsetLabelResponse.md +10 -9
- data/lib/pulp_maven_client/api/content_artifact_api.rb +31 -22
- data/lib/pulp_maven_client/api/distributions_maven_api.rb +66 -40
- data/lib/pulp_maven_client/api/pulp_maven_api.rb +9 -7
- data/lib/pulp_maven_client/api/remotes_maven_api.rb +81 -52
- data/lib/pulp_maven_client/api/repositories_maven_api.rb +79 -49
- data/lib/pulp_maven_client/api/repositories_maven_versions_api.rb +50 -37
- data/lib/pulp_maven_client/api_client.rb +137 -102
- data/lib/pulp_maven_client/api_error.rb +2 -1
- data/lib/pulp_maven_client/configuration.rb +162 -21
- data/lib/pulp_maven_client/models/async_operation_response.rb +32 -22
- data/lib/pulp_maven_client/models/content_summary_response.rb +36 -22
- data/lib/pulp_maven_client/models/maven_maven_artifact.rb +34 -22
- data/lib/pulp_maven_client/models/maven_maven_artifact_response.rb +45 -25
- data/lib/pulp_maven_client/models/maven_maven_distribution.rb +34 -22
- data/lib/pulp_maven_client/models/maven_maven_distribution_response.rb +57 -25
- data/lib/pulp_maven_client/models/maven_maven_remote.rb +57 -38
- data/lib/pulp_maven_client/models/maven_maven_remote_response.rb +71 -42
- data/lib/pulp_maven_client/models/{maven_maven_remote_response_hidden_fields.rb → maven_maven_remote_response_hidden_fields_inner.rb} +37 -25
- data/lib/pulp_maven_client/models/maven_maven_repository.rb +32 -37
- data/lib/pulp_maven_client/models/maven_maven_repository_response.rb +45 -40
- data/lib/pulp_maven_client/models/paginated_repository_version_response_list.rb +34 -24
- data/lib/pulp_maven_client/models/paginatedmaven_maven_artifact_response_list.rb +34 -24
- data/lib/pulp_maven_client/models/paginatedmaven_maven_distribution_response_list.rb +34 -24
- data/lib/pulp_maven_client/models/paginatedmaven_maven_remote_response_list.rb +34 -24
- data/lib/pulp_maven_client/models/paginatedmaven_maven_repository_response_list.rb +34 -24
- data/lib/pulp_maven_client/models/patchedmaven_maven_distribution.rb +40 -24
- data/lib/pulp_maven_client/models/patchedmaven_maven_remote.rb +63 -40
- data/lib/pulp_maven_client/models/patchedmaven_maven_repository.rb +35 -38
- data/lib/pulp_maven_client/models/policy_enum.rb +8 -5
- data/lib/pulp_maven_client/models/repair.rb +30 -22
- data/lib/pulp_maven_client/models/repository_add_cached_content.rb +30 -22
- data/lib/pulp_maven_client/models/repository_version_response.rb +44 -26
- data/lib/pulp_maven_client/models/set_label.rb +34 -22
- data/lib/pulp_maven_client/models/set_label_response.rb +34 -22
- data/lib/pulp_maven_client/models/unset_label.rb +32 -22
- data/lib/pulp_maven_client/models/unset_label_response.rb +32 -22
- data/lib/pulp_maven_client/version.rb +2 -2
- data/lib/pulp_maven_client.rb +2 -2
- data/pulp_maven_client.gemspec +9 -6
- data/spec/api/content_artifact_api_spec.rb +9 -8
- data/spec/api/distributions_maven_api_spec.rb +11 -10
- data/spec/api/pulp_maven_api_spec.rb +3 -3
- data/spec/api/remotes_maven_api_spec.rb +18 -16
- data/spec/api/repositories_maven_api_spec.rb +14 -13
- data/spec/api/repositories_maven_versions_api_spec.rb +16 -14
- data/spec/models/async_operation_response_spec.rb +7 -12
- data/spec/models/content_summary_response_spec.rb +9 -14
- data/spec/models/maven_maven_artifact_response_spec.rb +20 -19
- data/spec/models/maven_maven_artifact_spec.rb +9 -14
- data/spec/models/maven_maven_distribution_response_spec.rb +29 -22
- data/spec/models/maven_maven_distribution_spec.rb +13 -18
- data/spec/models/{maven_maven_remote_response_hidden_fields_spec.rb → maven_maven_remote_response_hidden_fields_inner_spec.rb} +11 -16
- data/spec/models/maven_maven_remote_response_spec.rb +32 -31
- data/spec/models/maven_maven_remote_spec.rb +27 -32
- data/spec/models/maven_maven_repository_response_spec.rb +22 -21
- data/spec/models/maven_maven_repository_spec.rb +11 -16
- data/spec/models/paginated_repository_version_response_list_spec.rb +10 -15
- data/spec/models/paginatedmaven_maven_artifact_response_list_spec.rb +10 -15
- data/spec/models/paginatedmaven_maven_distribution_response_list_spec.rb +10 -15
- data/spec/models/paginatedmaven_maven_remote_response_list_spec.rb +10 -15
- data/spec/models/paginatedmaven_maven_repository_response_list_spec.rb +10 -15
- data/spec/models/patchedmaven_maven_distribution_spec.rb +13 -18
- data/spec/models/patchedmaven_maven_remote_spec.rb +27 -32
- data/spec/models/patchedmaven_maven_repository_spec.rb +11 -16
- data/spec/models/policy_enum_spec.rb +6 -11
- data/spec/models/repair_spec.rb +7 -12
- data/spec/models/repository_add_cached_content_spec.rb +7 -12
- data/spec/models/repository_version_response_spec.rb +19 -18
- data/spec/models/set_label_response_spec.rb +8 -13
- data/spec/models/set_label_spec.rb +8 -13
- data/spec/models/unset_label_response_spec.rb +8 -13
- data/spec/models/unset_label_spec.rb +7 -12
- data/spec/spec_helper.rb +1 -1
- metadata +78 -54
- data/docs/MavenMavenRemoteResponseHiddenFields.md +0 -19
- data/spec/api_client_spec.rb +0 -188
- data/spec/configuration_spec.rb +0 -42
@@ -1,32 +1,31 @@
|
|
1
1
|
# PulpMavenClient::DistributionsMavenApi
|
2
2
|
|
3
|
-
All URIs are relative to *http://
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**create**](DistributionsMavenApi.md#create) | **POST** /pulp/api/v3/distributions/maven/maven/ | Create a maven distribution
|
8
|
-
[**delete**](DistributionsMavenApi.md#delete) | **DELETE** {maven_maven_distribution_href} | Delete a maven distribution
|
9
|
-
[**list**](DistributionsMavenApi.md#list) | **GET** /pulp/api/v3/distributions/maven/maven/ | List maven distributions
|
10
|
-
[**partial_update**](DistributionsMavenApi.md#partial_update) | **PATCH** {maven_maven_distribution_href} | Update a maven distribution
|
11
|
-
[**read**](DistributionsMavenApi.md#read) | **GET** {maven_maven_distribution_href} | Inspect a maven distribution
|
12
|
-
[**set_label**](DistributionsMavenApi.md#set_label) | **POST** {maven_maven_distribution_href}set_label/ | Set a label
|
13
|
-
[**unset_label**](DistributionsMavenApi.md#unset_label) | **POST** {maven_maven_distribution_href}unset_label/ | Unset a label
|
14
|
-
[**update**](DistributionsMavenApi.md#update) | **PUT** {maven_maven_distribution_href} | Update a maven distribution
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
15
4
|
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create**](DistributionsMavenApi.md#create) | **POST** /pulp/api/v3/distributions/maven/maven/ | Create a maven distribution |
|
8
|
+
| [**delete**](DistributionsMavenApi.md#delete) | **DELETE** {maven_maven_distribution_href} | Delete a maven distribution |
|
9
|
+
| [**list**](DistributionsMavenApi.md#list) | **GET** /pulp/api/v3/distributions/maven/maven/ | List maven distributions |
|
10
|
+
| [**partial_update**](DistributionsMavenApi.md#partial_update) | **PATCH** {maven_maven_distribution_href} | Update a maven distribution |
|
11
|
+
| [**read**](DistributionsMavenApi.md#read) | **GET** {maven_maven_distribution_href} | Inspect a maven distribution |
|
12
|
+
| [**set_label**](DistributionsMavenApi.md#set_label) | **POST** {maven_maven_distribution_href}set_label/ | Set a label |
|
13
|
+
| [**unset_label**](DistributionsMavenApi.md#unset_label) | **POST** {maven_maven_distribution_href}unset_label/ | Unset a label |
|
14
|
+
| [**update**](DistributionsMavenApi.md#update) | **PUT** {maven_maven_distribution_href} | Update a maven distribution |
|
16
15
|
|
17
16
|
|
18
17
|
## create
|
19
18
|
|
20
|
-
> AsyncOperationResponse create(maven_maven_distribution)
|
19
|
+
> <AsyncOperationResponse> create(maven_maven_distribution)
|
21
20
|
|
22
21
|
Create a maven distribution
|
23
22
|
|
24
23
|
Trigger an asynchronous create task
|
25
24
|
|
26
|
-
###
|
25
|
+
### Examples
|
27
26
|
|
28
27
|
```ruby
|
29
|
-
|
28
|
+
require 'time'
|
30
29
|
require 'pulp_maven_client'
|
31
30
|
# setup authorization
|
32
31
|
PulpMavenClient.configure do |config|
|
@@ -36,23 +35,40 @@ PulpMavenClient.configure do |config|
|
|
36
35
|
end
|
37
36
|
|
38
37
|
api_instance = PulpMavenClient::DistributionsMavenApi.new
|
39
|
-
maven_maven_distribution = PulpMavenClient::MavenMavenDistribution.new # MavenMavenDistribution |
|
38
|
+
maven_maven_distribution = PulpMavenClient::MavenMavenDistribution.new({base_path: 'base_path_example', name: 'name_example'}) # MavenMavenDistribution |
|
40
39
|
|
41
40
|
begin
|
42
|
-
#Create a maven distribution
|
41
|
+
# Create a maven distribution
|
43
42
|
result = api_instance.create(maven_maven_distribution)
|
44
43
|
p result
|
45
44
|
rescue PulpMavenClient::ApiError => e
|
46
|
-
puts "
|
45
|
+
puts "Error when calling DistributionsMavenApi->create: #{e}"
|
47
46
|
end
|
48
47
|
```
|
49
48
|
|
50
|
-
|
49
|
+
#### Using the create_with_http_info variant
|
50
|
+
|
51
|
+
This returns an Array which contains the response data, status code and headers.
|
51
52
|
|
53
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> create_with_http_info(maven_maven_distribution)
|
54
|
+
|
55
|
+
```ruby
|
56
|
+
begin
|
57
|
+
# Create a maven distribution
|
58
|
+
data, status_code, headers = api_instance.create_with_http_info(maven_maven_distribution)
|
59
|
+
p status_code # => 2xx
|
60
|
+
p headers # => { ... }
|
61
|
+
p data # => <AsyncOperationResponse>
|
62
|
+
rescue PulpMavenClient::ApiError => e
|
63
|
+
puts "Error when calling DistributionsMavenApi->create_with_http_info: #{e}"
|
64
|
+
end
|
65
|
+
```
|
66
|
+
|
67
|
+
### Parameters
|
52
68
|
|
53
|
-
Name | Type | Description
|
54
|
-
|
55
|
-
**maven_maven_distribution** | [**MavenMavenDistribution**](MavenMavenDistribution.md)| |
|
69
|
+
| Name | Type | Description | Notes |
|
70
|
+
| ---- | ---- | ----------- | ----- |
|
71
|
+
| **maven_maven_distribution** | [**MavenMavenDistribution**](MavenMavenDistribution.md) | | |
|
56
72
|
|
57
73
|
### Return type
|
58
74
|
|
@@ -70,16 +86,16 @@ Name | Type | Description | Notes
|
|
70
86
|
|
71
87
|
## delete
|
72
88
|
|
73
|
-
> AsyncOperationResponse delete(maven_maven_distribution_href)
|
89
|
+
> <AsyncOperationResponse> delete(maven_maven_distribution_href)
|
74
90
|
|
75
91
|
Delete a maven distribution
|
76
92
|
|
77
93
|
Trigger an asynchronous delete task
|
78
94
|
|
79
|
-
###
|
95
|
+
### Examples
|
80
96
|
|
81
97
|
```ruby
|
82
|
-
|
98
|
+
require 'time'
|
83
99
|
require 'pulp_maven_client'
|
84
100
|
# setup authorization
|
85
101
|
PulpMavenClient.configure do |config|
|
@@ -92,20 +108,37 @@ api_instance = PulpMavenClient::DistributionsMavenApi.new
|
|
92
108
|
maven_maven_distribution_href = 'maven_maven_distribution_href_example' # String |
|
93
109
|
|
94
110
|
begin
|
95
|
-
#Delete a maven distribution
|
111
|
+
# Delete a maven distribution
|
96
112
|
result = api_instance.delete(maven_maven_distribution_href)
|
97
113
|
p result
|
98
114
|
rescue PulpMavenClient::ApiError => e
|
99
|
-
puts "
|
115
|
+
puts "Error when calling DistributionsMavenApi->delete: #{e}"
|
100
116
|
end
|
101
117
|
```
|
102
118
|
|
103
|
-
|
119
|
+
#### Using the delete_with_http_info variant
|
120
|
+
|
121
|
+
This returns an Array which contains the response data, status code and headers.
|
122
|
+
|
123
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> delete_with_http_info(maven_maven_distribution_href)
|
124
|
+
|
125
|
+
```ruby
|
126
|
+
begin
|
127
|
+
# Delete a maven distribution
|
128
|
+
data, status_code, headers = api_instance.delete_with_http_info(maven_maven_distribution_href)
|
129
|
+
p status_code # => 2xx
|
130
|
+
p headers # => { ... }
|
131
|
+
p data # => <AsyncOperationResponse>
|
132
|
+
rescue PulpMavenClient::ApiError => e
|
133
|
+
puts "Error when calling DistributionsMavenApi->delete_with_http_info: #{e}"
|
134
|
+
end
|
135
|
+
```
|
104
136
|
|
137
|
+
### Parameters
|
105
138
|
|
106
|
-
Name | Type | Description
|
107
|
-
|
108
|
-
**maven_maven_distribution_href** | **String
|
139
|
+
| Name | Type | Description | Notes |
|
140
|
+
| ---- | ---- | ----------- | ----- |
|
141
|
+
| **maven_maven_distribution_href** | **String** | | |
|
109
142
|
|
110
143
|
### Return type
|
111
144
|
|
@@ -123,16 +156,16 @@ Name | Type | Description | Notes
|
|
123
156
|
|
124
157
|
## list
|
125
158
|
|
126
|
-
> PaginatedmavenMavenDistributionResponseList list(opts)
|
159
|
+
> <PaginatedmavenMavenDistributionResponseList> list(opts)
|
127
160
|
|
128
161
|
List maven distributions
|
129
162
|
|
130
163
|
ViewSet for Maven Distributions.
|
131
164
|
|
132
|
-
###
|
165
|
+
### Examples
|
133
166
|
|
134
167
|
```ruby
|
135
|
-
|
168
|
+
require 'time'
|
136
169
|
require 'pulp_maven_client'
|
137
170
|
# setup authorization
|
138
171
|
PulpMavenClient.configure do |config|
|
@@ -146,69 +179,88 @@ opts = {
|
|
146
179
|
base_path: 'base_path_example', # String | Filter results where base_path matches value
|
147
180
|
base_path__contains: 'base_path__contains_example', # String | Filter results where base_path contains value
|
148
181
|
base_path__icontains: 'base_path__icontains_example', # String | Filter results where base_path contains value
|
149
|
-
base_path__in: ['
|
182
|
+
base_path__in: ['inner_example'], # Array<String> | Filter results where base_path is in a comma-separated list of values
|
150
183
|
limit: 56, # Integer | Number of results to return per page.
|
151
184
|
name: 'name_example', # String | Filter results where name matches value
|
152
185
|
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
153
186
|
name__icontains: 'name__icontains_example', # String | Filter results where name contains value
|
154
187
|
name__iexact: 'name__iexact_example', # String | Filter results where name matches value
|
155
|
-
name__in: ['
|
188
|
+
name__in: ['inner_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
156
189
|
name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
|
157
190
|
name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
|
158
191
|
name__regex: 'name__regex_example', # String | Filter results where name matches regex value
|
159
192
|
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
|
160
193
|
offset: 56, # Integer | The initial index from which to return the results.
|
161
|
-
ordering: ['
|
162
|
-
|
163
|
-
|
194
|
+
ordering: ['-base_path'], # Array<String> | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
195
|
+
prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
196
|
+
pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
197
|
+
pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
164
198
|
pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
|
165
|
-
q: 'q_example', # String |
|
166
|
-
repository: '
|
167
|
-
repository__in: ['
|
199
|
+
q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
|
200
|
+
repository: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Filter results where repository matches value
|
201
|
+
repository__in: ['inner_example'], # Array<String> | Filter results where repository is in a comma-separated list of values
|
168
202
|
with_content: 'with_content_example', # String | Filter distributions based on the content served by them
|
169
|
-
fields: ['
|
170
|
-
exclude_fields: ['
|
203
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
204
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
171
205
|
}
|
172
206
|
|
173
207
|
begin
|
174
|
-
#List maven distributions
|
208
|
+
# List maven distributions
|
175
209
|
result = api_instance.list(opts)
|
176
210
|
p result
|
177
211
|
rescue PulpMavenClient::ApiError => e
|
178
|
-
puts "
|
212
|
+
puts "Error when calling DistributionsMavenApi->list: #{e}"
|
179
213
|
end
|
180
214
|
```
|
181
215
|
|
182
|
-
|
216
|
+
#### Using the list_with_http_info variant
|
217
|
+
|
218
|
+
This returns an Array which contains the response data, status code and headers.
|
219
|
+
|
220
|
+
> <Array(<PaginatedmavenMavenDistributionResponseList>, Integer, Hash)> list_with_http_info(opts)
|
221
|
+
|
222
|
+
```ruby
|
223
|
+
begin
|
224
|
+
# List maven distributions
|
225
|
+
data, status_code, headers = api_instance.list_with_http_info(opts)
|
226
|
+
p status_code # => 2xx
|
227
|
+
p headers # => { ... }
|
228
|
+
p data # => <PaginatedmavenMavenDistributionResponseList>
|
229
|
+
rescue PulpMavenClient::ApiError => e
|
230
|
+
puts "Error when calling DistributionsMavenApi->list_with_http_info: #{e}"
|
231
|
+
end
|
232
|
+
```
|
183
233
|
|
234
|
+
### Parameters
|
184
235
|
|
185
|
-
Name | Type | Description
|
186
|
-
|
187
|
-
**base_path** | **String
|
188
|
-
**base_path__contains** | **String
|
189
|
-
**base_path__icontains** | **String
|
190
|
-
**base_path__in** | [**Array<String>**](String.md)| Filter results where base_path is in a comma-separated list of values | [optional]
|
191
|
-
**limit** | **Integer
|
192
|
-
**name** | **String
|
193
|
-
**name__contains** | **String
|
194
|
-
**name__icontains** | **String
|
195
|
-
**name__iexact** | **String
|
196
|
-
**name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
|
197
|
-
**name__iregex** | **String
|
198
|
-
**name__istartswith** | **String
|
199
|
-
**name__regex** | **String
|
200
|
-
**name__startswith** | **String
|
201
|
-
**offset** | **Integer
|
202
|
-
**ordering** | [**Array<String>**](String.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
|
203
|
-
**
|
204
|
-
**
|
205
|
-
**
|
206
|
-
**
|
207
|
-
**
|
208
|
-
**
|
209
|
-
**
|
210
|
-
**
|
211
|
-
**
|
236
|
+
| Name | Type | Description | Notes |
|
237
|
+
| ---- | ---- | ----------- | ----- |
|
238
|
+
| **base_path** | **String** | Filter results where base_path matches value | [optional] |
|
239
|
+
| **base_path__contains** | **String** | Filter results where base_path contains value | [optional] |
|
240
|
+
| **base_path__icontains** | **String** | Filter results where base_path contains value | [optional] |
|
241
|
+
| **base_path__in** | [**Array<String>**](String.md) | Filter results where base_path is in a comma-separated list of values | [optional] |
|
242
|
+
| **limit** | **Integer** | Number of results to return per page. | [optional] |
|
243
|
+
| **name** | **String** | Filter results where name matches value | [optional] |
|
244
|
+
| **name__contains** | **String** | Filter results where name contains value | [optional] |
|
245
|
+
| **name__icontains** | **String** | Filter results where name contains value | [optional] |
|
246
|
+
| **name__iexact** | **String** | Filter results where name matches value | [optional] |
|
247
|
+
| **name__in** | [**Array<String>**](String.md) | Filter results where name is in a comma-separated list of values | [optional] |
|
248
|
+
| **name__iregex** | **String** | Filter results where name matches regex value | [optional] |
|
249
|
+
| **name__istartswith** | **String** | Filter results where name starts with value | [optional] |
|
250
|
+
| **name__regex** | **String** | Filter results where name matches regex value | [optional] |
|
251
|
+
| **name__startswith** | **String** | Filter results where name starts with value | [optional] |
|
252
|
+
| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
|
253
|
+
| **ordering** | [**Array<String>**](String.md) | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] |
|
254
|
+
| **prn__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
255
|
+
| **pulp_href__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
256
|
+
| **pulp_id__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
257
|
+
| **pulp_label_select** | **String** | Filter labels by search string | [optional] |
|
258
|
+
| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
|
259
|
+
| **repository** | **String** | Filter results where repository matches value | [optional] |
|
260
|
+
| **repository__in** | [**Array<String>**](String.md) | Filter results where repository is in a comma-separated list of values | [optional] |
|
261
|
+
| **with_content** | **String** | Filter distributions based on the content served by them | [optional] |
|
262
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
263
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
212
264
|
|
213
265
|
### Return type
|
214
266
|
|
@@ -226,16 +278,16 @@ Name | Type | Description | Notes
|
|
226
278
|
|
227
279
|
## partial_update
|
228
280
|
|
229
|
-
> AsyncOperationResponse partial_update(maven_maven_distribution_href, patchedmaven_maven_distribution)
|
281
|
+
> <AsyncOperationResponse> partial_update(maven_maven_distribution_href, patchedmaven_maven_distribution)
|
230
282
|
|
231
283
|
Update a maven distribution
|
232
284
|
|
233
285
|
Trigger an asynchronous partial update task
|
234
286
|
|
235
|
-
###
|
287
|
+
### Examples
|
236
288
|
|
237
289
|
```ruby
|
238
|
-
|
290
|
+
require 'time'
|
239
291
|
require 'pulp_maven_client'
|
240
292
|
# setup authorization
|
241
293
|
PulpMavenClient.configure do |config|
|
@@ -249,21 +301,38 @@ maven_maven_distribution_href = 'maven_maven_distribution_href_example' # String
|
|
249
301
|
patchedmaven_maven_distribution = PulpMavenClient::PatchedmavenMavenDistribution.new # PatchedmavenMavenDistribution |
|
250
302
|
|
251
303
|
begin
|
252
|
-
#Update a maven distribution
|
304
|
+
# Update a maven distribution
|
253
305
|
result = api_instance.partial_update(maven_maven_distribution_href, patchedmaven_maven_distribution)
|
254
306
|
p result
|
255
307
|
rescue PulpMavenClient::ApiError => e
|
256
|
-
puts "
|
308
|
+
puts "Error when calling DistributionsMavenApi->partial_update: #{e}"
|
257
309
|
end
|
258
310
|
```
|
259
311
|
|
260
|
-
|
312
|
+
#### Using the partial_update_with_http_info variant
|
313
|
+
|
314
|
+
This returns an Array which contains the response data, status code and headers.
|
315
|
+
|
316
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> partial_update_with_http_info(maven_maven_distribution_href, patchedmaven_maven_distribution)
|
317
|
+
|
318
|
+
```ruby
|
319
|
+
begin
|
320
|
+
# Update a maven distribution
|
321
|
+
data, status_code, headers = api_instance.partial_update_with_http_info(maven_maven_distribution_href, patchedmaven_maven_distribution)
|
322
|
+
p status_code # => 2xx
|
323
|
+
p headers # => { ... }
|
324
|
+
p data # => <AsyncOperationResponse>
|
325
|
+
rescue PulpMavenClient::ApiError => e
|
326
|
+
puts "Error when calling DistributionsMavenApi->partial_update_with_http_info: #{e}"
|
327
|
+
end
|
328
|
+
```
|
261
329
|
|
330
|
+
### Parameters
|
262
331
|
|
263
|
-
Name | Type | Description
|
264
|
-
|
265
|
-
**maven_maven_distribution_href** | **String
|
266
|
-
**patchedmaven_maven_distribution** | [**PatchedmavenMavenDistribution**](PatchedmavenMavenDistribution.md)| |
|
332
|
+
| Name | Type | Description | Notes |
|
333
|
+
| ---- | ---- | ----------- | ----- |
|
334
|
+
| **maven_maven_distribution_href** | **String** | | |
|
335
|
+
| **patchedmaven_maven_distribution** | [**PatchedmavenMavenDistribution**](PatchedmavenMavenDistribution.md) | | |
|
267
336
|
|
268
337
|
### Return type
|
269
338
|
|
@@ -281,16 +350,16 @@ Name | Type | Description | Notes
|
|
281
350
|
|
282
351
|
## read
|
283
352
|
|
284
|
-
> MavenMavenDistributionResponse read(maven_maven_distribution_href, opts)
|
353
|
+
> <MavenMavenDistributionResponse> read(maven_maven_distribution_href, opts)
|
285
354
|
|
286
355
|
Inspect a maven distribution
|
287
356
|
|
288
357
|
ViewSet for Maven Distributions.
|
289
358
|
|
290
|
-
###
|
359
|
+
### Examples
|
291
360
|
|
292
361
|
```ruby
|
293
|
-
|
362
|
+
require 'time'
|
294
363
|
require 'pulp_maven_client'
|
295
364
|
# setup authorization
|
296
365
|
PulpMavenClient.configure do |config|
|
@@ -302,27 +371,44 @@ end
|
|
302
371
|
api_instance = PulpMavenClient::DistributionsMavenApi.new
|
303
372
|
maven_maven_distribution_href = 'maven_maven_distribution_href_example' # String |
|
304
373
|
opts = {
|
305
|
-
fields: ['
|
306
|
-
exclude_fields: ['
|
374
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
375
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
307
376
|
}
|
308
377
|
|
309
378
|
begin
|
310
|
-
#Inspect a maven distribution
|
379
|
+
# Inspect a maven distribution
|
311
380
|
result = api_instance.read(maven_maven_distribution_href, opts)
|
312
381
|
p result
|
313
382
|
rescue PulpMavenClient::ApiError => e
|
314
|
-
puts "
|
383
|
+
puts "Error when calling DistributionsMavenApi->read: #{e}"
|
315
384
|
end
|
316
385
|
```
|
317
386
|
|
318
|
-
|
387
|
+
#### Using the read_with_http_info variant
|
388
|
+
|
389
|
+
This returns an Array which contains the response data, status code and headers.
|
390
|
+
|
391
|
+
> <Array(<MavenMavenDistributionResponse>, Integer, Hash)> read_with_http_info(maven_maven_distribution_href, opts)
|
392
|
+
|
393
|
+
```ruby
|
394
|
+
begin
|
395
|
+
# Inspect a maven distribution
|
396
|
+
data, status_code, headers = api_instance.read_with_http_info(maven_maven_distribution_href, opts)
|
397
|
+
p status_code # => 2xx
|
398
|
+
p headers # => { ... }
|
399
|
+
p data # => <MavenMavenDistributionResponse>
|
400
|
+
rescue PulpMavenClient::ApiError => e
|
401
|
+
puts "Error when calling DistributionsMavenApi->read_with_http_info: #{e}"
|
402
|
+
end
|
403
|
+
```
|
319
404
|
|
405
|
+
### Parameters
|
320
406
|
|
321
|
-
Name | Type | Description
|
322
|
-
|
323
|
-
**maven_maven_distribution_href** | **String
|
324
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
325
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
407
|
+
| Name | Type | Description | Notes |
|
408
|
+
| ---- | ---- | ----------- | ----- |
|
409
|
+
| **maven_maven_distribution_href** | **String** | | |
|
410
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
411
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
326
412
|
|
327
413
|
### Return type
|
328
414
|
|
@@ -340,16 +426,16 @@ Name | Type | Description | Notes
|
|
340
426
|
|
341
427
|
## set_label
|
342
428
|
|
343
|
-
> SetLabelResponse set_label(maven_maven_distribution_href, set_label)
|
429
|
+
> <SetLabelResponse> set_label(maven_maven_distribution_href, set_label)
|
344
430
|
|
345
431
|
Set a label
|
346
432
|
|
347
433
|
Set a single pulp_label on the object to a specific value or null.
|
348
434
|
|
349
|
-
###
|
435
|
+
### Examples
|
350
436
|
|
351
437
|
```ruby
|
352
|
-
|
438
|
+
require 'time'
|
353
439
|
require 'pulp_maven_client'
|
354
440
|
# setup authorization
|
355
441
|
PulpMavenClient.configure do |config|
|
@@ -360,24 +446,41 @@ end
|
|
360
446
|
|
361
447
|
api_instance = PulpMavenClient::DistributionsMavenApi.new
|
362
448
|
maven_maven_distribution_href = 'maven_maven_distribution_href_example' # String |
|
363
|
-
set_label = PulpMavenClient::SetLabel.new # SetLabel |
|
449
|
+
set_label = PulpMavenClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel |
|
364
450
|
|
365
451
|
begin
|
366
|
-
#Set a label
|
452
|
+
# Set a label
|
367
453
|
result = api_instance.set_label(maven_maven_distribution_href, set_label)
|
368
454
|
p result
|
369
455
|
rescue PulpMavenClient::ApiError => e
|
370
|
-
puts "
|
456
|
+
puts "Error when calling DistributionsMavenApi->set_label: #{e}"
|
371
457
|
end
|
372
458
|
```
|
373
459
|
|
374
|
-
|
460
|
+
#### Using the set_label_with_http_info variant
|
461
|
+
|
462
|
+
This returns an Array which contains the response data, status code and headers.
|
463
|
+
|
464
|
+
> <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(maven_maven_distribution_href, set_label)
|
465
|
+
|
466
|
+
```ruby
|
467
|
+
begin
|
468
|
+
# Set a label
|
469
|
+
data, status_code, headers = api_instance.set_label_with_http_info(maven_maven_distribution_href, set_label)
|
470
|
+
p status_code # => 2xx
|
471
|
+
p headers # => { ... }
|
472
|
+
p data # => <SetLabelResponse>
|
473
|
+
rescue PulpMavenClient::ApiError => e
|
474
|
+
puts "Error when calling DistributionsMavenApi->set_label_with_http_info: #{e}"
|
475
|
+
end
|
476
|
+
```
|
375
477
|
|
478
|
+
### Parameters
|
376
479
|
|
377
|
-
Name | Type | Description
|
378
|
-
|
379
|
-
**maven_maven_distribution_href** | **String
|
380
|
-
**set_label** | [**SetLabel**](SetLabel.md)| |
|
480
|
+
| Name | Type | Description | Notes |
|
481
|
+
| ---- | ---- | ----------- | ----- |
|
482
|
+
| **maven_maven_distribution_href** | **String** | | |
|
483
|
+
| **set_label** | [**SetLabel**](SetLabel.md) | | |
|
381
484
|
|
382
485
|
### Return type
|
383
486
|
|
@@ -395,16 +498,16 @@ Name | Type | Description | Notes
|
|
395
498
|
|
396
499
|
## unset_label
|
397
500
|
|
398
|
-
> UnsetLabelResponse unset_label(maven_maven_distribution_href, unset_label)
|
501
|
+
> <UnsetLabelResponse> unset_label(maven_maven_distribution_href, unset_label)
|
399
502
|
|
400
503
|
Unset a label
|
401
504
|
|
402
505
|
Unset a single pulp_label on the object.
|
403
506
|
|
404
|
-
###
|
507
|
+
### Examples
|
405
508
|
|
406
509
|
```ruby
|
407
|
-
|
510
|
+
require 'time'
|
408
511
|
require 'pulp_maven_client'
|
409
512
|
# setup authorization
|
410
513
|
PulpMavenClient.configure do |config|
|
@@ -415,24 +518,41 @@ end
|
|
415
518
|
|
416
519
|
api_instance = PulpMavenClient::DistributionsMavenApi.new
|
417
520
|
maven_maven_distribution_href = 'maven_maven_distribution_href_example' # String |
|
418
|
-
unset_label = PulpMavenClient::UnsetLabel.new # UnsetLabel |
|
521
|
+
unset_label = PulpMavenClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel |
|
419
522
|
|
420
523
|
begin
|
421
|
-
#Unset a label
|
524
|
+
# Unset a label
|
422
525
|
result = api_instance.unset_label(maven_maven_distribution_href, unset_label)
|
423
526
|
p result
|
424
527
|
rescue PulpMavenClient::ApiError => e
|
425
|
-
puts "
|
528
|
+
puts "Error when calling DistributionsMavenApi->unset_label: #{e}"
|
426
529
|
end
|
427
530
|
```
|
428
531
|
|
429
|
-
|
532
|
+
#### Using the unset_label_with_http_info variant
|
533
|
+
|
534
|
+
This returns an Array which contains the response data, status code and headers.
|
535
|
+
|
536
|
+
> <Array(<UnsetLabelResponse>, Integer, Hash)> unset_label_with_http_info(maven_maven_distribution_href, unset_label)
|
537
|
+
|
538
|
+
```ruby
|
539
|
+
begin
|
540
|
+
# Unset a label
|
541
|
+
data, status_code, headers = api_instance.unset_label_with_http_info(maven_maven_distribution_href, unset_label)
|
542
|
+
p status_code # => 2xx
|
543
|
+
p headers # => { ... }
|
544
|
+
p data # => <UnsetLabelResponse>
|
545
|
+
rescue PulpMavenClient::ApiError => e
|
546
|
+
puts "Error when calling DistributionsMavenApi->unset_label_with_http_info: #{e}"
|
547
|
+
end
|
548
|
+
```
|
430
549
|
|
550
|
+
### Parameters
|
431
551
|
|
432
|
-
Name | Type | Description
|
433
|
-
|
434
|
-
**maven_maven_distribution_href** | **String
|
435
|
-
**unset_label** | [**UnsetLabel**](UnsetLabel.md)| |
|
552
|
+
| Name | Type | Description | Notes |
|
553
|
+
| ---- | ---- | ----------- | ----- |
|
554
|
+
| **maven_maven_distribution_href** | **String** | | |
|
555
|
+
| **unset_label** | [**UnsetLabel**](UnsetLabel.md) | | |
|
436
556
|
|
437
557
|
### Return type
|
438
558
|
|
@@ -450,16 +570,16 @@ Name | Type | Description | Notes
|
|
450
570
|
|
451
571
|
## update
|
452
572
|
|
453
|
-
> AsyncOperationResponse update(maven_maven_distribution_href, maven_maven_distribution)
|
573
|
+
> <AsyncOperationResponse> update(maven_maven_distribution_href, maven_maven_distribution)
|
454
574
|
|
455
575
|
Update a maven distribution
|
456
576
|
|
457
577
|
Trigger an asynchronous update task
|
458
578
|
|
459
|
-
###
|
579
|
+
### Examples
|
460
580
|
|
461
581
|
```ruby
|
462
|
-
|
582
|
+
require 'time'
|
463
583
|
require 'pulp_maven_client'
|
464
584
|
# setup authorization
|
465
585
|
PulpMavenClient.configure do |config|
|
@@ -470,24 +590,41 @@ end
|
|
470
590
|
|
471
591
|
api_instance = PulpMavenClient::DistributionsMavenApi.new
|
472
592
|
maven_maven_distribution_href = 'maven_maven_distribution_href_example' # String |
|
473
|
-
maven_maven_distribution = PulpMavenClient::MavenMavenDistribution.new # MavenMavenDistribution |
|
593
|
+
maven_maven_distribution = PulpMavenClient::MavenMavenDistribution.new({base_path: 'base_path_example', name: 'name_example'}) # MavenMavenDistribution |
|
474
594
|
|
475
595
|
begin
|
476
|
-
#Update a maven distribution
|
596
|
+
# Update a maven distribution
|
477
597
|
result = api_instance.update(maven_maven_distribution_href, maven_maven_distribution)
|
478
598
|
p result
|
479
599
|
rescue PulpMavenClient::ApiError => e
|
480
|
-
puts "
|
600
|
+
puts "Error when calling DistributionsMavenApi->update: #{e}"
|
481
601
|
end
|
482
602
|
```
|
483
603
|
|
484
|
-
|
604
|
+
#### Using the update_with_http_info variant
|
605
|
+
|
606
|
+
This returns an Array which contains the response data, status code and headers.
|
607
|
+
|
608
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> update_with_http_info(maven_maven_distribution_href, maven_maven_distribution)
|
609
|
+
|
610
|
+
```ruby
|
611
|
+
begin
|
612
|
+
# Update a maven distribution
|
613
|
+
data, status_code, headers = api_instance.update_with_http_info(maven_maven_distribution_href, maven_maven_distribution)
|
614
|
+
p status_code # => 2xx
|
615
|
+
p headers # => { ... }
|
616
|
+
p data # => <AsyncOperationResponse>
|
617
|
+
rescue PulpMavenClient::ApiError => e
|
618
|
+
puts "Error when calling DistributionsMavenApi->update_with_http_info: #{e}"
|
619
|
+
end
|
620
|
+
```
|
485
621
|
|
622
|
+
### Parameters
|
486
623
|
|
487
|
-
Name | Type | Description
|
488
|
-
|
489
|
-
**maven_maven_distribution_href** | **String
|
490
|
-
**maven_maven_distribution** | [**MavenMavenDistribution**](MavenMavenDistribution.md)| |
|
624
|
+
| Name | Type | Description | Notes |
|
625
|
+
| ---- | ---- | ----------- | ----- |
|
626
|
+
| **maven_maven_distribution_href** | **String** | | |
|
627
|
+
| **maven_maven_distribution** | [**MavenMavenDistribution**](MavenMavenDistribution.md) | | |
|
491
628
|
|
492
629
|
### Return type
|
493
630
|
|