pulp_gem_client 0.6.1 → 0.7.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 +14 -8
- data/docs/AsyncOperationResponse.md +8 -7
- data/docs/ContentGemApi.md +268 -66
- data/docs/ContentSummaryResponse.md +12 -11
- data/docs/DistributionsGemApi.md +388 -183
- data/docs/GemGemContentResponse.md +34 -29
- data/docs/GemGemDistribution.md +22 -21
- data/docs/GemGemDistributionResponse.md +34 -29
- data/docs/GemGemPublication.md +10 -9
- data/docs/GemGemPublicationResponse.md +18 -15
- data/docs/GemGemRemote.md +54 -53
- data/docs/GemGemRemoteResponse.md +54 -51
- data/docs/GemGemRemoteResponseHiddenFieldsInner.md +20 -0
- data/docs/GemGemRepository.md +16 -15
- data/docs/GemGemRepositoryResponse.md +28 -25
- data/docs/MyPermissionsResponse.md +8 -7
- data/docs/NestedRole.md +12 -11
- data/docs/NestedRoleResponse.md +12 -11
- data/docs/ObjectRolesResponse.md +8 -7
- data/docs/PaginatedRepositoryVersionResponseList.md +14 -13
- data/docs/PaginatedgemGemContentResponseList.md +14 -13
- data/docs/PaginatedgemGemDistributionResponseList.md +14 -13
- data/docs/PaginatedgemGemPublicationResponseList.md +14 -13
- data/docs/PaginatedgemGemRemoteResponseList.md +14 -13
- data/docs/PaginatedgemGemRepositoryResponseList.md +14 -13
- data/docs/PatchedgemGemDistribution.md +22 -21
- data/docs/PatchedgemGemRemote.md +54 -53
- data/docs/PatchedgemGemRepository.md +16 -15
- data/docs/PolicyEnum.md +4 -5
- data/docs/PublicationsGemApi.md +271 -132
- data/docs/RemotesGemApi.md +392 -185
- data/docs/Repair.md +8 -7
- data/docs/RepositoriesGemApi.md +449 -210
- data/docs/RepositoriesGemVersionsApi.md +155 -83
- data/docs/RepositoryAddRemoveContent.md +12 -11
- data/docs/RepositorySyncURL.md +10 -9
- 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_gem_client/api/content_gem_api.rb +188 -25
- data/lib/pulp_gem_client/api/distributions_gem_api.rb +94 -58
- data/lib/pulp_gem_client/api/publications_gem_api.rb +81 -58
- data/lib/pulp_gem_client/api/remotes_gem_api.rb +109 -70
- data/lib/pulp_gem_client/api/repositories_gem_api.rb +116 -72
- data/lib/pulp_gem_client/api/repositories_gem_versions_api.rb +50 -37
- data/lib/pulp_gem_client/api_client.rb +137 -102
- data/lib/pulp_gem_client/api_error.rb +2 -1
- data/lib/pulp_gem_client/configuration.rb +162 -21
- data/lib/pulp_gem_client/models/async_operation_response.rb +32 -22
- data/lib/pulp_gem_client/models/content_summary_response.rb +36 -22
- data/lib/pulp_gem_client/models/gem_gem_content_response.rb +57 -25
- data/lib/pulp_gem_client/models/gem_gem_distribution.rb +34 -22
- data/lib/pulp_gem_client/models/gem_gem_distribution_response.rb +57 -25
- data/lib/pulp_gem_client/models/gem_gem_publication.rb +30 -22
- data/lib/pulp_gem_client/models/gem_gem_publication_response.rb +43 -25
- data/lib/pulp_gem_client/models/gem_gem_remote.rb +56 -22
- data/lib/pulp_gem_client/models/gem_gem_remote_response.rb +70 -26
- data/lib/pulp_gem_client/models/{gem_gem_remote_response_hidden_fields.rb → gem_gem_remote_response_hidden_fields_inner.rb} +37 -25
- data/lib/pulp_gem_client/models/gem_gem_repository.rb +32 -22
- data/lib/pulp_gem_client/models/gem_gem_repository_response.rb +45 -25
- data/lib/pulp_gem_client/models/my_permissions_response.rb +32 -22
- data/lib/pulp_gem_client/models/nested_role.rb +32 -22
- data/lib/pulp_gem_client/models/nested_role_response.rb +32 -22
- data/lib/pulp_gem_client/models/object_roles_response.rb +32 -22
- data/lib/pulp_gem_client/models/paginated_repository_version_response_list.rb +34 -22
- data/lib/pulp_gem_client/models/paginatedgem_gem_content_response_list.rb +34 -22
- data/lib/pulp_gem_client/models/paginatedgem_gem_distribution_response_list.rb +34 -22
- data/lib/pulp_gem_client/models/paginatedgem_gem_publication_response_list.rb +34 -22
- data/lib/pulp_gem_client/models/paginatedgem_gem_remote_response_list.rb +34 -22
- data/lib/pulp_gem_client/models/paginatedgem_gem_repository_response_list.rb +34 -22
- data/lib/pulp_gem_client/models/patchedgem_gem_distribution.rb +40 -24
- data/lib/pulp_gem_client/models/patchedgem_gem_remote.rb +62 -24
- data/lib/pulp_gem_client/models/patchedgem_gem_repository.rb +35 -23
- data/lib/pulp_gem_client/models/policy_enum.rb +8 -4
- data/lib/pulp_gem_client/models/repair.rb +30 -22
- data/lib/pulp_gem_client/models/repository_add_remove_content.rb +31 -23
- data/lib/pulp_gem_client/models/repository_sync_url.rb +30 -22
- data/lib/pulp_gem_client/models/repository_version_response.rb +44 -26
- data/lib/pulp_gem_client/models/set_label.rb +34 -22
- data/lib/pulp_gem_client/models/set_label_response.rb +34 -22
- data/lib/pulp_gem_client/models/unset_label.rb +33 -23
- data/lib/pulp_gem_client/models/unset_label_response.rb +33 -23
- data/lib/pulp_gem_client/version.rb +2 -2
- data/lib/pulp_gem_client.rb +2 -3
- data/pulp_gem_client.gemspec +9 -6
- data/spec/api/content_gem_api_spec.rb +38 -9
- data/spec/api/distributions_gem_api_spec.rb +15 -14
- data/spec/api/publications_gem_api_spec.rb +22 -20
- data/spec/api/remotes_gem_api_spec.rb +22 -20
- data/spec/api/repositories_gem_api_spec.rb +19 -18
- data/spec/api/repositories_gem_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/gem_gem_content_response_spec.rb +30 -23
- data/spec/models/gem_gem_distribution_response_spec.rb +30 -23
- data/spec/models/gem_gem_distribution_spec.rb +14 -19
- data/spec/models/gem_gem_publication_response_spec.rb +17 -16
- data/spec/models/gem_gem_publication_spec.rb +8 -13
- data/spec/models/{gem_gem_remote_response_hidden_fields_spec.rb → gem_gem_remote_response_hidden_fields_inner_spec.rb} +11 -16
- data/spec/models/gem_gem_remote_response_spec.rb +35 -34
- data/spec/models/gem_gem_remote_spec.rb +30 -35
- data/spec/models/gem_gem_repository_response_spec.rb +22 -21
- data/spec/models/gem_gem_repository_spec.rb +11 -16
- data/spec/models/my_permissions_response_spec.rb +7 -12
- data/spec/models/nested_role_response_spec.rb +9 -14
- data/spec/models/nested_role_spec.rb +9 -14
- data/spec/models/object_roles_response_spec.rb +7 -12
- data/spec/models/paginated_repository_version_response_list_spec.rb +10 -15
- data/spec/models/paginatedgem_gem_content_response_list_spec.rb +10 -15
- data/spec/models/paginatedgem_gem_distribution_response_list_spec.rb +10 -15
- data/spec/models/paginatedgem_gem_publication_response_list_spec.rb +10 -15
- data/spec/models/paginatedgem_gem_remote_response_list_spec.rb +10 -15
- data/spec/models/paginatedgem_gem_repository_response_list_spec.rb +10 -15
- data/spec/models/patchedgem_gem_distribution_spec.rb +14 -19
- data/spec/models/patchedgem_gem_remote_spec.rb +30 -35
- data/spec/models/patchedgem_gem_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_remove_content_spec.rb +9 -14
- data/spec/models/repository_sync_url_spec.rb +8 -13
- 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 +83 -63
- data/docs/GemGemContent.md +0 -21
- data/docs/GemGemRemoteResponseHiddenFields.md +0 -19
- data/lib/pulp_gem_client/models/gem_gem_content.rb +0 -228
- data/spec/api_client_spec.rb +0 -188
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/gem_gem_content_spec.rb +0 -53
data/docs/PublicationsGemApi.md
CHANGED
@@ -1,32 +1,31 @@
|
|
1
1
|
# PulpGemClient::PublicationsGemApi
|
2
2
|
|
3
|
-
All URIs are relative to *http://
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**add_role**](PublicationsGemApi.md#add_role) | **POST** {gem_gem_publication_href}add_role/ | Add a role
|
8
|
-
[**create**](PublicationsGemApi.md#create) | **POST** /pulp/api/v3/publications/gem/gem/ | Create a gem publication
|
9
|
-
[**delete**](PublicationsGemApi.md#delete) | **DELETE** {gem_gem_publication_href} | Delete a gem publication
|
10
|
-
[**list**](PublicationsGemApi.md#list) | **GET** /pulp/api/v3/publications/gem/gem/ | List gem publications
|
11
|
-
[**list_roles**](PublicationsGemApi.md#list_roles) | **GET** {gem_gem_publication_href}list_roles/ | List roles
|
12
|
-
[**my_permissions**](PublicationsGemApi.md#my_permissions) | **GET** {gem_gem_publication_href}my_permissions/ | List user permissions
|
13
|
-
[**read**](PublicationsGemApi.md#read) | **GET** {gem_gem_publication_href} | Inspect a gem publication
|
14
|
-
[**remove_role**](PublicationsGemApi.md#remove_role) | **POST** {gem_gem_publication_href}remove_role/ | Remove a role
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
15
4
|
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**add_role**](PublicationsGemApi.md#add_role) | **POST** {gem_gem_publication_href}add_role/ | Add a role |
|
8
|
+
| [**create**](PublicationsGemApi.md#create) | **POST** /pulp/api/v3/publications/gem/gem/ | Create a gem publication |
|
9
|
+
| [**delete**](PublicationsGemApi.md#delete) | **DELETE** {gem_gem_publication_href} | Delete a gem publication |
|
10
|
+
| [**list**](PublicationsGemApi.md#list) | **GET** /pulp/api/v3/publications/gem/gem/ | List gem publications |
|
11
|
+
| [**list_roles**](PublicationsGemApi.md#list_roles) | **GET** {gem_gem_publication_href}list_roles/ | List roles |
|
12
|
+
| [**my_permissions**](PublicationsGemApi.md#my_permissions) | **GET** {gem_gem_publication_href}my_permissions/ | List user permissions |
|
13
|
+
| [**read**](PublicationsGemApi.md#read) | **GET** {gem_gem_publication_href} | Inspect a gem publication |
|
14
|
+
| [**remove_role**](PublicationsGemApi.md#remove_role) | **POST** {gem_gem_publication_href}remove_role/ | Remove a role |
|
16
15
|
|
17
16
|
|
18
17
|
## add_role
|
19
18
|
|
20
|
-
> NestedRoleResponse add_role(gem_gem_publication_href, nested_role)
|
19
|
+
> <NestedRoleResponse> add_role(gem_gem_publication_href, nested_role)
|
21
20
|
|
22
21
|
Add a role
|
23
22
|
|
24
23
|
Add a role for this object to users/groups.
|
25
24
|
|
26
|
-
###
|
25
|
+
### Examples
|
27
26
|
|
28
27
|
```ruby
|
29
|
-
|
28
|
+
require 'time'
|
30
29
|
require 'pulp_gem_client'
|
31
30
|
# setup authorization
|
32
31
|
PulpGemClient.configure do |config|
|
@@ -37,24 +36,41 @@ end
|
|
37
36
|
|
38
37
|
api_instance = PulpGemClient::PublicationsGemApi.new
|
39
38
|
gem_gem_publication_href = 'gem_gem_publication_href_example' # String |
|
40
|
-
nested_role = PulpGemClient::NestedRole.new # NestedRole |
|
39
|
+
nested_role = PulpGemClient::NestedRole.new({role: 'role_example'}) # NestedRole |
|
41
40
|
|
42
41
|
begin
|
43
|
-
#Add a role
|
42
|
+
# Add a role
|
44
43
|
result = api_instance.add_role(gem_gem_publication_href, nested_role)
|
45
44
|
p result
|
46
45
|
rescue PulpGemClient::ApiError => e
|
47
|
-
puts "
|
46
|
+
puts "Error when calling PublicationsGemApi->add_role: #{e}"
|
48
47
|
end
|
49
48
|
```
|
50
49
|
|
51
|
-
|
50
|
+
#### Using the add_role_with_http_info variant
|
51
|
+
|
52
|
+
This returns an Array which contains the response data, status code and headers.
|
52
53
|
|
54
|
+
> <Array(<NestedRoleResponse>, Integer, Hash)> add_role_with_http_info(gem_gem_publication_href, nested_role)
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
begin
|
58
|
+
# Add a role
|
59
|
+
data, status_code, headers = api_instance.add_role_with_http_info(gem_gem_publication_href, nested_role)
|
60
|
+
p status_code # => 2xx
|
61
|
+
p headers # => { ... }
|
62
|
+
p data # => <NestedRoleResponse>
|
63
|
+
rescue PulpGemClient::ApiError => e
|
64
|
+
puts "Error when calling PublicationsGemApi->add_role_with_http_info: #{e}"
|
65
|
+
end
|
66
|
+
```
|
67
|
+
|
68
|
+
### Parameters
|
53
69
|
|
54
|
-
Name | Type | Description
|
55
|
-
|
56
|
-
**gem_gem_publication_href** | **String
|
57
|
-
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
70
|
+
| Name | Type | Description | Notes |
|
71
|
+
| ---- | ---- | ----------- | ----- |
|
72
|
+
| **gem_gem_publication_href** | **String** | | |
|
73
|
+
| **nested_role** | [**NestedRole**](NestedRole.md) | | |
|
58
74
|
|
59
75
|
### Return type
|
60
76
|
|
@@ -72,16 +88,16 @@ Name | Type | Description | Notes
|
|
72
88
|
|
73
89
|
## create
|
74
90
|
|
75
|
-
> AsyncOperationResponse create(gem_gem_publication)
|
91
|
+
> <AsyncOperationResponse> create(gem_gem_publication)
|
76
92
|
|
77
93
|
Create a gem publication
|
78
94
|
|
79
95
|
Trigger an asynchronous task to publish gem content
|
80
96
|
|
81
|
-
###
|
97
|
+
### Examples
|
82
98
|
|
83
99
|
```ruby
|
84
|
-
|
100
|
+
require 'time'
|
85
101
|
require 'pulp_gem_client'
|
86
102
|
# setup authorization
|
87
103
|
PulpGemClient.configure do |config|
|
@@ -94,20 +110,37 @@ api_instance = PulpGemClient::PublicationsGemApi.new
|
|
94
110
|
gem_gem_publication = PulpGemClient::GemGemPublication.new # GemGemPublication |
|
95
111
|
|
96
112
|
begin
|
97
|
-
#Create a gem publication
|
113
|
+
# Create a gem publication
|
98
114
|
result = api_instance.create(gem_gem_publication)
|
99
115
|
p result
|
100
116
|
rescue PulpGemClient::ApiError => e
|
101
|
-
puts "
|
117
|
+
puts "Error when calling PublicationsGemApi->create: #{e}"
|
102
118
|
end
|
103
119
|
```
|
104
120
|
|
105
|
-
|
121
|
+
#### Using the create_with_http_info variant
|
122
|
+
|
123
|
+
This returns an Array which contains the response data, status code and headers.
|
124
|
+
|
125
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> create_with_http_info(gem_gem_publication)
|
126
|
+
|
127
|
+
```ruby
|
128
|
+
begin
|
129
|
+
# Create a gem publication
|
130
|
+
data, status_code, headers = api_instance.create_with_http_info(gem_gem_publication)
|
131
|
+
p status_code # => 2xx
|
132
|
+
p headers # => { ... }
|
133
|
+
p data # => <AsyncOperationResponse>
|
134
|
+
rescue PulpGemClient::ApiError => e
|
135
|
+
puts "Error when calling PublicationsGemApi->create_with_http_info: #{e}"
|
136
|
+
end
|
137
|
+
```
|
106
138
|
|
139
|
+
### Parameters
|
107
140
|
|
108
|
-
Name | Type | Description
|
109
|
-
|
110
|
-
**gem_gem_publication** | [**GemGemPublication**](GemGemPublication.md)| |
|
141
|
+
| Name | Type | Description | Notes |
|
142
|
+
| ---- | ---- | ----------- | ----- |
|
143
|
+
| **gem_gem_publication** | [**GemGemPublication**](GemGemPublication.md) | | |
|
111
144
|
|
112
145
|
### Return type
|
113
146
|
|
@@ -131,10 +164,10 @@ Delete a gem publication
|
|
131
164
|
|
132
165
|
A ViewSet for GemPublication.
|
133
166
|
|
134
|
-
###
|
167
|
+
### Examples
|
135
168
|
|
136
169
|
```ruby
|
137
|
-
|
170
|
+
require 'time'
|
138
171
|
require 'pulp_gem_client'
|
139
172
|
# setup authorization
|
140
173
|
PulpGemClient.configure do |config|
|
@@ -147,19 +180,36 @@ api_instance = PulpGemClient::PublicationsGemApi.new
|
|
147
180
|
gem_gem_publication_href = 'gem_gem_publication_href_example' # String |
|
148
181
|
|
149
182
|
begin
|
150
|
-
#Delete a gem publication
|
183
|
+
# Delete a gem publication
|
151
184
|
api_instance.delete(gem_gem_publication_href)
|
152
185
|
rescue PulpGemClient::ApiError => e
|
153
|
-
puts "
|
186
|
+
puts "Error when calling PublicationsGemApi->delete: #{e}"
|
154
187
|
end
|
155
188
|
```
|
156
189
|
|
157
|
-
|
190
|
+
#### Using the delete_with_http_info variant
|
191
|
+
|
192
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
193
|
+
|
194
|
+
> <Array(nil, Integer, Hash)> delete_with_http_info(gem_gem_publication_href)
|
195
|
+
|
196
|
+
```ruby
|
197
|
+
begin
|
198
|
+
# Delete a gem publication
|
199
|
+
data, status_code, headers = api_instance.delete_with_http_info(gem_gem_publication_href)
|
200
|
+
p status_code # => 2xx
|
201
|
+
p headers # => { ... }
|
202
|
+
p data # => nil
|
203
|
+
rescue PulpGemClient::ApiError => e
|
204
|
+
puts "Error when calling PublicationsGemApi->delete_with_http_info: #{e}"
|
205
|
+
end
|
206
|
+
```
|
158
207
|
|
208
|
+
### Parameters
|
159
209
|
|
160
|
-
Name | Type | Description
|
161
|
-
|
162
|
-
**gem_gem_publication_href** | **String
|
210
|
+
| Name | Type | Description | Notes |
|
211
|
+
| ---- | ---- | ----------- | ----- |
|
212
|
+
| **gem_gem_publication_href** | **String** | | |
|
163
213
|
|
164
214
|
### Return type
|
165
215
|
|
@@ -177,16 +227,16 @@ nil (empty response body)
|
|
177
227
|
|
178
228
|
## list
|
179
229
|
|
180
|
-
> PaginatedgemGemPublicationResponseList list(opts)
|
230
|
+
> <PaginatedgemGemPublicationResponseList> list(opts)
|
181
231
|
|
182
232
|
List gem publications
|
183
233
|
|
184
234
|
A ViewSet for GemPublication.
|
185
235
|
|
186
|
-
###
|
236
|
+
### Examples
|
187
237
|
|
188
238
|
```ruby
|
189
|
-
|
239
|
+
require 'time'
|
190
240
|
require 'pulp_gem_client'
|
191
241
|
# setup authorization
|
192
242
|
PulpGemClient.configure do |config|
|
@@ -197,58 +247,79 @@ end
|
|
197
247
|
|
198
248
|
api_instance = PulpGemClient::PublicationsGemApi.new
|
199
249
|
opts = {
|
200
|
-
content: 'content_example', # String | Content Unit referenced by HREF
|
201
|
-
content__in: '
|
250
|
+
content: 'content_example', # String | Content Unit referenced by HREF/PRN
|
251
|
+
content__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
202
252
|
limit: 56, # Integer | Number of results to return per page.
|
203
253
|
offset: 56, # Integer | The initial index from which to return the results.
|
204
|
-
ordering: ['
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
|
209
|
-
|
210
|
-
|
211
|
-
|
212
|
-
|
213
|
-
|
214
|
-
|
215
|
-
|
216
|
-
|
217
|
-
|
254
|
+
ordering: ['-complete'], # 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) * `complete` - Complete * `-complete` - Complete (descending) * `pass_through` - Pass through * `-pass_through` - Pass through (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
255
|
+
prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
256
|
+
pulp_created: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_created matches value
|
257
|
+
pulp_created__gt: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_created is greater than value
|
258
|
+
pulp_created__gte: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_created is greater than or equal to value
|
259
|
+
pulp_created__isnull: true, # Boolean | Filter results where pulp_created has a null value
|
260
|
+
pulp_created__lt: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_created is less than value
|
261
|
+
pulp_created__lte: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_created is less than or equal to value
|
262
|
+
pulp_created__range: [Time.now], # Array<Time> | Filter results where pulp_created is between two comma separated values
|
263
|
+
pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
264
|
+
pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
265
|
+
q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
|
266
|
+
repository: 'repository_example', # String | Repository referenced by HREF/PRN
|
267
|
+
repository_version: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Repository Version referenced by HREF/PRN
|
268
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
269
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
218
270
|
}
|
219
271
|
|
220
272
|
begin
|
221
|
-
#List gem publications
|
273
|
+
# List gem publications
|
222
274
|
result = api_instance.list(opts)
|
223
275
|
p result
|
224
276
|
rescue PulpGemClient::ApiError => e
|
225
|
-
puts "
|
277
|
+
puts "Error when calling PublicationsGemApi->list: #{e}"
|
226
278
|
end
|
227
279
|
```
|
228
280
|
|
229
|
-
|
281
|
+
#### Using the list_with_http_info variant
|
282
|
+
|
283
|
+
This returns an Array which contains the response data, status code and headers.
|
284
|
+
|
285
|
+
> <Array(<PaginatedgemGemPublicationResponseList>, Integer, Hash)> list_with_http_info(opts)
|
286
|
+
|
287
|
+
```ruby
|
288
|
+
begin
|
289
|
+
# List gem publications
|
290
|
+
data, status_code, headers = api_instance.list_with_http_info(opts)
|
291
|
+
p status_code # => 2xx
|
292
|
+
p headers # => { ... }
|
293
|
+
p data # => <PaginatedgemGemPublicationResponseList>
|
294
|
+
rescue PulpGemClient::ApiError => e
|
295
|
+
puts "Error when calling PublicationsGemApi->list_with_http_info: #{e}"
|
296
|
+
end
|
297
|
+
```
|
230
298
|
|
299
|
+
### Parameters
|
231
300
|
|
232
|
-
Name | Type | Description
|
233
|
-
|
234
|
-
**content** | **String
|
235
|
-
**content__in** | **String
|
236
|
-
**limit** | **Integer
|
237
|
-
**offset** | **Integer
|
238
|
-
**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) * `complete` - Complete * `-complete` - Complete (descending) * `pass_through` - Pass through * `-pass_through` - Pass through (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
|
239
|
-
**
|
240
|
-
**
|
241
|
-
**
|
242
|
-
**
|
243
|
-
**
|
244
|
-
**
|
245
|
-
**
|
246
|
-
**
|
247
|
-
**
|
248
|
-
**
|
249
|
-
**
|
250
|
-
**
|
251
|
-
**
|
301
|
+
| Name | Type | Description | Notes |
|
302
|
+
| ---- | ---- | ----------- | ----- |
|
303
|
+
| **content** | **String** | Content Unit referenced by HREF/PRN | [optional] |
|
304
|
+
| **content__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
305
|
+
| **limit** | **Integer** | Number of results to return per page. | [optional] |
|
306
|
+
| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
|
307
|
+
| **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) * `complete` - Complete * `-complete` - Complete (descending) * `pass_through` - Pass through * `-pass_through` - Pass through (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] |
|
308
|
+
| **prn__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
309
|
+
| **pulp_created** | **Time** | Filter results where pulp_created matches value | [optional] |
|
310
|
+
| **pulp_created__gt** | **Time** | Filter results where pulp_created is greater than value | [optional] |
|
311
|
+
| **pulp_created__gte** | **Time** | Filter results where pulp_created is greater than or equal to value | [optional] |
|
312
|
+
| **pulp_created__isnull** | **Boolean** | Filter results where pulp_created has a null value | [optional] |
|
313
|
+
| **pulp_created__lt** | **Time** | Filter results where pulp_created is less than value | [optional] |
|
314
|
+
| **pulp_created__lte** | **Time** | Filter results where pulp_created is less than or equal to value | [optional] |
|
315
|
+
| **pulp_created__range** | [**Array<Time>**](Time.md) | Filter results where pulp_created is between two comma separated values | [optional] |
|
316
|
+
| **pulp_href__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
317
|
+
| **pulp_id__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
318
|
+
| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
|
319
|
+
| **repository** | **String** | Repository referenced by HREF/PRN | [optional] |
|
320
|
+
| **repository_version** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
321
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
322
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
252
323
|
|
253
324
|
### Return type
|
254
325
|
|
@@ -266,16 +337,16 @@ Name | Type | Description | Notes
|
|
266
337
|
|
267
338
|
## list_roles
|
268
339
|
|
269
|
-
> ObjectRolesResponse list_roles(gem_gem_publication_href, opts)
|
340
|
+
> <ObjectRolesResponse> list_roles(gem_gem_publication_href, opts)
|
270
341
|
|
271
342
|
List roles
|
272
343
|
|
273
344
|
List roles assigned to this object.
|
274
345
|
|
275
|
-
###
|
346
|
+
### Examples
|
276
347
|
|
277
348
|
```ruby
|
278
|
-
|
349
|
+
require 'time'
|
279
350
|
require 'pulp_gem_client'
|
280
351
|
# setup authorization
|
281
352
|
PulpGemClient.configure do |config|
|
@@ -287,27 +358,44 @@ end
|
|
287
358
|
api_instance = PulpGemClient::PublicationsGemApi.new
|
288
359
|
gem_gem_publication_href = 'gem_gem_publication_href_example' # String |
|
289
360
|
opts = {
|
290
|
-
fields: ['
|
291
|
-
exclude_fields: ['
|
361
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
362
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
292
363
|
}
|
293
364
|
|
294
365
|
begin
|
295
|
-
#List roles
|
366
|
+
# List roles
|
296
367
|
result = api_instance.list_roles(gem_gem_publication_href, opts)
|
297
368
|
p result
|
298
369
|
rescue PulpGemClient::ApiError => e
|
299
|
-
puts "
|
370
|
+
puts "Error when calling PublicationsGemApi->list_roles: #{e}"
|
300
371
|
end
|
301
372
|
```
|
302
373
|
|
303
|
-
|
374
|
+
#### Using the list_roles_with_http_info variant
|
375
|
+
|
376
|
+
This returns an Array which contains the response data, status code and headers.
|
377
|
+
|
378
|
+
> <Array(<ObjectRolesResponse>, Integer, Hash)> list_roles_with_http_info(gem_gem_publication_href, opts)
|
379
|
+
|
380
|
+
```ruby
|
381
|
+
begin
|
382
|
+
# List roles
|
383
|
+
data, status_code, headers = api_instance.list_roles_with_http_info(gem_gem_publication_href, opts)
|
384
|
+
p status_code # => 2xx
|
385
|
+
p headers # => { ... }
|
386
|
+
p data # => <ObjectRolesResponse>
|
387
|
+
rescue PulpGemClient::ApiError => e
|
388
|
+
puts "Error when calling PublicationsGemApi->list_roles_with_http_info: #{e}"
|
389
|
+
end
|
390
|
+
```
|
304
391
|
|
392
|
+
### Parameters
|
305
393
|
|
306
|
-
Name | Type | Description
|
307
|
-
|
308
|
-
**gem_gem_publication_href** | **String
|
309
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
310
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
394
|
+
| Name | Type | Description | Notes |
|
395
|
+
| ---- | ---- | ----------- | ----- |
|
396
|
+
| **gem_gem_publication_href** | **String** | | |
|
397
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
398
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
311
399
|
|
312
400
|
### Return type
|
313
401
|
|
@@ -325,16 +413,16 @@ Name | Type | Description | Notes
|
|
325
413
|
|
326
414
|
## my_permissions
|
327
415
|
|
328
|
-
> MyPermissionsResponse my_permissions(gem_gem_publication_href, opts)
|
416
|
+
> <MyPermissionsResponse> my_permissions(gem_gem_publication_href, opts)
|
329
417
|
|
330
418
|
List user permissions
|
331
419
|
|
332
420
|
List permissions available to the current user on this object.
|
333
421
|
|
334
|
-
###
|
422
|
+
### Examples
|
335
423
|
|
336
424
|
```ruby
|
337
|
-
|
425
|
+
require 'time'
|
338
426
|
require 'pulp_gem_client'
|
339
427
|
# setup authorization
|
340
428
|
PulpGemClient.configure do |config|
|
@@ -346,27 +434,44 @@ end
|
|
346
434
|
api_instance = PulpGemClient::PublicationsGemApi.new
|
347
435
|
gem_gem_publication_href = 'gem_gem_publication_href_example' # String |
|
348
436
|
opts = {
|
349
|
-
fields: ['
|
350
|
-
exclude_fields: ['
|
437
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
438
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
351
439
|
}
|
352
440
|
|
353
441
|
begin
|
354
|
-
#List user permissions
|
442
|
+
# List user permissions
|
355
443
|
result = api_instance.my_permissions(gem_gem_publication_href, opts)
|
356
444
|
p result
|
357
445
|
rescue PulpGemClient::ApiError => e
|
358
|
-
puts "
|
446
|
+
puts "Error when calling PublicationsGemApi->my_permissions: #{e}"
|
359
447
|
end
|
360
448
|
```
|
361
449
|
|
362
|
-
|
450
|
+
#### Using the my_permissions_with_http_info variant
|
451
|
+
|
452
|
+
This returns an Array which contains the response data, status code and headers.
|
453
|
+
|
454
|
+
> <Array(<MyPermissionsResponse>, Integer, Hash)> my_permissions_with_http_info(gem_gem_publication_href, opts)
|
455
|
+
|
456
|
+
```ruby
|
457
|
+
begin
|
458
|
+
# List user permissions
|
459
|
+
data, status_code, headers = api_instance.my_permissions_with_http_info(gem_gem_publication_href, opts)
|
460
|
+
p status_code # => 2xx
|
461
|
+
p headers # => { ... }
|
462
|
+
p data # => <MyPermissionsResponse>
|
463
|
+
rescue PulpGemClient::ApiError => e
|
464
|
+
puts "Error when calling PublicationsGemApi->my_permissions_with_http_info: #{e}"
|
465
|
+
end
|
466
|
+
```
|
363
467
|
|
468
|
+
### Parameters
|
364
469
|
|
365
|
-
Name | Type | Description
|
366
|
-
|
367
|
-
**gem_gem_publication_href** | **String
|
368
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
369
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
470
|
+
| Name | Type | Description | Notes |
|
471
|
+
| ---- | ---- | ----------- | ----- |
|
472
|
+
| **gem_gem_publication_href** | **String** | | |
|
473
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
474
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
370
475
|
|
371
476
|
### Return type
|
372
477
|
|
@@ -384,16 +489,16 @@ Name | Type | Description | Notes
|
|
384
489
|
|
385
490
|
## read
|
386
491
|
|
387
|
-
> GemGemPublicationResponse read(gem_gem_publication_href, opts)
|
492
|
+
> <GemGemPublicationResponse> read(gem_gem_publication_href, opts)
|
388
493
|
|
389
494
|
Inspect a gem publication
|
390
495
|
|
391
496
|
A ViewSet for GemPublication.
|
392
497
|
|
393
|
-
###
|
498
|
+
### Examples
|
394
499
|
|
395
500
|
```ruby
|
396
|
-
|
501
|
+
require 'time'
|
397
502
|
require 'pulp_gem_client'
|
398
503
|
# setup authorization
|
399
504
|
PulpGemClient.configure do |config|
|
@@ -405,27 +510,44 @@ end
|
|
405
510
|
api_instance = PulpGemClient::PublicationsGemApi.new
|
406
511
|
gem_gem_publication_href = 'gem_gem_publication_href_example' # String |
|
407
512
|
opts = {
|
408
|
-
fields: ['
|
409
|
-
exclude_fields: ['
|
513
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
514
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
410
515
|
}
|
411
516
|
|
412
517
|
begin
|
413
|
-
#Inspect a gem publication
|
518
|
+
# Inspect a gem publication
|
414
519
|
result = api_instance.read(gem_gem_publication_href, opts)
|
415
520
|
p result
|
416
521
|
rescue PulpGemClient::ApiError => e
|
417
|
-
puts "
|
522
|
+
puts "Error when calling PublicationsGemApi->read: #{e}"
|
418
523
|
end
|
419
524
|
```
|
420
525
|
|
421
|
-
|
526
|
+
#### Using the read_with_http_info variant
|
527
|
+
|
528
|
+
This returns an Array which contains the response data, status code and headers.
|
529
|
+
|
530
|
+
> <Array(<GemGemPublicationResponse>, Integer, Hash)> read_with_http_info(gem_gem_publication_href, opts)
|
531
|
+
|
532
|
+
```ruby
|
533
|
+
begin
|
534
|
+
# Inspect a gem publication
|
535
|
+
data, status_code, headers = api_instance.read_with_http_info(gem_gem_publication_href, opts)
|
536
|
+
p status_code # => 2xx
|
537
|
+
p headers # => { ... }
|
538
|
+
p data # => <GemGemPublicationResponse>
|
539
|
+
rescue PulpGemClient::ApiError => e
|
540
|
+
puts "Error when calling PublicationsGemApi->read_with_http_info: #{e}"
|
541
|
+
end
|
542
|
+
```
|
422
543
|
|
544
|
+
### Parameters
|
423
545
|
|
424
|
-
Name | Type | Description
|
425
|
-
|
426
|
-
**gem_gem_publication_href** | **String
|
427
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
428
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
546
|
+
| Name | Type | Description | Notes |
|
547
|
+
| ---- | ---- | ----------- | ----- |
|
548
|
+
| **gem_gem_publication_href** | **String** | | |
|
549
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
550
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
429
551
|
|
430
552
|
### Return type
|
431
553
|
|
@@ -443,16 +565,16 @@ Name | Type | Description | Notes
|
|
443
565
|
|
444
566
|
## remove_role
|
445
567
|
|
446
|
-
> NestedRoleResponse remove_role(gem_gem_publication_href, nested_role)
|
568
|
+
> <NestedRoleResponse> remove_role(gem_gem_publication_href, nested_role)
|
447
569
|
|
448
570
|
Remove a role
|
449
571
|
|
450
572
|
Remove a role for this object from users/groups.
|
451
573
|
|
452
|
-
###
|
574
|
+
### Examples
|
453
575
|
|
454
576
|
```ruby
|
455
|
-
|
577
|
+
require 'time'
|
456
578
|
require 'pulp_gem_client'
|
457
579
|
# setup authorization
|
458
580
|
PulpGemClient.configure do |config|
|
@@ -463,24 +585,41 @@ end
|
|
463
585
|
|
464
586
|
api_instance = PulpGemClient::PublicationsGemApi.new
|
465
587
|
gem_gem_publication_href = 'gem_gem_publication_href_example' # String |
|
466
|
-
nested_role = PulpGemClient::NestedRole.new # NestedRole |
|
588
|
+
nested_role = PulpGemClient::NestedRole.new({role: 'role_example'}) # NestedRole |
|
467
589
|
|
468
590
|
begin
|
469
|
-
#Remove a role
|
591
|
+
# Remove a role
|
470
592
|
result = api_instance.remove_role(gem_gem_publication_href, nested_role)
|
471
593
|
p result
|
472
594
|
rescue PulpGemClient::ApiError => e
|
473
|
-
puts "
|
595
|
+
puts "Error when calling PublicationsGemApi->remove_role: #{e}"
|
474
596
|
end
|
475
597
|
```
|
476
598
|
|
477
|
-
|
599
|
+
#### Using the remove_role_with_http_info variant
|
600
|
+
|
601
|
+
This returns an Array which contains the response data, status code and headers.
|
602
|
+
|
603
|
+
> <Array(<NestedRoleResponse>, Integer, Hash)> remove_role_with_http_info(gem_gem_publication_href, nested_role)
|
604
|
+
|
605
|
+
```ruby
|
606
|
+
begin
|
607
|
+
# Remove a role
|
608
|
+
data, status_code, headers = api_instance.remove_role_with_http_info(gem_gem_publication_href, nested_role)
|
609
|
+
p status_code # => 2xx
|
610
|
+
p headers # => { ... }
|
611
|
+
p data # => <NestedRoleResponse>
|
612
|
+
rescue PulpGemClient::ApiError => e
|
613
|
+
puts "Error when calling PublicationsGemApi->remove_role_with_http_info: #{e}"
|
614
|
+
end
|
615
|
+
```
|
478
616
|
|
617
|
+
### Parameters
|
479
618
|
|
480
|
-
Name | Type | Description
|
481
|
-
|
482
|
-
**gem_gem_publication_href** | **String
|
483
|
-
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
619
|
+
| Name | Type | Description | Notes |
|
620
|
+
| ---- | ---- | ----------- | ----- |
|
621
|
+
| **gem_gem_publication_href** | **String** | | |
|
622
|
+
| **nested_role** | [**NestedRole**](NestedRole.md) | | |
|
484
623
|
|
485
624
|
### Return type
|
486
625
|
|