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/RepositoriesGemApi.md
CHANGED
@@ -1,38 +1,37 @@
|
|
1
1
|
# PulpGemClient::RepositoriesGemApi
|
2
2
|
|
3
|
-
All URIs are relative to *http://
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**add_role**](RepositoriesGemApi.md#add_role) | **POST** {gem_gem_repository_href}add_role/ | Add a role
|
8
|
-
[**create**](RepositoriesGemApi.md#create) | **POST** /pulp/api/v3/repositories/gem/gem/ | Create a gem repository
|
9
|
-
[**delete**](RepositoriesGemApi.md#delete) | **DELETE** {gem_gem_repository_href} | Delete a gem repository
|
10
|
-
[**list**](RepositoriesGemApi.md#list) | **GET** /pulp/api/v3/repositories/gem/gem/ | List gem repositorys
|
11
|
-
[**list_roles**](RepositoriesGemApi.md#list_roles) | **GET** {gem_gem_repository_href}list_roles/ | List roles
|
12
|
-
[**modify**](RepositoriesGemApi.md#modify) | **POST** {gem_gem_repository_href}modify/ | Modify Repository Content
|
13
|
-
[**my_permissions**](RepositoriesGemApi.md#my_permissions) | **GET** {gem_gem_repository_href}my_permissions/ | List user permissions
|
14
|
-
[**partial_update**](RepositoriesGemApi.md#partial_update) | **PATCH** {gem_gem_repository_href} | Update a gem repository
|
15
|
-
[**read**](RepositoriesGemApi.md#read) | **GET** {gem_gem_repository_href} | Inspect a gem repository
|
16
|
-
[**remove_role**](RepositoriesGemApi.md#remove_role) | **POST** {gem_gem_repository_href}remove_role/ | Remove a role
|
17
|
-
[**set_label**](RepositoriesGemApi.md#set_label) | **POST** {gem_gem_repository_href}set_label/ | Set a label
|
18
|
-
[**sync**](RepositoriesGemApi.md#sync) | **POST** {gem_gem_repository_href}sync/ | Sync from a remote
|
19
|
-
[**unset_label**](RepositoriesGemApi.md#unset_label) | **POST** {gem_gem_repository_href}unset_label/ | Unset a label
|
20
|
-
[**update**](RepositoriesGemApi.md#update) | **PUT** {gem_gem_repository_href} | Update a gem repository
|
21
|
-
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**add_role**](RepositoriesGemApi.md#add_role) | **POST** {gem_gem_repository_href}add_role/ | Add a role |
|
8
|
+
| [**create**](RepositoriesGemApi.md#create) | **POST** /pulp/api/v3/repositories/gem/gem/ | Create a gem repository |
|
9
|
+
| [**delete**](RepositoriesGemApi.md#delete) | **DELETE** {gem_gem_repository_href} | Delete a gem repository |
|
10
|
+
| [**list**](RepositoriesGemApi.md#list) | **GET** /pulp/api/v3/repositories/gem/gem/ | List gem repositorys |
|
11
|
+
| [**list_roles**](RepositoriesGemApi.md#list_roles) | **GET** {gem_gem_repository_href}list_roles/ | List roles |
|
12
|
+
| [**modify**](RepositoriesGemApi.md#modify) | **POST** {gem_gem_repository_href}modify/ | Modify Repository Content |
|
13
|
+
| [**my_permissions**](RepositoriesGemApi.md#my_permissions) | **GET** {gem_gem_repository_href}my_permissions/ | List user permissions |
|
14
|
+
| [**partial_update**](RepositoriesGemApi.md#partial_update) | **PATCH** {gem_gem_repository_href} | Update a gem repository |
|
15
|
+
| [**read**](RepositoriesGemApi.md#read) | **GET** {gem_gem_repository_href} | Inspect a gem repository |
|
16
|
+
| [**remove_role**](RepositoriesGemApi.md#remove_role) | **POST** {gem_gem_repository_href}remove_role/ | Remove a role |
|
17
|
+
| [**set_label**](RepositoriesGemApi.md#set_label) | **POST** {gem_gem_repository_href}set_label/ | Set a label |
|
18
|
+
| [**sync**](RepositoriesGemApi.md#sync) | **POST** {gem_gem_repository_href}sync/ | Sync from a remote |
|
19
|
+
| [**unset_label**](RepositoriesGemApi.md#unset_label) | **POST** {gem_gem_repository_href}unset_label/ | Unset a label |
|
20
|
+
| [**update**](RepositoriesGemApi.md#update) | **PUT** {gem_gem_repository_href} | Update a gem repository |
|
22
21
|
|
23
22
|
|
24
23
|
## add_role
|
25
24
|
|
26
|
-
> NestedRoleResponse add_role(gem_gem_repository_href, nested_role)
|
25
|
+
> <NestedRoleResponse> add_role(gem_gem_repository_href, nested_role)
|
27
26
|
|
28
27
|
Add a role
|
29
28
|
|
30
29
|
Add a role for this object to users/groups.
|
31
30
|
|
32
|
-
###
|
31
|
+
### Examples
|
33
32
|
|
34
33
|
```ruby
|
35
|
-
|
34
|
+
require 'time'
|
36
35
|
require 'pulp_gem_client'
|
37
36
|
# setup authorization
|
38
37
|
PulpGemClient.configure do |config|
|
@@ -43,24 +42,41 @@ end
|
|
43
42
|
|
44
43
|
api_instance = PulpGemClient::RepositoriesGemApi.new
|
45
44
|
gem_gem_repository_href = 'gem_gem_repository_href_example' # String |
|
46
|
-
nested_role = PulpGemClient::NestedRole.new # NestedRole |
|
45
|
+
nested_role = PulpGemClient::NestedRole.new({role: 'role_example'}) # NestedRole |
|
47
46
|
|
48
47
|
begin
|
49
|
-
#Add a role
|
48
|
+
# Add a role
|
50
49
|
result = api_instance.add_role(gem_gem_repository_href, nested_role)
|
51
50
|
p result
|
52
51
|
rescue PulpGemClient::ApiError => e
|
53
|
-
puts "
|
52
|
+
puts "Error when calling RepositoriesGemApi->add_role: #{e}"
|
54
53
|
end
|
55
54
|
```
|
56
55
|
|
57
|
-
|
56
|
+
#### Using the add_role_with_http_info variant
|
57
|
+
|
58
|
+
This returns an Array which contains the response data, status code and headers.
|
59
|
+
|
60
|
+
> <Array(<NestedRoleResponse>, Integer, Hash)> add_role_with_http_info(gem_gem_repository_href, nested_role)
|
61
|
+
|
62
|
+
```ruby
|
63
|
+
begin
|
64
|
+
# Add a role
|
65
|
+
data, status_code, headers = api_instance.add_role_with_http_info(gem_gem_repository_href, nested_role)
|
66
|
+
p status_code # => 2xx
|
67
|
+
p headers # => { ... }
|
68
|
+
p data # => <NestedRoleResponse>
|
69
|
+
rescue PulpGemClient::ApiError => e
|
70
|
+
puts "Error when calling RepositoriesGemApi->add_role_with_http_info: #{e}"
|
71
|
+
end
|
72
|
+
```
|
58
73
|
|
74
|
+
### Parameters
|
59
75
|
|
60
|
-
Name | Type | Description
|
61
|
-
|
62
|
-
**gem_gem_repository_href** | **String
|
63
|
-
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
76
|
+
| Name | Type | Description | Notes |
|
77
|
+
| ---- | ---- | ----------- | ----- |
|
78
|
+
| **gem_gem_repository_href** | **String** | | |
|
79
|
+
| **nested_role** | [**NestedRole**](NestedRole.md) | | |
|
64
80
|
|
65
81
|
### Return type
|
66
82
|
|
@@ -78,16 +94,16 @@ Name | Type | Description | Notes
|
|
78
94
|
|
79
95
|
## create
|
80
96
|
|
81
|
-
> GemGemRepositoryResponse create(gem_gem_repository)
|
97
|
+
> <GemGemRepositoryResponse> create(gem_gem_repository)
|
82
98
|
|
83
99
|
Create a gem repository
|
84
100
|
|
85
101
|
A ViewSet for GemRepository.
|
86
102
|
|
87
|
-
###
|
103
|
+
### Examples
|
88
104
|
|
89
105
|
```ruby
|
90
|
-
|
106
|
+
require 'time'
|
91
107
|
require 'pulp_gem_client'
|
92
108
|
# setup authorization
|
93
109
|
PulpGemClient.configure do |config|
|
@@ -97,23 +113,40 @@ PulpGemClient.configure do |config|
|
|
97
113
|
end
|
98
114
|
|
99
115
|
api_instance = PulpGemClient::RepositoriesGemApi.new
|
100
|
-
gem_gem_repository = PulpGemClient::GemGemRepository.new # GemGemRepository |
|
116
|
+
gem_gem_repository = PulpGemClient::GemGemRepository.new({name: 'name_example'}) # GemGemRepository |
|
101
117
|
|
102
118
|
begin
|
103
|
-
#Create a gem repository
|
119
|
+
# Create a gem repository
|
104
120
|
result = api_instance.create(gem_gem_repository)
|
105
121
|
p result
|
106
122
|
rescue PulpGemClient::ApiError => e
|
107
|
-
puts "
|
123
|
+
puts "Error when calling RepositoriesGemApi->create: #{e}"
|
108
124
|
end
|
109
125
|
```
|
110
126
|
|
111
|
-
|
127
|
+
#### Using the create_with_http_info variant
|
128
|
+
|
129
|
+
This returns an Array which contains the response data, status code and headers.
|
130
|
+
|
131
|
+
> <Array(<GemGemRepositoryResponse>, Integer, Hash)> create_with_http_info(gem_gem_repository)
|
132
|
+
|
133
|
+
```ruby
|
134
|
+
begin
|
135
|
+
# Create a gem repository
|
136
|
+
data, status_code, headers = api_instance.create_with_http_info(gem_gem_repository)
|
137
|
+
p status_code # => 2xx
|
138
|
+
p headers # => { ... }
|
139
|
+
p data # => <GemGemRepositoryResponse>
|
140
|
+
rescue PulpGemClient::ApiError => e
|
141
|
+
puts "Error when calling RepositoriesGemApi->create_with_http_info: #{e}"
|
142
|
+
end
|
143
|
+
```
|
112
144
|
|
145
|
+
### Parameters
|
113
146
|
|
114
|
-
Name | Type | Description
|
115
|
-
|
116
|
-
**gem_gem_repository** | [**GemGemRepository**](GemGemRepository.md)| |
|
147
|
+
| Name | Type | Description | Notes |
|
148
|
+
| ---- | ---- | ----------- | ----- |
|
149
|
+
| **gem_gem_repository** | [**GemGemRepository**](GemGemRepository.md) | | |
|
117
150
|
|
118
151
|
### Return type
|
119
152
|
|
@@ -131,16 +164,16 @@ Name | Type | Description | Notes
|
|
131
164
|
|
132
165
|
## delete
|
133
166
|
|
134
|
-
> AsyncOperationResponse delete(gem_gem_repository_href)
|
167
|
+
> <AsyncOperationResponse> delete(gem_gem_repository_href)
|
135
168
|
|
136
169
|
Delete a gem repository
|
137
170
|
|
138
171
|
Trigger an asynchronous delete task
|
139
172
|
|
140
|
-
###
|
173
|
+
### Examples
|
141
174
|
|
142
175
|
```ruby
|
143
|
-
|
176
|
+
require 'time'
|
144
177
|
require 'pulp_gem_client'
|
145
178
|
# setup authorization
|
146
179
|
PulpGemClient.configure do |config|
|
@@ -153,20 +186,37 @@ api_instance = PulpGemClient::RepositoriesGemApi.new
|
|
153
186
|
gem_gem_repository_href = 'gem_gem_repository_href_example' # String |
|
154
187
|
|
155
188
|
begin
|
156
|
-
#Delete a gem repository
|
189
|
+
# Delete a gem repository
|
157
190
|
result = api_instance.delete(gem_gem_repository_href)
|
158
191
|
p result
|
159
192
|
rescue PulpGemClient::ApiError => e
|
160
|
-
puts "
|
193
|
+
puts "Error when calling RepositoriesGemApi->delete: #{e}"
|
161
194
|
end
|
162
195
|
```
|
163
196
|
|
164
|
-
|
197
|
+
#### Using the delete_with_http_info variant
|
198
|
+
|
199
|
+
This returns an Array which contains the response data, status code and headers.
|
200
|
+
|
201
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> delete_with_http_info(gem_gem_repository_href)
|
202
|
+
|
203
|
+
```ruby
|
204
|
+
begin
|
205
|
+
# Delete a gem repository
|
206
|
+
data, status_code, headers = api_instance.delete_with_http_info(gem_gem_repository_href)
|
207
|
+
p status_code # => 2xx
|
208
|
+
p headers # => { ... }
|
209
|
+
p data # => <AsyncOperationResponse>
|
210
|
+
rescue PulpGemClient::ApiError => e
|
211
|
+
puts "Error when calling RepositoriesGemApi->delete_with_http_info: #{e}"
|
212
|
+
end
|
213
|
+
```
|
165
214
|
|
215
|
+
### Parameters
|
166
216
|
|
167
|
-
Name | Type | Description
|
168
|
-
|
169
|
-
**gem_gem_repository_href** | **String
|
217
|
+
| Name | Type | Description | Notes |
|
218
|
+
| ---- | ---- | ----------- | ----- |
|
219
|
+
| **gem_gem_repository_href** | **String** | | |
|
170
220
|
|
171
221
|
### Return type
|
172
222
|
|
@@ -184,16 +234,16 @@ Name | Type | Description | Notes
|
|
184
234
|
|
185
235
|
## list
|
186
236
|
|
187
|
-
> PaginatedgemGemRepositoryResponseList list(opts)
|
237
|
+
> <PaginatedgemGemRepositoryResponseList> list(opts)
|
188
238
|
|
189
239
|
List gem repositorys
|
190
240
|
|
191
241
|
A ViewSet for GemRepository.
|
192
242
|
|
193
|
-
###
|
243
|
+
### Examples
|
194
244
|
|
195
245
|
```ruby
|
196
|
-
|
246
|
+
require 'time'
|
197
247
|
require 'pulp_gem_client'
|
198
248
|
# setup authorization
|
199
249
|
PulpGemClient.configure do |config|
|
@@ -204,24 +254,25 @@ end
|
|
204
254
|
|
205
255
|
api_instance = PulpGemClient::RepositoriesGemApi.new
|
206
256
|
opts = {
|
207
|
-
latest_with_content: 'latest_with_content_example', # String | Content Unit referenced by HREF
|
257
|
+
latest_with_content: 'latest_with_content_example', # String | Content Unit referenced by HREF/PRN
|
208
258
|
limit: 56, # Integer | Number of results to return per page.
|
209
259
|
name: 'name_example', # String | Filter results where name matches value
|
210
260
|
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
211
261
|
name__icontains: 'name__icontains_example', # String | Filter results where name contains value
|
212
262
|
name__iexact: 'name__iexact_example', # String | Filter results where name matches value
|
213
|
-
name__in: ['
|
263
|
+
name__in: ['inner_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
214
264
|
name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
|
215
265
|
name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
|
216
266
|
name__regex: 'name__regex_example', # String | Filter results where name matches regex value
|
217
267
|
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
|
218
268
|
offset: 56, # Integer | The initial index from which to return the results.
|
219
|
-
ordering: ['
|
220
|
-
|
221
|
-
|
269
|
+
ordering: ['-description'], # 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) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
270
|
+
prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
271
|
+
pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
272
|
+
pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
222
273
|
pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
|
223
|
-
q: 'q_example', # String |
|
224
|
-
remote: '
|
274
|
+
q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
|
275
|
+
remote: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Foreign Key referenced by HREF
|
225
276
|
retain_repo_versions: 56, # Integer | Filter results where retain_repo_versions matches value
|
226
277
|
retain_repo_versions__gt: 56, # Integer | Filter results where retain_repo_versions is greater than value
|
227
278
|
retain_repo_versions__gte: 56, # Integer | Filter results where retain_repo_versions is greater than or equal to value
|
@@ -229,55 +280,73 @@ opts = {
|
|
229
280
|
retain_repo_versions__lt: 56, # Integer | Filter results where retain_repo_versions is less than value
|
230
281
|
retain_repo_versions__lte: 56, # Integer | Filter results where retain_repo_versions is less than or equal to value
|
231
282
|
retain_repo_versions__ne: 56, # Integer | Filter results where retain_repo_versions not equal to value
|
232
|
-
retain_repo_versions__range: [
|
233
|
-
with_content: 'with_content_example', # String | Content Unit referenced by HREF
|
234
|
-
fields: ['
|
235
|
-
exclude_fields: ['
|
283
|
+
retain_repo_versions__range: [37], # Array<Integer> | Filter results where retain_repo_versions is between two comma separated values
|
284
|
+
with_content: 'with_content_example', # String | Content Unit referenced by HREF/PRN
|
285
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
286
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
236
287
|
}
|
237
288
|
|
238
289
|
begin
|
239
|
-
#List gem repositorys
|
290
|
+
# List gem repositorys
|
240
291
|
result = api_instance.list(opts)
|
241
292
|
p result
|
242
293
|
rescue PulpGemClient::ApiError => e
|
243
|
-
puts "
|
294
|
+
puts "Error when calling RepositoriesGemApi->list: #{e}"
|
244
295
|
end
|
245
296
|
```
|
246
297
|
|
247
|
-
|
298
|
+
#### Using the list_with_http_info variant
|
248
299
|
|
300
|
+
This returns an Array which contains the response data, status code and headers.
|
249
301
|
|
250
|
-
|
251
|
-
|
252
|
-
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
|
260
|
-
|
261
|
-
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
**
|
269
|
-
**
|
270
|
-
**
|
271
|
-
**
|
272
|
-
**
|
273
|
-
**
|
274
|
-
**
|
275
|
-
**
|
276
|
-
**
|
277
|
-
**
|
278
|
-
**
|
279
|
-
**
|
280
|
-
**
|
302
|
+
> <Array(<PaginatedgemGemRepositoryResponseList>, Integer, Hash)> list_with_http_info(opts)
|
303
|
+
|
304
|
+
```ruby
|
305
|
+
begin
|
306
|
+
# List gem repositorys
|
307
|
+
data, status_code, headers = api_instance.list_with_http_info(opts)
|
308
|
+
p status_code # => 2xx
|
309
|
+
p headers # => { ... }
|
310
|
+
p data # => <PaginatedgemGemRepositoryResponseList>
|
311
|
+
rescue PulpGemClient::ApiError => e
|
312
|
+
puts "Error when calling RepositoriesGemApi->list_with_http_info: #{e}"
|
313
|
+
end
|
314
|
+
```
|
315
|
+
|
316
|
+
### Parameters
|
317
|
+
|
318
|
+
| Name | Type | Description | Notes |
|
319
|
+
| ---- | ---- | ----------- | ----- |
|
320
|
+
| **latest_with_content** | **String** | Content Unit referenced by HREF/PRN | [optional] |
|
321
|
+
| **limit** | **Integer** | Number of results to return per page. | [optional] |
|
322
|
+
| **name** | **String** | Filter results where name matches value | [optional] |
|
323
|
+
| **name__contains** | **String** | Filter results where name contains value | [optional] |
|
324
|
+
| **name__icontains** | **String** | Filter results where name contains value | [optional] |
|
325
|
+
| **name__iexact** | **String** | Filter results where name matches value | [optional] |
|
326
|
+
| **name__in** | [**Array<String>**](String.md) | Filter results where name is in a comma-separated list of values | [optional] |
|
327
|
+
| **name__iregex** | **String** | Filter results where name matches regex value | [optional] |
|
328
|
+
| **name__istartswith** | **String** | Filter results where name starts with value | [optional] |
|
329
|
+
| **name__regex** | **String** | Filter results where name matches regex value | [optional] |
|
330
|
+
| **name__startswith** | **String** | Filter results where name starts with value | [optional] |
|
331
|
+
| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
|
332
|
+
| **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) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] |
|
333
|
+
| **prn__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
334
|
+
| **pulp_href__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
335
|
+
| **pulp_id__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
336
|
+
| **pulp_label_select** | **String** | Filter labels by search string | [optional] |
|
337
|
+
| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
|
338
|
+
| **remote** | **String** | Foreign Key referenced by HREF | [optional] |
|
339
|
+
| **retain_repo_versions** | **Integer** | Filter results where retain_repo_versions matches value | [optional] |
|
340
|
+
| **retain_repo_versions__gt** | **Integer** | Filter results where retain_repo_versions is greater than value | [optional] |
|
341
|
+
| **retain_repo_versions__gte** | **Integer** | Filter results where retain_repo_versions is greater than or equal to value | [optional] |
|
342
|
+
| **retain_repo_versions__isnull** | **Boolean** | Filter results where retain_repo_versions has a null value | [optional] |
|
343
|
+
| **retain_repo_versions__lt** | **Integer** | Filter results where retain_repo_versions is less than value | [optional] |
|
344
|
+
| **retain_repo_versions__lte** | **Integer** | Filter results where retain_repo_versions is less than or equal to value | [optional] |
|
345
|
+
| **retain_repo_versions__ne** | **Integer** | Filter results where retain_repo_versions not equal to value | [optional] |
|
346
|
+
| **retain_repo_versions__range** | [**Array<Integer>**](Integer.md) | Filter results where retain_repo_versions is between two comma separated values | [optional] |
|
347
|
+
| **with_content** | **String** | Content Unit referenced by HREF/PRN | [optional] |
|
348
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
349
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
281
350
|
|
282
351
|
### Return type
|
283
352
|
|
@@ -295,16 +364,16 @@ Name | Type | Description | Notes
|
|
295
364
|
|
296
365
|
## list_roles
|
297
366
|
|
298
|
-
> ObjectRolesResponse list_roles(gem_gem_repository_href, opts)
|
367
|
+
> <ObjectRolesResponse> list_roles(gem_gem_repository_href, opts)
|
299
368
|
|
300
369
|
List roles
|
301
370
|
|
302
371
|
List roles assigned to this object.
|
303
372
|
|
304
|
-
###
|
373
|
+
### Examples
|
305
374
|
|
306
375
|
```ruby
|
307
|
-
|
376
|
+
require 'time'
|
308
377
|
require 'pulp_gem_client'
|
309
378
|
# setup authorization
|
310
379
|
PulpGemClient.configure do |config|
|
@@ -316,27 +385,44 @@ end
|
|
316
385
|
api_instance = PulpGemClient::RepositoriesGemApi.new
|
317
386
|
gem_gem_repository_href = 'gem_gem_repository_href_example' # String |
|
318
387
|
opts = {
|
319
|
-
fields: ['
|
320
|
-
exclude_fields: ['
|
388
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
389
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
321
390
|
}
|
322
391
|
|
323
392
|
begin
|
324
|
-
#List roles
|
393
|
+
# List roles
|
325
394
|
result = api_instance.list_roles(gem_gem_repository_href, opts)
|
326
395
|
p result
|
327
396
|
rescue PulpGemClient::ApiError => e
|
328
|
-
puts "
|
397
|
+
puts "Error when calling RepositoriesGemApi->list_roles: #{e}"
|
329
398
|
end
|
330
399
|
```
|
331
400
|
|
332
|
-
|
401
|
+
#### Using the list_roles_with_http_info variant
|
402
|
+
|
403
|
+
This returns an Array which contains the response data, status code and headers.
|
404
|
+
|
405
|
+
> <Array(<ObjectRolesResponse>, Integer, Hash)> list_roles_with_http_info(gem_gem_repository_href, opts)
|
406
|
+
|
407
|
+
```ruby
|
408
|
+
begin
|
409
|
+
# List roles
|
410
|
+
data, status_code, headers = api_instance.list_roles_with_http_info(gem_gem_repository_href, opts)
|
411
|
+
p status_code # => 2xx
|
412
|
+
p headers # => { ... }
|
413
|
+
p data # => <ObjectRolesResponse>
|
414
|
+
rescue PulpGemClient::ApiError => e
|
415
|
+
puts "Error when calling RepositoriesGemApi->list_roles_with_http_info: #{e}"
|
416
|
+
end
|
417
|
+
```
|
333
418
|
|
419
|
+
### Parameters
|
334
420
|
|
335
|
-
Name | Type | Description
|
336
|
-
|
337
|
-
**gem_gem_repository_href** | **String
|
338
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
339
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
421
|
+
| Name | Type | Description | Notes |
|
422
|
+
| ---- | ---- | ----------- | ----- |
|
423
|
+
| **gem_gem_repository_href** | **String** | | |
|
424
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
425
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
340
426
|
|
341
427
|
### Return type
|
342
428
|
|
@@ -354,16 +440,16 @@ Name | Type | Description | Notes
|
|
354
440
|
|
355
441
|
## modify
|
356
442
|
|
357
|
-
> AsyncOperationResponse modify(gem_gem_repository_href, repository_add_remove_content)
|
443
|
+
> <AsyncOperationResponse> modify(gem_gem_repository_href, repository_add_remove_content)
|
358
444
|
|
359
445
|
Modify Repository Content
|
360
446
|
|
361
447
|
Trigger an asynchronous task to create a new repository version.
|
362
448
|
|
363
|
-
###
|
449
|
+
### Examples
|
364
450
|
|
365
451
|
```ruby
|
366
|
-
|
452
|
+
require 'time'
|
367
453
|
require 'pulp_gem_client'
|
368
454
|
# setup authorization
|
369
455
|
PulpGemClient.configure do |config|
|
@@ -377,21 +463,38 @@ gem_gem_repository_href = 'gem_gem_repository_href_example' # String |
|
|
377
463
|
repository_add_remove_content = PulpGemClient::RepositoryAddRemoveContent.new # RepositoryAddRemoveContent |
|
378
464
|
|
379
465
|
begin
|
380
|
-
#Modify Repository Content
|
466
|
+
# Modify Repository Content
|
381
467
|
result = api_instance.modify(gem_gem_repository_href, repository_add_remove_content)
|
382
468
|
p result
|
383
469
|
rescue PulpGemClient::ApiError => e
|
384
|
-
puts "
|
470
|
+
puts "Error when calling RepositoriesGemApi->modify: #{e}"
|
385
471
|
end
|
386
472
|
```
|
387
473
|
|
388
|
-
|
474
|
+
#### Using the modify_with_http_info variant
|
389
475
|
|
476
|
+
This returns an Array which contains the response data, status code and headers.
|
390
477
|
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
|
478
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> modify_with_http_info(gem_gem_repository_href, repository_add_remove_content)
|
479
|
+
|
480
|
+
```ruby
|
481
|
+
begin
|
482
|
+
# Modify Repository Content
|
483
|
+
data, status_code, headers = api_instance.modify_with_http_info(gem_gem_repository_href, repository_add_remove_content)
|
484
|
+
p status_code # => 2xx
|
485
|
+
p headers # => { ... }
|
486
|
+
p data # => <AsyncOperationResponse>
|
487
|
+
rescue PulpGemClient::ApiError => e
|
488
|
+
puts "Error when calling RepositoriesGemApi->modify_with_http_info: #{e}"
|
489
|
+
end
|
490
|
+
```
|
491
|
+
|
492
|
+
### Parameters
|
493
|
+
|
494
|
+
| Name | Type | Description | Notes |
|
495
|
+
| ---- | ---- | ----------- | ----- |
|
496
|
+
| **gem_gem_repository_href** | **String** | | |
|
497
|
+
| **repository_add_remove_content** | [**RepositoryAddRemoveContent**](RepositoryAddRemoveContent.md) | | |
|
395
498
|
|
396
499
|
### Return type
|
397
500
|
|
@@ -409,16 +512,16 @@ Name | Type | Description | Notes
|
|
409
512
|
|
410
513
|
## my_permissions
|
411
514
|
|
412
|
-
> MyPermissionsResponse my_permissions(gem_gem_repository_href, opts)
|
515
|
+
> <MyPermissionsResponse> my_permissions(gem_gem_repository_href, opts)
|
413
516
|
|
414
517
|
List user permissions
|
415
518
|
|
416
519
|
List permissions available to the current user on this object.
|
417
520
|
|
418
|
-
###
|
521
|
+
### Examples
|
419
522
|
|
420
523
|
```ruby
|
421
|
-
|
524
|
+
require 'time'
|
422
525
|
require 'pulp_gem_client'
|
423
526
|
# setup authorization
|
424
527
|
PulpGemClient.configure do |config|
|
@@ -430,27 +533,44 @@ end
|
|
430
533
|
api_instance = PulpGemClient::RepositoriesGemApi.new
|
431
534
|
gem_gem_repository_href = 'gem_gem_repository_href_example' # String |
|
432
535
|
opts = {
|
433
|
-
fields: ['
|
434
|
-
exclude_fields: ['
|
536
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
537
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
435
538
|
}
|
436
539
|
|
437
540
|
begin
|
438
|
-
#List user permissions
|
541
|
+
# List user permissions
|
439
542
|
result = api_instance.my_permissions(gem_gem_repository_href, opts)
|
440
543
|
p result
|
441
544
|
rescue PulpGemClient::ApiError => e
|
442
|
-
puts "
|
545
|
+
puts "Error when calling RepositoriesGemApi->my_permissions: #{e}"
|
443
546
|
end
|
444
547
|
```
|
445
548
|
|
446
|
-
|
549
|
+
#### Using the my_permissions_with_http_info variant
|
550
|
+
|
551
|
+
This returns an Array which contains the response data, status code and headers.
|
447
552
|
|
553
|
+
> <Array(<MyPermissionsResponse>, Integer, Hash)> my_permissions_with_http_info(gem_gem_repository_href, opts)
|
554
|
+
|
555
|
+
```ruby
|
556
|
+
begin
|
557
|
+
# List user permissions
|
558
|
+
data, status_code, headers = api_instance.my_permissions_with_http_info(gem_gem_repository_href, opts)
|
559
|
+
p status_code # => 2xx
|
560
|
+
p headers # => { ... }
|
561
|
+
p data # => <MyPermissionsResponse>
|
562
|
+
rescue PulpGemClient::ApiError => e
|
563
|
+
puts "Error when calling RepositoriesGemApi->my_permissions_with_http_info: #{e}"
|
564
|
+
end
|
565
|
+
```
|
566
|
+
|
567
|
+
### Parameters
|
448
568
|
|
449
|
-
Name | Type | Description
|
450
|
-
|
451
|
-
**gem_gem_repository_href** | **String
|
452
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
453
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
569
|
+
| Name | Type | Description | Notes |
|
570
|
+
| ---- | ---- | ----------- | ----- |
|
571
|
+
| **gem_gem_repository_href** | **String** | | |
|
572
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
573
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
454
574
|
|
455
575
|
### Return type
|
456
576
|
|
@@ -468,16 +588,16 @@ Name | Type | Description | Notes
|
|
468
588
|
|
469
589
|
## partial_update
|
470
590
|
|
471
|
-
> AsyncOperationResponse partial_update(gem_gem_repository_href, patchedgem_gem_repository)
|
591
|
+
> <AsyncOperationResponse> partial_update(gem_gem_repository_href, patchedgem_gem_repository)
|
472
592
|
|
473
593
|
Update a gem repository
|
474
594
|
|
475
595
|
Trigger an asynchronous partial update task
|
476
596
|
|
477
|
-
###
|
597
|
+
### Examples
|
478
598
|
|
479
599
|
```ruby
|
480
|
-
|
600
|
+
require 'time'
|
481
601
|
require 'pulp_gem_client'
|
482
602
|
# setup authorization
|
483
603
|
PulpGemClient.configure do |config|
|
@@ -491,21 +611,38 @@ gem_gem_repository_href = 'gem_gem_repository_href_example' # String |
|
|
491
611
|
patchedgem_gem_repository = PulpGemClient::PatchedgemGemRepository.new # PatchedgemGemRepository |
|
492
612
|
|
493
613
|
begin
|
494
|
-
#Update a gem repository
|
614
|
+
# Update a gem repository
|
495
615
|
result = api_instance.partial_update(gem_gem_repository_href, patchedgem_gem_repository)
|
496
616
|
p result
|
497
617
|
rescue PulpGemClient::ApiError => e
|
498
|
-
puts "
|
618
|
+
puts "Error when calling RepositoriesGemApi->partial_update: #{e}"
|
499
619
|
end
|
500
620
|
```
|
501
621
|
|
502
|
-
|
622
|
+
#### Using the partial_update_with_http_info variant
|
623
|
+
|
624
|
+
This returns an Array which contains the response data, status code and headers.
|
625
|
+
|
626
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> partial_update_with_http_info(gem_gem_repository_href, patchedgem_gem_repository)
|
627
|
+
|
628
|
+
```ruby
|
629
|
+
begin
|
630
|
+
# Update a gem repository
|
631
|
+
data, status_code, headers = api_instance.partial_update_with_http_info(gem_gem_repository_href, patchedgem_gem_repository)
|
632
|
+
p status_code # => 2xx
|
633
|
+
p headers # => { ... }
|
634
|
+
p data # => <AsyncOperationResponse>
|
635
|
+
rescue PulpGemClient::ApiError => e
|
636
|
+
puts "Error when calling RepositoriesGemApi->partial_update_with_http_info: #{e}"
|
637
|
+
end
|
638
|
+
```
|
503
639
|
|
640
|
+
### Parameters
|
504
641
|
|
505
|
-
Name | Type | Description
|
506
|
-
|
507
|
-
**gem_gem_repository_href** | **String
|
508
|
-
**patchedgem_gem_repository** | [**PatchedgemGemRepository**](PatchedgemGemRepository.md)| |
|
642
|
+
| Name | Type | Description | Notes |
|
643
|
+
| ---- | ---- | ----------- | ----- |
|
644
|
+
| **gem_gem_repository_href** | **String** | | |
|
645
|
+
| **patchedgem_gem_repository** | [**PatchedgemGemRepository**](PatchedgemGemRepository.md) | | |
|
509
646
|
|
510
647
|
### Return type
|
511
648
|
|
@@ -523,16 +660,16 @@ Name | Type | Description | Notes
|
|
523
660
|
|
524
661
|
## read
|
525
662
|
|
526
|
-
> GemGemRepositoryResponse read(gem_gem_repository_href, opts)
|
663
|
+
> <GemGemRepositoryResponse> read(gem_gem_repository_href, opts)
|
527
664
|
|
528
665
|
Inspect a gem repository
|
529
666
|
|
530
667
|
A ViewSet for GemRepository.
|
531
668
|
|
532
|
-
###
|
669
|
+
### Examples
|
533
670
|
|
534
671
|
```ruby
|
535
|
-
|
672
|
+
require 'time'
|
536
673
|
require 'pulp_gem_client'
|
537
674
|
# setup authorization
|
538
675
|
PulpGemClient.configure do |config|
|
@@ -544,27 +681,44 @@ end
|
|
544
681
|
api_instance = PulpGemClient::RepositoriesGemApi.new
|
545
682
|
gem_gem_repository_href = 'gem_gem_repository_href_example' # String |
|
546
683
|
opts = {
|
547
|
-
fields: ['
|
548
|
-
exclude_fields: ['
|
684
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
685
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
549
686
|
}
|
550
687
|
|
551
688
|
begin
|
552
|
-
#Inspect a gem repository
|
689
|
+
# Inspect a gem repository
|
553
690
|
result = api_instance.read(gem_gem_repository_href, opts)
|
554
691
|
p result
|
555
692
|
rescue PulpGemClient::ApiError => e
|
556
|
-
puts "
|
693
|
+
puts "Error when calling RepositoriesGemApi->read: #{e}"
|
557
694
|
end
|
558
695
|
```
|
559
696
|
|
560
|
-
|
697
|
+
#### Using the read_with_http_info variant
|
561
698
|
|
699
|
+
This returns an Array which contains the response data, status code and headers.
|
562
700
|
|
563
|
-
|
564
|
-
|
565
|
-
|
566
|
-
|
567
|
-
|
701
|
+
> <Array(<GemGemRepositoryResponse>, Integer, Hash)> read_with_http_info(gem_gem_repository_href, opts)
|
702
|
+
|
703
|
+
```ruby
|
704
|
+
begin
|
705
|
+
# Inspect a gem repository
|
706
|
+
data, status_code, headers = api_instance.read_with_http_info(gem_gem_repository_href, opts)
|
707
|
+
p status_code # => 2xx
|
708
|
+
p headers # => { ... }
|
709
|
+
p data # => <GemGemRepositoryResponse>
|
710
|
+
rescue PulpGemClient::ApiError => e
|
711
|
+
puts "Error when calling RepositoriesGemApi->read_with_http_info: #{e}"
|
712
|
+
end
|
713
|
+
```
|
714
|
+
|
715
|
+
### Parameters
|
716
|
+
|
717
|
+
| Name | Type | Description | Notes |
|
718
|
+
| ---- | ---- | ----------- | ----- |
|
719
|
+
| **gem_gem_repository_href** | **String** | | |
|
720
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
721
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
568
722
|
|
569
723
|
### Return type
|
570
724
|
|
@@ -582,16 +736,16 @@ Name | Type | Description | Notes
|
|
582
736
|
|
583
737
|
## remove_role
|
584
738
|
|
585
|
-
> NestedRoleResponse remove_role(gem_gem_repository_href, nested_role)
|
739
|
+
> <NestedRoleResponse> remove_role(gem_gem_repository_href, nested_role)
|
586
740
|
|
587
741
|
Remove a role
|
588
742
|
|
589
743
|
Remove a role for this object from users/groups.
|
590
744
|
|
591
|
-
###
|
745
|
+
### Examples
|
592
746
|
|
593
747
|
```ruby
|
594
|
-
|
748
|
+
require 'time'
|
595
749
|
require 'pulp_gem_client'
|
596
750
|
# setup authorization
|
597
751
|
PulpGemClient.configure do |config|
|
@@ -602,24 +756,41 @@ end
|
|
602
756
|
|
603
757
|
api_instance = PulpGemClient::RepositoriesGemApi.new
|
604
758
|
gem_gem_repository_href = 'gem_gem_repository_href_example' # String |
|
605
|
-
nested_role = PulpGemClient::NestedRole.new # NestedRole |
|
759
|
+
nested_role = PulpGemClient::NestedRole.new({role: 'role_example'}) # NestedRole |
|
606
760
|
|
607
761
|
begin
|
608
|
-
#Remove a role
|
762
|
+
# Remove a role
|
609
763
|
result = api_instance.remove_role(gem_gem_repository_href, nested_role)
|
610
764
|
p result
|
611
765
|
rescue PulpGemClient::ApiError => e
|
612
|
-
puts "
|
766
|
+
puts "Error when calling RepositoriesGemApi->remove_role: #{e}"
|
613
767
|
end
|
614
768
|
```
|
615
769
|
|
616
|
-
|
770
|
+
#### Using the remove_role_with_http_info variant
|
617
771
|
|
772
|
+
This returns an Array which contains the response data, status code and headers.
|
618
773
|
|
619
|
-
|
620
|
-
|
621
|
-
|
622
|
-
|
774
|
+
> <Array(<NestedRoleResponse>, Integer, Hash)> remove_role_with_http_info(gem_gem_repository_href, nested_role)
|
775
|
+
|
776
|
+
```ruby
|
777
|
+
begin
|
778
|
+
# Remove a role
|
779
|
+
data, status_code, headers = api_instance.remove_role_with_http_info(gem_gem_repository_href, nested_role)
|
780
|
+
p status_code # => 2xx
|
781
|
+
p headers # => { ... }
|
782
|
+
p data # => <NestedRoleResponse>
|
783
|
+
rescue PulpGemClient::ApiError => e
|
784
|
+
puts "Error when calling RepositoriesGemApi->remove_role_with_http_info: #{e}"
|
785
|
+
end
|
786
|
+
```
|
787
|
+
|
788
|
+
### Parameters
|
789
|
+
|
790
|
+
| Name | Type | Description | Notes |
|
791
|
+
| ---- | ---- | ----------- | ----- |
|
792
|
+
| **gem_gem_repository_href** | **String** | | |
|
793
|
+
| **nested_role** | [**NestedRole**](NestedRole.md) | | |
|
623
794
|
|
624
795
|
### Return type
|
625
796
|
|
@@ -637,16 +808,16 @@ Name | Type | Description | Notes
|
|
637
808
|
|
638
809
|
## set_label
|
639
810
|
|
640
|
-
> SetLabelResponse set_label(gem_gem_repository_href, set_label)
|
811
|
+
> <SetLabelResponse> set_label(gem_gem_repository_href, set_label)
|
641
812
|
|
642
813
|
Set a label
|
643
814
|
|
644
815
|
Set a single pulp_label on the object to a specific value or null.
|
645
816
|
|
646
|
-
###
|
817
|
+
### Examples
|
647
818
|
|
648
819
|
```ruby
|
649
|
-
|
820
|
+
require 'time'
|
650
821
|
require 'pulp_gem_client'
|
651
822
|
# setup authorization
|
652
823
|
PulpGemClient.configure do |config|
|
@@ -657,24 +828,41 @@ end
|
|
657
828
|
|
658
829
|
api_instance = PulpGemClient::RepositoriesGemApi.new
|
659
830
|
gem_gem_repository_href = 'gem_gem_repository_href_example' # String |
|
660
|
-
set_label = PulpGemClient::SetLabel.new # SetLabel |
|
831
|
+
set_label = PulpGemClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel |
|
661
832
|
|
662
833
|
begin
|
663
|
-
#Set a label
|
834
|
+
# Set a label
|
664
835
|
result = api_instance.set_label(gem_gem_repository_href, set_label)
|
665
836
|
p result
|
666
837
|
rescue PulpGemClient::ApiError => e
|
667
|
-
puts "
|
838
|
+
puts "Error when calling RepositoriesGemApi->set_label: #{e}"
|
668
839
|
end
|
669
840
|
```
|
670
841
|
|
671
|
-
|
842
|
+
#### Using the set_label_with_http_info variant
|
843
|
+
|
844
|
+
This returns an Array which contains the response data, status code and headers.
|
845
|
+
|
846
|
+
> <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(gem_gem_repository_href, set_label)
|
847
|
+
|
848
|
+
```ruby
|
849
|
+
begin
|
850
|
+
# Set a label
|
851
|
+
data, status_code, headers = api_instance.set_label_with_http_info(gem_gem_repository_href, set_label)
|
852
|
+
p status_code # => 2xx
|
853
|
+
p headers # => { ... }
|
854
|
+
p data # => <SetLabelResponse>
|
855
|
+
rescue PulpGemClient::ApiError => e
|
856
|
+
puts "Error when calling RepositoriesGemApi->set_label_with_http_info: #{e}"
|
857
|
+
end
|
858
|
+
```
|
672
859
|
|
860
|
+
### Parameters
|
673
861
|
|
674
|
-
Name | Type | Description
|
675
|
-
|
676
|
-
**gem_gem_repository_href** | **String
|
677
|
-
**set_label** | [**SetLabel**](SetLabel.md)| |
|
862
|
+
| Name | Type | Description | Notes |
|
863
|
+
| ---- | ---- | ----------- | ----- |
|
864
|
+
| **gem_gem_repository_href** | **String** | | |
|
865
|
+
| **set_label** | [**SetLabel**](SetLabel.md) | | |
|
678
866
|
|
679
867
|
### Return type
|
680
868
|
|
@@ -692,16 +880,16 @@ Name | Type | Description | Notes
|
|
692
880
|
|
693
881
|
## sync
|
694
882
|
|
695
|
-
> AsyncOperationResponse sync(gem_gem_repository_href, repository_sync_url)
|
883
|
+
> <AsyncOperationResponse> sync(gem_gem_repository_href, repository_sync_url)
|
696
884
|
|
697
885
|
Sync from a remote
|
698
886
|
|
699
887
|
Trigger an asynchronous task to sync gem content.
|
700
888
|
|
701
|
-
###
|
889
|
+
### Examples
|
702
890
|
|
703
891
|
```ruby
|
704
|
-
|
892
|
+
require 'time'
|
705
893
|
require 'pulp_gem_client'
|
706
894
|
# setup authorization
|
707
895
|
PulpGemClient.configure do |config|
|
@@ -715,21 +903,38 @@ gem_gem_repository_href = 'gem_gem_repository_href_example' # String |
|
|
715
903
|
repository_sync_url = PulpGemClient::RepositorySyncURL.new # RepositorySyncURL |
|
716
904
|
|
717
905
|
begin
|
718
|
-
#Sync from a remote
|
906
|
+
# Sync from a remote
|
719
907
|
result = api_instance.sync(gem_gem_repository_href, repository_sync_url)
|
720
908
|
p result
|
721
909
|
rescue PulpGemClient::ApiError => e
|
722
|
-
puts "
|
910
|
+
puts "Error when calling RepositoriesGemApi->sync: #{e}"
|
723
911
|
end
|
724
912
|
```
|
725
913
|
|
726
|
-
|
914
|
+
#### Using the sync_with_http_info variant
|
915
|
+
|
916
|
+
This returns an Array which contains the response data, status code and headers.
|
917
|
+
|
918
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> sync_with_http_info(gem_gem_repository_href, repository_sync_url)
|
919
|
+
|
920
|
+
```ruby
|
921
|
+
begin
|
922
|
+
# Sync from a remote
|
923
|
+
data, status_code, headers = api_instance.sync_with_http_info(gem_gem_repository_href, repository_sync_url)
|
924
|
+
p status_code # => 2xx
|
925
|
+
p headers # => { ... }
|
926
|
+
p data # => <AsyncOperationResponse>
|
927
|
+
rescue PulpGemClient::ApiError => e
|
928
|
+
puts "Error when calling RepositoriesGemApi->sync_with_http_info: #{e}"
|
929
|
+
end
|
930
|
+
```
|
727
931
|
|
932
|
+
### Parameters
|
728
933
|
|
729
|
-
Name | Type | Description
|
730
|
-
|
731
|
-
**gem_gem_repository_href** | **String
|
732
|
-
**repository_sync_url** | [**RepositorySyncURL**](RepositorySyncURL.md)| |
|
934
|
+
| Name | Type | Description | Notes |
|
935
|
+
| ---- | ---- | ----------- | ----- |
|
936
|
+
| **gem_gem_repository_href** | **String** | | |
|
937
|
+
| **repository_sync_url** | [**RepositorySyncURL**](RepositorySyncURL.md) | | |
|
733
938
|
|
734
939
|
### Return type
|
735
940
|
|
@@ -747,16 +952,16 @@ Name | Type | Description | Notes
|
|
747
952
|
|
748
953
|
## unset_label
|
749
954
|
|
750
|
-
> UnsetLabelResponse unset_label(gem_gem_repository_href, unset_label)
|
955
|
+
> <UnsetLabelResponse> unset_label(gem_gem_repository_href, unset_label)
|
751
956
|
|
752
957
|
Unset a label
|
753
958
|
|
754
959
|
Unset a single pulp_label on the object.
|
755
960
|
|
756
|
-
###
|
961
|
+
### Examples
|
757
962
|
|
758
963
|
```ruby
|
759
|
-
|
964
|
+
require 'time'
|
760
965
|
require 'pulp_gem_client'
|
761
966
|
# setup authorization
|
762
967
|
PulpGemClient.configure do |config|
|
@@ -767,24 +972,41 @@ end
|
|
767
972
|
|
768
973
|
api_instance = PulpGemClient::RepositoriesGemApi.new
|
769
974
|
gem_gem_repository_href = 'gem_gem_repository_href_example' # String |
|
770
|
-
unset_label = PulpGemClient::UnsetLabel.new # UnsetLabel |
|
975
|
+
unset_label = PulpGemClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel |
|
771
976
|
|
772
977
|
begin
|
773
|
-
#Unset a label
|
978
|
+
# Unset a label
|
774
979
|
result = api_instance.unset_label(gem_gem_repository_href, unset_label)
|
775
980
|
p result
|
776
981
|
rescue PulpGemClient::ApiError => e
|
777
|
-
puts "
|
982
|
+
puts "Error when calling RepositoriesGemApi->unset_label: #{e}"
|
778
983
|
end
|
779
984
|
```
|
780
985
|
|
781
|
-
|
986
|
+
#### Using the unset_label_with_http_info variant
|
782
987
|
|
988
|
+
This returns an Array which contains the response data, status code and headers.
|
783
989
|
|
784
|
-
|
785
|
-
|
786
|
-
|
787
|
-
|
990
|
+
> <Array(<UnsetLabelResponse>, Integer, Hash)> unset_label_with_http_info(gem_gem_repository_href, unset_label)
|
991
|
+
|
992
|
+
```ruby
|
993
|
+
begin
|
994
|
+
# Unset a label
|
995
|
+
data, status_code, headers = api_instance.unset_label_with_http_info(gem_gem_repository_href, unset_label)
|
996
|
+
p status_code # => 2xx
|
997
|
+
p headers # => { ... }
|
998
|
+
p data # => <UnsetLabelResponse>
|
999
|
+
rescue PulpGemClient::ApiError => e
|
1000
|
+
puts "Error when calling RepositoriesGemApi->unset_label_with_http_info: #{e}"
|
1001
|
+
end
|
1002
|
+
```
|
1003
|
+
|
1004
|
+
### Parameters
|
1005
|
+
|
1006
|
+
| Name | Type | Description | Notes |
|
1007
|
+
| ---- | ---- | ----------- | ----- |
|
1008
|
+
| **gem_gem_repository_href** | **String** | | |
|
1009
|
+
| **unset_label** | [**UnsetLabel**](UnsetLabel.md) | | |
|
788
1010
|
|
789
1011
|
### Return type
|
790
1012
|
|
@@ -802,16 +1024,16 @@ Name | Type | Description | Notes
|
|
802
1024
|
|
803
1025
|
## update
|
804
1026
|
|
805
|
-
> AsyncOperationResponse update(gem_gem_repository_href, gem_gem_repository)
|
1027
|
+
> <AsyncOperationResponse> update(gem_gem_repository_href, gem_gem_repository)
|
806
1028
|
|
807
1029
|
Update a gem repository
|
808
1030
|
|
809
1031
|
Trigger an asynchronous update task
|
810
1032
|
|
811
|
-
###
|
1033
|
+
### Examples
|
812
1034
|
|
813
1035
|
```ruby
|
814
|
-
|
1036
|
+
require 'time'
|
815
1037
|
require 'pulp_gem_client'
|
816
1038
|
# setup authorization
|
817
1039
|
PulpGemClient.configure do |config|
|
@@ -822,24 +1044,41 @@ end
|
|
822
1044
|
|
823
1045
|
api_instance = PulpGemClient::RepositoriesGemApi.new
|
824
1046
|
gem_gem_repository_href = 'gem_gem_repository_href_example' # String |
|
825
|
-
gem_gem_repository = PulpGemClient::GemGemRepository.new # GemGemRepository |
|
1047
|
+
gem_gem_repository = PulpGemClient::GemGemRepository.new({name: 'name_example'}) # GemGemRepository |
|
826
1048
|
|
827
1049
|
begin
|
828
|
-
#Update a gem repository
|
1050
|
+
# Update a gem repository
|
829
1051
|
result = api_instance.update(gem_gem_repository_href, gem_gem_repository)
|
830
1052
|
p result
|
831
1053
|
rescue PulpGemClient::ApiError => e
|
832
|
-
puts "
|
1054
|
+
puts "Error when calling RepositoriesGemApi->update: #{e}"
|
833
1055
|
end
|
834
1056
|
```
|
835
1057
|
|
836
|
-
|
1058
|
+
#### Using the update_with_http_info variant
|
1059
|
+
|
1060
|
+
This returns an Array which contains the response data, status code and headers.
|
837
1061
|
|
1062
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> update_with_http_info(gem_gem_repository_href, gem_gem_repository)
|
1063
|
+
|
1064
|
+
```ruby
|
1065
|
+
begin
|
1066
|
+
# Update a gem repository
|
1067
|
+
data, status_code, headers = api_instance.update_with_http_info(gem_gem_repository_href, gem_gem_repository)
|
1068
|
+
p status_code # => 2xx
|
1069
|
+
p headers # => { ... }
|
1070
|
+
p data # => <AsyncOperationResponse>
|
1071
|
+
rescue PulpGemClient::ApiError => e
|
1072
|
+
puts "Error when calling RepositoriesGemApi->update_with_http_info: #{e}"
|
1073
|
+
end
|
1074
|
+
```
|
1075
|
+
|
1076
|
+
### Parameters
|
838
1077
|
|
839
|
-
Name | Type | Description
|
840
|
-
|
841
|
-
**gem_gem_repository_href** | **String
|
842
|
-
**gem_gem_repository** | [**GemGemRepository**](GemGemRepository.md)| |
|
1078
|
+
| Name | Type | Description | Notes |
|
1079
|
+
| ---- | ---- | ----------- | ----- |
|
1080
|
+
| **gem_gem_repository_href** | **String** | | |
|
1081
|
+
| **gem_gem_repository** | [**GemGemRepository**](GemGemRepository.md) | | |
|
843
1082
|
|
844
1083
|
### Return type
|
845
1084
|
|