pulp_python_client 3.12.5 → 3.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +17 -16
- data/docs/AsyncOperationResponse.md +8 -7
- data/docs/ContentPackagesApi.md +170 -120
- data/docs/ContentSummaryResponse.md +12 -11
- data/docs/DistributionsPypiApi.md +385 -182
- data/docs/ExcludePlatformsEnum.md +4 -5
- 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/PackageMetadataResponse.md +14 -13
- data/docs/PackageTypesEnum.md +4 -5
- data/docs/PackageUploadTaskResponse.md +12 -11
- data/docs/PaginatedRepositoryVersionResponseList.md +14 -13
- data/docs/PaginatedpythonPythonDistributionResponseList.md +14 -13
- data/docs/PaginatedpythonPythonPackageContentResponseList.md +14 -13
- data/docs/PaginatedpythonPythonPublicationResponseList.md +14 -13
- data/docs/PaginatedpythonPythonRemoteResponseList.md +14 -13
- data/docs/PaginatedpythonPythonRepositoryResponseList.md +14 -13
- data/docs/PatchedpythonPythonDistribution.md +24 -23
- data/docs/PatchedpythonPythonRemote.md +60 -59
- data/docs/PatchedpythonPythonRepository.md +18 -17
- data/docs/PolicyEnum.md +4 -5
- data/docs/PublicationsPypiApi.md +267 -130
- data/docs/PypiApi.md +33 -17
- data/docs/PypiLegacyApi.md +34 -18
- data/docs/PypiMetadataApi.md +34 -18
- data/docs/PypiSimpleApi.md +95 -45
- data/docs/PythonPythonDistribution.md +24 -23
- data/docs/PythonPythonDistributionResponse.md +36 -35
- data/docs/PythonPythonPackageContentResponse.md +70 -69
- data/docs/PythonPythonPublication.md +10 -9
- data/docs/PythonPythonPublicationResponse.md +20 -19
- data/docs/PythonPythonRemote.md +60 -59
- data/docs/PythonPythonRemoteResponse.md +60 -59
- data/docs/PythonPythonRemoteResponseHiddenFieldsInner.md +20 -0
- data/docs/PythonPythonRepository.md +18 -17
- data/docs/PythonPythonRepositoryResponse.md +30 -29
- data/docs/RemotesPythonApi.md +420 -198
- data/docs/Repair.md +8 -7
- data/docs/RepositoriesPythonApi.md +444 -207
- data/docs/RepositoriesPythonVersionsApi.md +152 -82
- data/docs/RepositoryAddRemoveContent.md +12 -11
- data/docs/RepositorySyncURL.md +10 -9
- data/docs/RepositoryVersionResponse.md +22 -21
- data/docs/SetLabel.md +10 -9
- data/docs/SetLabelResponse.md +10 -9
- data/docs/SummaryResponse.md +12 -11
- data/docs/UnsetLabel.md +8 -7
- data/docs/UnsetLabelResponse.md +10 -9
- data/lib/pulp_python_client/api/content_packages_api.rb +21 -15
- data/lib/pulp_python_client/api/distributions_pypi_api.rb +89 -56
- data/lib/pulp_python_client/api/publications_pypi_api.rb +67 -47
- data/lib/pulp_python_client/api/pypi_api.rb +6 -5
- data/lib/pulp_python_client/api/pypi_legacy_api.rb +11 -7
- data/lib/pulp_python_client/api/pypi_metadata_api.rb +6 -5
- data/lib/pulp_python_client/api/pypi_simple_api.rb +19 -13
- data/lib/pulp_python_client/api/remotes_python_api.rb +113 -73
- data/lib/pulp_python_client/api/repositories_python_api.rb +107 -66
- data/lib/pulp_python_client/api/repositories_python_versions_api.rb +40 -30
- data/lib/pulp_python_client/api_client.rb +137 -102
- data/lib/pulp_python_client/api_error.rb +2 -1
- data/lib/pulp_python_client/configuration.rb +162 -21
- data/lib/pulp_python_client/models/async_operation_response.rb +32 -22
- data/lib/pulp_python_client/models/content_summary_response.rb +36 -22
- data/lib/pulp_python_client/models/exclude_platforms_enum.rb +8 -4
- data/lib/pulp_python_client/models/my_permissions_response.rb +32 -22
- data/lib/pulp_python_client/models/nested_role.rb +32 -22
- data/lib/pulp_python_client/models/nested_role_response.rb +32 -22
- data/lib/pulp_python_client/models/object_roles_response.rb +32 -22
- data/lib/pulp_python_client/models/package_metadata_response.rb +41 -37
- data/lib/pulp_python_client/models/package_types_enum.rb +8 -4
- data/lib/pulp_python_client/models/package_upload_task_response.rb +37 -23
- data/lib/pulp_python_client/models/paginated_repository_version_response_list.rb +34 -22
- data/lib/pulp_python_client/models/paginatedpython_python_distribution_response_list.rb +34 -22
- data/lib/pulp_python_client/models/paginatedpython_python_package_content_response_list.rb +34 -22
- data/lib/pulp_python_client/models/paginatedpython_python_publication_response_list.rb +34 -22
- data/lib/pulp_python_client/models/paginatedpython_python_remote_response_list.rb +34 -22
- data/lib/pulp_python_client/models/paginatedpython_python_repository_response_list.rb +34 -22
- data/lib/pulp_python_client/models/patchedpython_python_distribution.rb +40 -24
- data/lib/pulp_python_client/models/patchedpython_python_remote.rb +82 -44
- data/lib/pulp_python_client/models/patchedpython_python_repository.rb +35 -23
- data/lib/pulp_python_client/models/policy_enum.rb +8 -4
- data/lib/pulp_python_client/models/python_python_distribution.rb +34 -22
- data/lib/pulp_python_client/models/python_python_distribution_response.rb +36 -24
- data/lib/pulp_python_client/models/python_python_package_content_response.rb +38 -24
- data/lib/pulp_python_client/models/python_python_publication.rb +30 -22
- data/lib/pulp_python_client/models/python_python_publication_response.rb +32 -24
- data/lib/pulp_python_client/models/python_python_remote.rb +76 -42
- data/lib/pulp_python_client/models/python_python_remote_response.rb +79 -45
- data/lib/pulp_python_client/models/{python_python_remote_response_hidden_fields.rb → python_python_remote_response_hidden_fields_inner.rb} +37 -25
- data/lib/pulp_python_client/models/python_python_repository.rb +32 -22
- data/lib/pulp_python_client/models/python_python_repository_response.rb +34 -24
- data/lib/pulp_python_client/models/repair.rb +30 -22
- data/lib/pulp_python_client/models/repository_add_remove_content.rb +30 -22
- data/lib/pulp_python_client/models/repository_sync_url.rb +30 -22
- data/lib/pulp_python_client/models/repository_version_response.rb +32 -24
- data/lib/pulp_python_client/models/set_label.rb +34 -22
- data/lib/pulp_python_client/models/set_label_response.rb +34 -22
- data/lib/pulp_python_client/models/summary_response.rb +36 -22
- data/lib/pulp_python_client/models/unset_label.rb +32 -22
- data/lib/pulp_python_client/models/unset_label_response.rb +32 -22
- data/lib/pulp_python_client/version.rb +2 -2
- data/lib/pulp_python_client.rb +2 -5
- data/pulp_python_client.gemspec +9 -6
- data/spec/api/content_packages_api_spec.rb +4 -4
- data/spec/api/distributions_pypi_api_spec.rb +13 -13
- data/spec/api/publications_pypi_api_spec.rb +16 -15
- data/spec/api/pypi_api_spec.rb +2 -2
- data/spec/api/pypi_legacy_api_spec.rb +2 -2
- data/spec/api/pypi_metadata_api_spec.rb +2 -2
- data/spec/api/pypi_simple_api_spec.rb +4 -4
- data/spec/api/remotes_python_api_spec.rb +21 -20
- data/spec/api/repositories_python_api_spec.rb +15 -15
- data/spec/api/repositories_python_versions_api_spec.rb +12 -11
- data/spec/models/async_operation_response_spec.rb +7 -12
- data/spec/models/content_summary_response_spec.rb +9 -14
- data/spec/models/exclude_platforms_enum_spec.rb +6 -11
- 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/package_metadata_response_spec.rb +10 -15
- data/spec/models/package_types_enum_spec.rb +6 -11
- data/spec/models/package_upload_task_response_spec.rb +9 -14
- data/spec/models/paginated_repository_version_response_list_spec.rb +10 -15
- data/spec/models/paginatedpython_python_distribution_response_list_spec.rb +10 -15
- data/spec/models/paginatedpython_python_package_content_response_list_spec.rb +10 -15
- data/spec/models/paginatedpython_python_publication_response_list_spec.rb +10 -15
- data/spec/models/paginatedpython_python_remote_response_list_spec.rb +10 -15
- data/spec/models/paginatedpython_python_repository_response_list_spec.rb +10 -15
- data/spec/models/patchedpython_python_distribution_spec.rb +15 -20
- data/spec/models/patchedpython_python_remote_spec.rb +33 -38
- data/spec/models/patchedpython_python_repository_spec.rb +12 -17
- data/spec/models/policy_enum_spec.rb +6 -11
- data/spec/models/python_python_distribution_response_spec.rb +21 -26
- data/spec/models/python_python_distribution_spec.rb +15 -20
- data/spec/models/python_python_package_content_response_spec.rb +38 -43
- data/spec/models/python_python_publication_response_spec.rb +13 -18
- data/spec/models/python_python_publication_spec.rb +8 -13
- data/spec/models/{python_python_remote_response_hidden_fields_spec.rb → python_python_remote_response_hidden_fields_inner_spec.rb} +11 -16
- data/spec/models/python_python_remote_response_spec.rb +33 -38
- data/spec/models/python_python_remote_spec.rb +33 -38
- data/spec/models/python_python_repository_response_spec.rb +18 -23
- data/spec/models/python_python_repository_spec.rb +12 -17
- 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 +14 -19
- data/spec/models/set_label_response_spec.rb +8 -13
- data/spec/models/set_label_spec.rb +8 -13
- data/spec/models/summary_response_spec.rb +9 -14
- 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 +81 -69
- data/docs/PackageUpload.md +0 -21
- data/docs/PythonBanderRemote.md +0 -21
- data/docs/PythonPythonPackageContent.md +0 -71
- data/docs/PythonPythonRemoteResponseHiddenFields.md +0 -19
- data/lib/pulp_python_client/models/package_upload.rb +0 -283
- data/lib/pulp_python_client/models/python_bander_remote.rb +0 -257
- data/lib/pulp_python_client/models/python_python_package_content.rb +0 -534
- data/spec/api_client_spec.rb +0 -188
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/package_upload_spec.rb +0 -53
- data/spec/models/python_bander_remote_spec.rb +0 -53
- data/spec/models/python_python_package_content_spec.rb +0 -203
data/docs/PublicationsPypiApi.md
CHANGED
@@ -2,31 +2,30 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost:24817*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**add_role**](PublicationsPypiApi.md#add_role) | **POST** {python_python_publication_href}add_role/ | Add a role
|
8
|
-
[**create**](PublicationsPypiApi.md#create) | **POST** /pulp/api/v3/publications/python/pypi/ | Create a python publication
|
9
|
-
[**delete**](PublicationsPypiApi.md#delete) | **DELETE** {python_python_publication_href} | Delete a python publication
|
10
|
-
[**list**](PublicationsPypiApi.md#list) | **GET** /pulp/api/v3/publications/python/pypi/ | List python publications
|
11
|
-
[**list_roles**](PublicationsPypiApi.md#list_roles) | **GET** {python_python_publication_href}list_roles/ | List roles
|
12
|
-
[**my_permissions**](PublicationsPypiApi.md#my_permissions) | **GET** {python_python_publication_href}my_permissions/ | List user permissions
|
13
|
-
[**read**](PublicationsPypiApi.md#read) | **GET** {python_python_publication_href} | Inspect a python publication
|
14
|
-
[**remove_role**](PublicationsPypiApi.md#remove_role) | **POST** {python_python_publication_href}remove_role/ | Remove a role
|
15
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**add_role**](PublicationsPypiApi.md#add_role) | **POST** {python_python_publication_href}add_role/ | Add a role |
|
8
|
+
| [**create**](PublicationsPypiApi.md#create) | **POST** /pulp/api/v3/publications/python/pypi/ | Create a python publication |
|
9
|
+
| [**delete**](PublicationsPypiApi.md#delete) | **DELETE** {python_python_publication_href} | Delete a python publication |
|
10
|
+
| [**list**](PublicationsPypiApi.md#list) | **GET** /pulp/api/v3/publications/python/pypi/ | List python publications |
|
11
|
+
| [**list_roles**](PublicationsPypiApi.md#list_roles) | **GET** {python_python_publication_href}list_roles/ | List roles |
|
12
|
+
| [**my_permissions**](PublicationsPypiApi.md#my_permissions) | **GET** {python_python_publication_href}my_permissions/ | List user permissions |
|
13
|
+
| [**read**](PublicationsPypiApi.md#read) | **GET** {python_python_publication_href} | Inspect a python publication |
|
14
|
+
| [**remove_role**](PublicationsPypiApi.md#remove_role) | **POST** {python_python_publication_href}remove_role/ | Remove a role |
|
16
15
|
|
17
16
|
|
18
17
|
## add_role
|
19
18
|
|
20
|
-
> NestedRoleResponse add_role(python_python_publication_href, nested_role)
|
19
|
+
> <NestedRoleResponse> add_role(python_python_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_python_client'
|
31
30
|
# setup authorization
|
32
31
|
PulpPythonClient.configure do |config|
|
@@ -37,24 +36,41 @@ end
|
|
37
36
|
|
38
37
|
api_instance = PulpPythonClient::PublicationsPypiApi.new
|
39
38
|
python_python_publication_href = 'python_python_publication_href_example' # String |
|
40
|
-
nested_role = PulpPythonClient::NestedRole.new # NestedRole |
|
39
|
+
nested_role = PulpPythonClient::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(python_python_publication_href, nested_role)
|
45
44
|
p result
|
46
45
|
rescue PulpPythonClient::ApiError => e
|
47
|
-
puts "
|
46
|
+
puts "Error when calling PublicationsPypiApi->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(python_python_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(python_python_publication_href, nested_role)
|
60
|
+
p status_code # => 2xx
|
61
|
+
p headers # => { ... }
|
62
|
+
p data # => <NestedRoleResponse>
|
63
|
+
rescue PulpPythonClient::ApiError => e
|
64
|
+
puts "Error when calling PublicationsPypiApi->add_role_with_http_info: #{e}"
|
65
|
+
end
|
66
|
+
```
|
67
|
+
|
68
|
+
### Parameters
|
53
69
|
|
54
|
-
Name | Type | Description
|
55
|
-
|
56
|
-
**python_python_publication_href** | **String
|
57
|
-
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
70
|
+
| Name | Type | Description | Notes |
|
71
|
+
| ---- | ---- | ----------- | ----- |
|
72
|
+
| **python_python_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(python_python_publication)
|
91
|
+
> <AsyncOperationResponse> create(python_python_publication)
|
76
92
|
|
77
93
|
Create a python publication
|
78
94
|
|
79
95
|
Dispatches a publish task, which generates metadata that will be used by pip.
|
80
96
|
|
81
|
-
###
|
97
|
+
### Examples
|
82
98
|
|
83
99
|
```ruby
|
84
|
-
|
100
|
+
require 'time'
|
85
101
|
require 'pulp_python_client'
|
86
102
|
# setup authorization
|
87
103
|
PulpPythonClient.configure do |config|
|
@@ -94,20 +110,37 @@ api_instance = PulpPythonClient::PublicationsPypiApi.new
|
|
94
110
|
python_python_publication = PulpPythonClient::PythonPythonPublication.new # PythonPythonPublication |
|
95
111
|
|
96
112
|
begin
|
97
|
-
#Create a python publication
|
113
|
+
# Create a python publication
|
98
114
|
result = api_instance.create(python_python_publication)
|
99
115
|
p result
|
100
116
|
rescue PulpPythonClient::ApiError => e
|
101
|
-
puts "
|
117
|
+
puts "Error when calling PublicationsPypiApi->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(python_python_publication)
|
126
|
+
|
127
|
+
```ruby
|
128
|
+
begin
|
129
|
+
# Create a python publication
|
130
|
+
data, status_code, headers = api_instance.create_with_http_info(python_python_publication)
|
131
|
+
p status_code # => 2xx
|
132
|
+
p headers # => { ... }
|
133
|
+
p data # => <AsyncOperationResponse>
|
134
|
+
rescue PulpPythonClient::ApiError => e
|
135
|
+
puts "Error when calling PublicationsPypiApi->create_with_http_info: #{e}"
|
136
|
+
end
|
137
|
+
```
|
106
138
|
|
139
|
+
### Parameters
|
107
140
|
|
108
|
-
Name | Type | Description
|
109
|
-
|
110
|
-
**python_python_publication** | [**PythonPythonPublication**](PythonPythonPublication.md)| |
|
141
|
+
| Name | Type | Description | Notes |
|
142
|
+
| ---- | ---- | ----------- | ----- |
|
143
|
+
| **python_python_publication** | [**PythonPythonPublication**](PythonPythonPublication.md) | | |
|
111
144
|
|
112
145
|
### Return type
|
113
146
|
|
@@ -131,10 +164,10 @@ Delete a python publication
|
|
131
164
|
|
132
165
|
Python Publications refer to the Python Package content in a repository version, and include metadata about that content.
|
133
166
|
|
134
|
-
###
|
167
|
+
### Examples
|
135
168
|
|
136
169
|
```ruby
|
137
|
-
|
170
|
+
require 'time'
|
138
171
|
require 'pulp_python_client'
|
139
172
|
# setup authorization
|
140
173
|
PulpPythonClient.configure do |config|
|
@@ -147,19 +180,36 @@ api_instance = PulpPythonClient::PublicationsPypiApi.new
|
|
147
180
|
python_python_publication_href = 'python_python_publication_href_example' # String |
|
148
181
|
|
149
182
|
begin
|
150
|
-
#Delete a python publication
|
183
|
+
# Delete a python publication
|
151
184
|
api_instance.delete(python_python_publication_href)
|
152
185
|
rescue PulpPythonClient::ApiError => e
|
153
|
-
puts "
|
186
|
+
puts "Error when calling PublicationsPypiApi->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(python_python_publication_href)
|
195
|
+
|
196
|
+
```ruby
|
197
|
+
begin
|
198
|
+
# Delete a python publication
|
199
|
+
data, status_code, headers = api_instance.delete_with_http_info(python_python_publication_href)
|
200
|
+
p status_code # => 2xx
|
201
|
+
p headers # => { ... }
|
202
|
+
p data # => nil
|
203
|
+
rescue PulpPythonClient::ApiError => e
|
204
|
+
puts "Error when calling PublicationsPypiApi->delete_with_http_info: #{e}"
|
205
|
+
end
|
206
|
+
```
|
158
207
|
|
208
|
+
### Parameters
|
159
209
|
|
160
|
-
Name | Type | Description
|
161
|
-
|
162
|
-
**python_python_publication_href** | **String
|
210
|
+
| Name | Type | Description | Notes |
|
211
|
+
| ---- | ---- | ----------- | ----- |
|
212
|
+
| **python_python_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
|
-
> PaginatedpythonPythonPublicationResponseList list(opts)
|
230
|
+
> <PaginatedpythonPythonPublicationResponseList> list(opts)
|
181
231
|
|
182
232
|
List python publications
|
183
233
|
|
184
234
|
Python Publications refer to the Python Package content in a repository version, and include metadata about that content.
|
185
235
|
|
186
|
-
###
|
236
|
+
### Examples
|
187
237
|
|
188
238
|
```ruby
|
189
|
-
|
239
|
+
require 'time'
|
190
240
|
require 'pulp_python_client'
|
191
241
|
# setup authorization
|
192
242
|
PulpPythonClient.configure do |config|
|
@@ -198,59 +248,78 @@ end
|
|
198
248
|
api_instance = PulpPythonClient::PublicationsPypiApi.new
|
199
249
|
opts = {
|
200
250
|
content: 'content_example', # String | Content Unit referenced by HREF/PRN
|
201
|
-
content__in: ['
|
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
|
-
prn__in: ['
|
206
|
-
pulp_created:
|
207
|
-
pulp_created__gt:
|
208
|
-
pulp_created__gte:
|
209
|
-
|
210
|
-
|
211
|
-
|
212
|
-
|
213
|
-
|
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.
|
214
265
|
q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
|
215
266
|
repository: 'repository_example', # String | Repository referenced by HREF/PRN
|
216
|
-
repository_version: '
|
217
|
-
fields: ['
|
218
|
-
exclude_fields: ['
|
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.
|
219
270
|
}
|
220
271
|
|
221
272
|
begin
|
222
|
-
#List python publications
|
273
|
+
# List python publications
|
223
274
|
result = api_instance.list(opts)
|
224
275
|
p result
|
225
276
|
rescue PulpPythonClient::ApiError => e
|
226
|
-
puts "
|
277
|
+
puts "Error when calling PublicationsPypiApi->list: #{e}"
|
227
278
|
end
|
228
279
|
```
|
229
280
|
|
230
|
-
|
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(<PaginatedpythonPythonPublicationResponseList>, Integer, Hash)> list_with_http_info(opts)
|
286
|
+
|
287
|
+
```ruby
|
288
|
+
begin
|
289
|
+
# List python publications
|
290
|
+
data, status_code, headers = api_instance.list_with_http_info(opts)
|
291
|
+
p status_code # => 2xx
|
292
|
+
p headers # => { ... }
|
293
|
+
p data # => <PaginatedpythonPythonPublicationResponseList>
|
294
|
+
rescue PulpPythonClient::ApiError => e
|
295
|
+
puts "Error when calling PublicationsPypiApi->list_with_http_info: #{e}"
|
296
|
+
end
|
297
|
+
```
|
231
298
|
|
299
|
+
### Parameters
|
232
300
|
|
233
|
-
Name | Type | Description
|
234
|
-
|
235
|
-
**content** | **String
|
236
|
-
**content__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
237
|
-
**limit** | **Integer
|
238
|
-
**offset** | **Integer
|
239
|
-
**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]
|
240
|
-
**prn__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
241
|
-
**pulp_created** | **
|
242
|
-
**pulp_created__gt** | **
|
243
|
-
**pulp_created__gte** | **
|
244
|
-
**
|
245
|
-
**
|
246
|
-
**
|
247
|
-
**
|
248
|
-
**
|
249
|
-
**
|
250
|
-
**
|
251
|
-
**
|
252
|
-
**
|
253
|
-
**
|
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] |
|
254
323
|
|
255
324
|
### Return type
|
256
325
|
|
@@ -268,16 +337,16 @@ Name | Type | Description | Notes
|
|
268
337
|
|
269
338
|
## list_roles
|
270
339
|
|
271
|
-
> ObjectRolesResponse list_roles(python_python_publication_href, opts)
|
340
|
+
> <ObjectRolesResponse> list_roles(python_python_publication_href, opts)
|
272
341
|
|
273
342
|
List roles
|
274
343
|
|
275
344
|
List roles assigned to this object.
|
276
345
|
|
277
|
-
###
|
346
|
+
### Examples
|
278
347
|
|
279
348
|
```ruby
|
280
|
-
|
349
|
+
require 'time'
|
281
350
|
require 'pulp_python_client'
|
282
351
|
# setup authorization
|
283
352
|
PulpPythonClient.configure do |config|
|
@@ -289,27 +358,44 @@ end
|
|
289
358
|
api_instance = PulpPythonClient::PublicationsPypiApi.new
|
290
359
|
python_python_publication_href = 'python_python_publication_href_example' # String |
|
291
360
|
opts = {
|
292
|
-
fields: ['
|
293
|
-
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.
|
294
363
|
}
|
295
364
|
|
296
365
|
begin
|
297
|
-
#List roles
|
366
|
+
# List roles
|
298
367
|
result = api_instance.list_roles(python_python_publication_href, opts)
|
299
368
|
p result
|
300
369
|
rescue PulpPythonClient::ApiError => e
|
301
|
-
puts "
|
370
|
+
puts "Error when calling PublicationsPypiApi->list_roles: #{e}"
|
302
371
|
end
|
303
372
|
```
|
304
373
|
|
305
|
-
|
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(python_python_publication_href, opts)
|
379
|
+
|
380
|
+
```ruby
|
381
|
+
begin
|
382
|
+
# List roles
|
383
|
+
data, status_code, headers = api_instance.list_roles_with_http_info(python_python_publication_href, opts)
|
384
|
+
p status_code # => 2xx
|
385
|
+
p headers # => { ... }
|
386
|
+
p data # => <ObjectRolesResponse>
|
387
|
+
rescue PulpPythonClient::ApiError => e
|
388
|
+
puts "Error when calling PublicationsPypiApi->list_roles_with_http_info: #{e}"
|
389
|
+
end
|
390
|
+
```
|
306
391
|
|
392
|
+
### Parameters
|
307
393
|
|
308
|
-
Name | Type | Description
|
309
|
-
|
310
|
-
**python_python_publication_href** | **String
|
311
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
312
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
394
|
+
| Name | Type | Description | Notes |
|
395
|
+
| ---- | ---- | ----------- | ----- |
|
396
|
+
| **python_python_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] |
|
313
399
|
|
314
400
|
### Return type
|
315
401
|
|
@@ -327,16 +413,16 @@ Name | Type | Description | Notes
|
|
327
413
|
|
328
414
|
## my_permissions
|
329
415
|
|
330
|
-
> MyPermissionsResponse my_permissions(python_python_publication_href, opts)
|
416
|
+
> <MyPermissionsResponse> my_permissions(python_python_publication_href, opts)
|
331
417
|
|
332
418
|
List user permissions
|
333
419
|
|
334
420
|
List permissions available to the current user on this object.
|
335
421
|
|
336
|
-
###
|
422
|
+
### Examples
|
337
423
|
|
338
424
|
```ruby
|
339
|
-
|
425
|
+
require 'time'
|
340
426
|
require 'pulp_python_client'
|
341
427
|
# setup authorization
|
342
428
|
PulpPythonClient.configure do |config|
|
@@ -348,27 +434,44 @@ end
|
|
348
434
|
api_instance = PulpPythonClient::PublicationsPypiApi.new
|
349
435
|
python_python_publication_href = 'python_python_publication_href_example' # String |
|
350
436
|
opts = {
|
351
|
-
fields: ['
|
352
|
-
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.
|
353
439
|
}
|
354
440
|
|
355
441
|
begin
|
356
|
-
#List user permissions
|
442
|
+
# List user permissions
|
357
443
|
result = api_instance.my_permissions(python_python_publication_href, opts)
|
358
444
|
p result
|
359
445
|
rescue PulpPythonClient::ApiError => e
|
360
|
-
puts "
|
446
|
+
puts "Error when calling PublicationsPypiApi->my_permissions: #{e}"
|
361
447
|
end
|
362
448
|
```
|
363
449
|
|
364
|
-
|
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(python_python_publication_href, opts)
|
455
|
+
|
456
|
+
```ruby
|
457
|
+
begin
|
458
|
+
# List user permissions
|
459
|
+
data, status_code, headers = api_instance.my_permissions_with_http_info(python_python_publication_href, opts)
|
460
|
+
p status_code # => 2xx
|
461
|
+
p headers # => { ... }
|
462
|
+
p data # => <MyPermissionsResponse>
|
463
|
+
rescue PulpPythonClient::ApiError => e
|
464
|
+
puts "Error when calling PublicationsPypiApi->my_permissions_with_http_info: #{e}"
|
465
|
+
end
|
466
|
+
```
|
365
467
|
|
468
|
+
### Parameters
|
366
469
|
|
367
|
-
Name | Type | Description
|
368
|
-
|
369
|
-
**python_python_publication_href** | **String
|
370
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
371
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
470
|
+
| Name | Type | Description | Notes |
|
471
|
+
| ---- | ---- | ----------- | ----- |
|
472
|
+
| **python_python_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] |
|
372
475
|
|
373
476
|
### Return type
|
374
477
|
|
@@ -386,16 +489,16 @@ Name | Type | Description | Notes
|
|
386
489
|
|
387
490
|
## read
|
388
491
|
|
389
|
-
> PythonPythonPublicationResponse read(python_python_publication_href, opts)
|
492
|
+
> <PythonPythonPublicationResponse> read(python_python_publication_href, opts)
|
390
493
|
|
391
494
|
Inspect a python publication
|
392
495
|
|
393
496
|
Python Publications refer to the Python Package content in a repository version, and include metadata about that content.
|
394
497
|
|
395
|
-
###
|
498
|
+
### Examples
|
396
499
|
|
397
500
|
```ruby
|
398
|
-
|
501
|
+
require 'time'
|
399
502
|
require 'pulp_python_client'
|
400
503
|
# setup authorization
|
401
504
|
PulpPythonClient.configure do |config|
|
@@ -407,27 +510,44 @@ end
|
|
407
510
|
api_instance = PulpPythonClient::PublicationsPypiApi.new
|
408
511
|
python_python_publication_href = 'python_python_publication_href_example' # String |
|
409
512
|
opts = {
|
410
|
-
fields: ['
|
411
|
-
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.
|
412
515
|
}
|
413
516
|
|
414
517
|
begin
|
415
|
-
#Inspect a python publication
|
518
|
+
# Inspect a python publication
|
416
519
|
result = api_instance.read(python_python_publication_href, opts)
|
417
520
|
p result
|
418
521
|
rescue PulpPythonClient::ApiError => e
|
419
|
-
puts "
|
522
|
+
puts "Error when calling PublicationsPypiApi->read: #{e}"
|
420
523
|
end
|
421
524
|
```
|
422
525
|
|
423
|
-
|
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(<PythonPythonPublicationResponse>, Integer, Hash)> read_with_http_info(python_python_publication_href, opts)
|
531
|
+
|
532
|
+
```ruby
|
533
|
+
begin
|
534
|
+
# Inspect a python publication
|
535
|
+
data, status_code, headers = api_instance.read_with_http_info(python_python_publication_href, opts)
|
536
|
+
p status_code # => 2xx
|
537
|
+
p headers # => { ... }
|
538
|
+
p data # => <PythonPythonPublicationResponse>
|
539
|
+
rescue PulpPythonClient::ApiError => e
|
540
|
+
puts "Error when calling PublicationsPypiApi->read_with_http_info: #{e}"
|
541
|
+
end
|
542
|
+
```
|
424
543
|
|
544
|
+
### Parameters
|
425
545
|
|
426
|
-
Name | Type | Description
|
427
|
-
|
428
|
-
**python_python_publication_href** | **String
|
429
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
430
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
546
|
+
| Name | Type | Description | Notes |
|
547
|
+
| ---- | ---- | ----------- | ----- |
|
548
|
+
| **python_python_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] |
|
431
551
|
|
432
552
|
### Return type
|
433
553
|
|
@@ -445,16 +565,16 @@ Name | Type | Description | Notes
|
|
445
565
|
|
446
566
|
## remove_role
|
447
567
|
|
448
|
-
> NestedRoleResponse remove_role(python_python_publication_href, nested_role)
|
568
|
+
> <NestedRoleResponse> remove_role(python_python_publication_href, nested_role)
|
449
569
|
|
450
570
|
Remove a role
|
451
571
|
|
452
572
|
Remove a role for this object from users/groups.
|
453
573
|
|
454
|
-
###
|
574
|
+
### Examples
|
455
575
|
|
456
576
|
```ruby
|
457
|
-
|
577
|
+
require 'time'
|
458
578
|
require 'pulp_python_client'
|
459
579
|
# setup authorization
|
460
580
|
PulpPythonClient.configure do |config|
|
@@ -465,24 +585,41 @@ end
|
|
465
585
|
|
466
586
|
api_instance = PulpPythonClient::PublicationsPypiApi.new
|
467
587
|
python_python_publication_href = 'python_python_publication_href_example' # String |
|
468
|
-
nested_role = PulpPythonClient::NestedRole.new # NestedRole |
|
588
|
+
nested_role = PulpPythonClient::NestedRole.new({role: 'role_example'}) # NestedRole |
|
469
589
|
|
470
590
|
begin
|
471
|
-
#Remove a role
|
591
|
+
# Remove a role
|
472
592
|
result = api_instance.remove_role(python_python_publication_href, nested_role)
|
473
593
|
p result
|
474
594
|
rescue PulpPythonClient::ApiError => e
|
475
|
-
puts "
|
595
|
+
puts "Error when calling PublicationsPypiApi->remove_role: #{e}"
|
476
596
|
end
|
477
597
|
```
|
478
598
|
|
479
|
-
|
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(python_python_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(python_python_publication_href, nested_role)
|
609
|
+
p status_code # => 2xx
|
610
|
+
p headers # => { ... }
|
611
|
+
p data # => <NestedRoleResponse>
|
612
|
+
rescue PulpPythonClient::ApiError => e
|
613
|
+
puts "Error when calling PublicationsPypiApi->remove_role_with_http_info: #{e}"
|
614
|
+
end
|
615
|
+
```
|
480
616
|
|
617
|
+
### Parameters
|
481
618
|
|
482
|
-
Name | Type | Description
|
483
|
-
|
484
|
-
**python_python_publication_href** | **String
|
485
|
-
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
619
|
+
| Name | Type | Description | Notes |
|
620
|
+
| ---- | ---- | ----------- | ----- |
|
621
|
+
| **python_python_publication_href** | **String** | | |
|
622
|
+
| **nested_role** | [**NestedRole**](NestedRole.md) | | |
|
486
623
|
|
487
624
|
### Return type
|
488
625
|
|