pulp_maven_client 0.8.2 → 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 +10 -6
- data/docs/AsyncOperationResponse.md +8 -7
- data/docs/ContentArtifactApi.md +111 -61
- data/docs/ContentSummaryResponse.md +12 -11
- data/docs/DistributionsMavenApi.md +265 -130
- data/docs/MavenMavenArtifact.md +12 -11
- data/docs/MavenMavenArtifactResponse.md +24 -23
- data/docs/MavenMavenDistribution.md +20 -19
- data/docs/MavenMavenDistributionResponse.md +32 -31
- data/docs/MavenMavenRemote.md +48 -47
- data/docs/MavenMavenRemoteResponse.md +48 -47
- data/docs/MavenMavenRemoteResponseHiddenFieldsInner.md +20 -0
- data/docs/MavenMavenRepository.md +16 -15
- data/docs/MavenMavenRepositoryResponse.md +28 -27
- 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 +60 -25
- data/docs/RemotesMavenApi.md +269 -132
- data/docs/Repair.md +8 -7
- data/docs/RepositoriesMavenApi.md +296 -144
- data/docs/RepositoriesMavenVersionsApi.md +152 -82
- data/docs/RepositoryAddCachedContent.md +8 -7
- data/docs/RepositoryVersionResponse.md +22 -21
- 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 +20 -14
- data/lib/pulp_maven_client/api/distributions_maven_api.rb +61 -38
- data/lib/pulp_maven_client/api/pulp_maven_api.rb +9 -7
- data/lib/pulp_maven_client/api/remotes_maven_api.rb +76 -50
- data/lib/pulp_maven_client/api/repositories_maven_api.rb +70 -43
- data/lib/pulp_maven_client/api/repositories_maven_versions_api.rb +40 -30
- 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 +34 -24
- data/lib/pulp_maven_client/models/maven_maven_distribution.rb +34 -22
- data/lib/pulp_maven_client/models/maven_maven_distribution_response.rb +36 -24
- data/lib/pulp_maven_client/models/maven_maven_remote.rb +57 -38
- data/lib/pulp_maven_client/models/maven_maven_remote_response.rb +60 -41
- 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 +34 -39
- 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 +32 -24
- 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 +4 -4
- data/spec/api/distributions_maven_api_spec.rb +9 -9
- data/spec/api/pulp_maven_api_spec.rb +3 -3
- data/spec/api/remotes_maven_api_spec.rb +16 -15
- data/spec/api/repositories_maven_api_spec.rb +10 -10
- data/spec/api/repositories_maven_versions_api_spec.rb +12 -11
- 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 +15 -20
- data/spec/models/maven_maven_artifact_spec.rb +9 -14
- data/spec/models/maven_maven_distribution_response_spec.rb +19 -24
- 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 +27 -32
- data/spec/models/maven_maven_remote_spec.rb +27 -32
- data/spec/models/maven_maven_repository_response_spec.rb +17 -22
- 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 +14 -19
- 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 +67 -43
- data/docs/MavenMavenRemoteResponseHiddenFields.md +0 -19
- data/spec/api_client_spec.rb +0 -188
- data/spec/configuration_spec.rb +0 -42
@@ -2,31 +2,30 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost:24817*
|
4
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
|
15
|
-
|
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,71 +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
|
-
prn__in: ['
|
163
|
-
pulp_href__in: ['
|
164
|
-
pulp_id__in: ['
|
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.
|
165
198
|
pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
|
166
199
|
q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
|
167
|
-
repository: '
|
168
|
-
repository__in: ['
|
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
|
169
202
|
with_content: 'with_content_example', # String | Filter distributions based on the content served by them
|
170
|
-
fields: ['
|
171
|
-
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.
|
172
205
|
}
|
173
206
|
|
174
207
|
begin
|
175
|
-
#List maven distributions
|
208
|
+
# List maven distributions
|
176
209
|
result = api_instance.list(opts)
|
177
210
|
p result
|
178
211
|
rescue PulpMavenClient::ApiError => e
|
179
|
-
puts "
|
212
|
+
puts "Error when calling DistributionsMavenApi->list: #{e}"
|
180
213
|
end
|
181
214
|
```
|
182
215
|
|
183
|
-
|
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
|
+
```
|
184
233
|
|
234
|
+
### Parameters
|
185
235
|
|
186
|
-
Name | Type | Description
|
187
|
-
|
188
|
-
**base_path** | **String
|
189
|
-
**base_path__contains** | **String
|
190
|
-
**base_path__icontains** | **String
|
191
|
-
**base_path__in** | [**Array<String>**](String.md)| Filter results where base_path is in a comma-separated list of values | [optional]
|
192
|
-
**limit** | **Integer
|
193
|
-
**name** | **String
|
194
|
-
**name__contains** | **String
|
195
|
-
**name__icontains** | **String
|
196
|
-
**name__iexact** | **String
|
197
|
-
**name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
|
198
|
-
**name__iregex** | **String
|
199
|
-
**name__istartswith** | **String
|
200
|
-
**name__regex** | **String
|
201
|
-
**name__startswith** | **String
|
202
|
-
**offset** | **Integer
|
203
|
-
**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]
|
204
|
-
**prn__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
205
|
-
**pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
206
|
-
**pulp_id__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
207
|
-
**pulp_label_select** | **String
|
208
|
-
**q** | **String
|
209
|
-
**repository** |
|
210
|
-
**repository__in** | [**Array<String>**](String.md)| Filter results where repository is in a comma-separated list of values | [optional]
|
211
|
-
**with_content** | **String
|
212
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
213
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
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] |
|
214
264
|
|
215
265
|
### Return type
|
216
266
|
|
@@ -228,16 +278,16 @@ Name | Type | Description | Notes
|
|
228
278
|
|
229
279
|
## partial_update
|
230
280
|
|
231
|
-
> AsyncOperationResponse partial_update(maven_maven_distribution_href, patchedmaven_maven_distribution)
|
281
|
+
> <AsyncOperationResponse> partial_update(maven_maven_distribution_href, patchedmaven_maven_distribution)
|
232
282
|
|
233
283
|
Update a maven distribution
|
234
284
|
|
235
285
|
Trigger an asynchronous partial update task
|
236
286
|
|
237
|
-
###
|
287
|
+
### Examples
|
238
288
|
|
239
289
|
```ruby
|
240
|
-
|
290
|
+
require 'time'
|
241
291
|
require 'pulp_maven_client'
|
242
292
|
# setup authorization
|
243
293
|
PulpMavenClient.configure do |config|
|
@@ -251,21 +301,38 @@ maven_maven_distribution_href = 'maven_maven_distribution_href_example' # String
|
|
251
301
|
patchedmaven_maven_distribution = PulpMavenClient::PatchedmavenMavenDistribution.new # PatchedmavenMavenDistribution |
|
252
302
|
|
253
303
|
begin
|
254
|
-
#Update a maven distribution
|
304
|
+
# Update a maven distribution
|
255
305
|
result = api_instance.partial_update(maven_maven_distribution_href, patchedmaven_maven_distribution)
|
256
306
|
p result
|
257
307
|
rescue PulpMavenClient::ApiError => e
|
258
|
-
puts "
|
308
|
+
puts "Error when calling DistributionsMavenApi->partial_update: #{e}"
|
259
309
|
end
|
260
310
|
```
|
261
311
|
|
262
|
-
|
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
|
+
```
|
263
329
|
|
330
|
+
### Parameters
|
264
331
|
|
265
|
-
Name | Type | Description
|
266
|
-
|
267
|
-
**maven_maven_distribution_href** | **String
|
268
|
-
**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) | | |
|
269
336
|
|
270
337
|
### Return type
|
271
338
|
|
@@ -283,16 +350,16 @@ Name | Type | Description | Notes
|
|
283
350
|
|
284
351
|
## read
|
285
352
|
|
286
|
-
> MavenMavenDistributionResponse read(maven_maven_distribution_href, opts)
|
353
|
+
> <MavenMavenDistributionResponse> read(maven_maven_distribution_href, opts)
|
287
354
|
|
288
355
|
Inspect a maven distribution
|
289
356
|
|
290
357
|
ViewSet for Maven Distributions.
|
291
358
|
|
292
|
-
###
|
359
|
+
### Examples
|
293
360
|
|
294
361
|
```ruby
|
295
|
-
|
362
|
+
require 'time'
|
296
363
|
require 'pulp_maven_client'
|
297
364
|
# setup authorization
|
298
365
|
PulpMavenClient.configure do |config|
|
@@ -304,27 +371,44 @@ end
|
|
304
371
|
api_instance = PulpMavenClient::DistributionsMavenApi.new
|
305
372
|
maven_maven_distribution_href = 'maven_maven_distribution_href_example' # String |
|
306
373
|
opts = {
|
307
|
-
fields: ['
|
308
|
-
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.
|
309
376
|
}
|
310
377
|
|
311
378
|
begin
|
312
|
-
#Inspect a maven distribution
|
379
|
+
# Inspect a maven distribution
|
313
380
|
result = api_instance.read(maven_maven_distribution_href, opts)
|
314
381
|
p result
|
315
382
|
rescue PulpMavenClient::ApiError => e
|
316
|
-
puts "
|
383
|
+
puts "Error when calling DistributionsMavenApi->read: #{e}"
|
317
384
|
end
|
318
385
|
```
|
319
386
|
|
320
|
-
|
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
|
+
```
|
321
404
|
|
405
|
+
### Parameters
|
322
406
|
|
323
|
-
Name | Type | Description
|
324
|
-
|
325
|
-
**maven_maven_distribution_href** | **String
|
326
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
327
|
-
**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] |
|
328
412
|
|
329
413
|
### Return type
|
330
414
|
|
@@ -342,16 +426,16 @@ Name | Type | Description | Notes
|
|
342
426
|
|
343
427
|
## set_label
|
344
428
|
|
345
|
-
> SetLabelResponse set_label(maven_maven_distribution_href, set_label)
|
429
|
+
> <SetLabelResponse> set_label(maven_maven_distribution_href, set_label)
|
346
430
|
|
347
431
|
Set a label
|
348
432
|
|
349
433
|
Set a single pulp_label on the object to a specific value or null.
|
350
434
|
|
351
|
-
###
|
435
|
+
### Examples
|
352
436
|
|
353
437
|
```ruby
|
354
|
-
|
438
|
+
require 'time'
|
355
439
|
require 'pulp_maven_client'
|
356
440
|
# setup authorization
|
357
441
|
PulpMavenClient.configure do |config|
|
@@ -362,24 +446,41 @@ end
|
|
362
446
|
|
363
447
|
api_instance = PulpMavenClient::DistributionsMavenApi.new
|
364
448
|
maven_maven_distribution_href = 'maven_maven_distribution_href_example' # String |
|
365
|
-
set_label = PulpMavenClient::SetLabel.new # SetLabel |
|
449
|
+
set_label = PulpMavenClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel |
|
366
450
|
|
367
451
|
begin
|
368
|
-
#Set a label
|
452
|
+
# Set a label
|
369
453
|
result = api_instance.set_label(maven_maven_distribution_href, set_label)
|
370
454
|
p result
|
371
455
|
rescue PulpMavenClient::ApiError => e
|
372
|
-
puts "
|
456
|
+
puts "Error when calling DistributionsMavenApi->set_label: #{e}"
|
373
457
|
end
|
374
458
|
```
|
375
459
|
|
376
|
-
|
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
|
+
```
|
377
477
|
|
478
|
+
### Parameters
|
378
479
|
|
379
|
-
Name | Type | Description
|
380
|
-
|
381
|
-
**maven_maven_distribution_href** | **String
|
382
|
-
**set_label** | [**SetLabel**](SetLabel.md)| |
|
480
|
+
| Name | Type | Description | Notes |
|
481
|
+
| ---- | ---- | ----------- | ----- |
|
482
|
+
| **maven_maven_distribution_href** | **String** | | |
|
483
|
+
| **set_label** | [**SetLabel**](SetLabel.md) | | |
|
383
484
|
|
384
485
|
### Return type
|
385
486
|
|
@@ -397,16 +498,16 @@ Name | Type | Description | Notes
|
|
397
498
|
|
398
499
|
## unset_label
|
399
500
|
|
400
|
-
> UnsetLabelResponse unset_label(maven_maven_distribution_href, unset_label)
|
501
|
+
> <UnsetLabelResponse> unset_label(maven_maven_distribution_href, unset_label)
|
401
502
|
|
402
503
|
Unset a label
|
403
504
|
|
404
505
|
Unset a single pulp_label on the object.
|
405
506
|
|
406
|
-
###
|
507
|
+
### Examples
|
407
508
|
|
408
509
|
```ruby
|
409
|
-
|
510
|
+
require 'time'
|
410
511
|
require 'pulp_maven_client'
|
411
512
|
# setup authorization
|
412
513
|
PulpMavenClient.configure do |config|
|
@@ -417,24 +518,41 @@ end
|
|
417
518
|
|
418
519
|
api_instance = PulpMavenClient::DistributionsMavenApi.new
|
419
520
|
maven_maven_distribution_href = 'maven_maven_distribution_href_example' # String |
|
420
|
-
unset_label = PulpMavenClient::UnsetLabel.new # UnsetLabel |
|
521
|
+
unset_label = PulpMavenClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel |
|
421
522
|
|
422
523
|
begin
|
423
|
-
#Unset a label
|
524
|
+
# Unset a label
|
424
525
|
result = api_instance.unset_label(maven_maven_distribution_href, unset_label)
|
425
526
|
p result
|
426
527
|
rescue PulpMavenClient::ApiError => e
|
427
|
-
puts "
|
528
|
+
puts "Error when calling DistributionsMavenApi->unset_label: #{e}"
|
428
529
|
end
|
429
530
|
```
|
430
531
|
|
431
|
-
|
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
|
+
```
|
432
549
|
|
550
|
+
### Parameters
|
433
551
|
|
434
|
-
Name | Type | Description
|
435
|
-
|
436
|
-
**maven_maven_distribution_href** | **String
|
437
|
-
**unset_label** | [**UnsetLabel**](UnsetLabel.md)| |
|
552
|
+
| Name | Type | Description | Notes |
|
553
|
+
| ---- | ---- | ----------- | ----- |
|
554
|
+
| **maven_maven_distribution_href** | **String** | | |
|
555
|
+
| **unset_label** | [**UnsetLabel**](UnsetLabel.md) | | |
|
438
556
|
|
439
557
|
### Return type
|
440
558
|
|
@@ -452,16 +570,16 @@ Name | Type | Description | Notes
|
|
452
570
|
|
453
571
|
## update
|
454
572
|
|
455
|
-
> AsyncOperationResponse update(maven_maven_distribution_href, maven_maven_distribution)
|
573
|
+
> <AsyncOperationResponse> update(maven_maven_distribution_href, maven_maven_distribution)
|
456
574
|
|
457
575
|
Update a maven distribution
|
458
576
|
|
459
577
|
Trigger an asynchronous update task
|
460
578
|
|
461
|
-
###
|
579
|
+
### Examples
|
462
580
|
|
463
581
|
```ruby
|
464
|
-
|
582
|
+
require 'time'
|
465
583
|
require 'pulp_maven_client'
|
466
584
|
# setup authorization
|
467
585
|
PulpMavenClient.configure do |config|
|
@@ -472,24 +590,41 @@ end
|
|
472
590
|
|
473
591
|
api_instance = PulpMavenClient::DistributionsMavenApi.new
|
474
592
|
maven_maven_distribution_href = 'maven_maven_distribution_href_example' # String |
|
475
|
-
maven_maven_distribution = PulpMavenClient::MavenMavenDistribution.new # MavenMavenDistribution |
|
593
|
+
maven_maven_distribution = PulpMavenClient::MavenMavenDistribution.new({base_path: 'base_path_example', name: 'name_example'}) # MavenMavenDistribution |
|
476
594
|
|
477
595
|
begin
|
478
|
-
#Update a maven distribution
|
596
|
+
# Update a maven distribution
|
479
597
|
result = api_instance.update(maven_maven_distribution_href, maven_maven_distribution)
|
480
598
|
p result
|
481
599
|
rescue PulpMavenClient::ApiError => e
|
482
|
-
puts "
|
600
|
+
puts "Error when calling DistributionsMavenApi->update: #{e}"
|
483
601
|
end
|
484
602
|
```
|
485
603
|
|
486
|
-
|
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
|
+
```
|
487
621
|
|
622
|
+
### Parameters
|
488
623
|
|
489
|
-
Name | Type | Description
|
490
|
-
|
491
|
-
**maven_maven_distribution_href** | **String
|
492
|
-
**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) | | |
|
493
628
|
|
494
629
|
### Return type
|
495
630
|
|