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/RemotesPythonApi.md
CHANGED
@@ -2,36 +2,35 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost:24817*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**add_role**](RemotesPythonApi.md#add_role) | **POST** {python_python_remote_href}add_role/ | Add a role
|
8
|
-
[**create**](RemotesPythonApi.md#create) | **POST** /pulp/api/v3/remotes/python/python/ | Create a python remote
|
9
|
-
[**delete**](RemotesPythonApi.md#delete) | **DELETE** {python_python_remote_href} | Delete a python remote
|
10
|
-
[**from_bandersnatch**](RemotesPythonApi.md#from_bandersnatch) | **POST** /pulp/api/v3/remotes/python/python/from_bandersnatch/ | Create from Bandersnatch
|
11
|
-
[**list**](RemotesPythonApi.md#list) | **GET** /pulp/api/v3/remotes/python/python/ | List python remotes
|
12
|
-
[**list_roles**](RemotesPythonApi.md#list_roles) | **GET** {python_python_remote_href}list_roles/ | List roles
|
13
|
-
[**my_permissions**](RemotesPythonApi.md#my_permissions) | **GET** {python_python_remote_href}my_permissions/ | List user permissions
|
14
|
-
[**partial_update**](RemotesPythonApi.md#partial_update) | **PATCH** {python_python_remote_href} | Update a python remote
|
15
|
-
[**read**](RemotesPythonApi.md#read) | **GET** {python_python_remote_href} | Inspect a python remote
|
16
|
-
[**remove_role**](RemotesPythonApi.md#remove_role) | **POST** {python_python_remote_href}remove_role/ | Remove a role
|
17
|
-
[**set_label**](RemotesPythonApi.md#set_label) | **POST** {python_python_remote_href}set_label/ | Set a label
|
18
|
-
[**unset_label**](RemotesPythonApi.md#unset_label) | **POST** {python_python_remote_href}unset_label/ | Unset a label
|
19
|
-
[**update**](RemotesPythonApi.md#update) | **PUT** {python_python_remote_href} | Update a python remote
|
20
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**add_role**](RemotesPythonApi.md#add_role) | **POST** {python_python_remote_href}add_role/ | Add a role |
|
8
|
+
| [**create**](RemotesPythonApi.md#create) | **POST** /pulp/api/v3/remotes/python/python/ | Create a python remote |
|
9
|
+
| [**delete**](RemotesPythonApi.md#delete) | **DELETE** {python_python_remote_href} | Delete a python remote |
|
10
|
+
| [**from_bandersnatch**](RemotesPythonApi.md#from_bandersnatch) | **POST** /pulp/api/v3/remotes/python/python/from_bandersnatch/ | Create from Bandersnatch |
|
11
|
+
| [**list**](RemotesPythonApi.md#list) | **GET** /pulp/api/v3/remotes/python/python/ | List python remotes |
|
12
|
+
| [**list_roles**](RemotesPythonApi.md#list_roles) | **GET** {python_python_remote_href}list_roles/ | List roles |
|
13
|
+
| [**my_permissions**](RemotesPythonApi.md#my_permissions) | **GET** {python_python_remote_href}my_permissions/ | List user permissions |
|
14
|
+
| [**partial_update**](RemotesPythonApi.md#partial_update) | **PATCH** {python_python_remote_href} | Update a python remote |
|
15
|
+
| [**read**](RemotesPythonApi.md#read) | **GET** {python_python_remote_href} | Inspect a python remote |
|
16
|
+
| [**remove_role**](RemotesPythonApi.md#remove_role) | **POST** {python_python_remote_href}remove_role/ | Remove a role |
|
17
|
+
| [**set_label**](RemotesPythonApi.md#set_label) | **POST** {python_python_remote_href}set_label/ | Set a label |
|
18
|
+
| [**unset_label**](RemotesPythonApi.md#unset_label) | **POST** {python_python_remote_href}unset_label/ | Unset a label |
|
19
|
+
| [**update**](RemotesPythonApi.md#update) | **PUT** {python_python_remote_href} | Update a python remote |
|
21
20
|
|
22
21
|
|
23
22
|
## add_role
|
24
23
|
|
25
|
-
> NestedRoleResponse add_role(python_python_remote_href, nested_role)
|
24
|
+
> <NestedRoleResponse> add_role(python_python_remote_href, nested_role)
|
26
25
|
|
27
26
|
Add a role
|
28
27
|
|
29
28
|
Add a role for this object to users/groups.
|
30
29
|
|
31
|
-
###
|
30
|
+
### Examples
|
32
31
|
|
33
32
|
```ruby
|
34
|
-
|
33
|
+
require 'time'
|
35
34
|
require 'pulp_python_client'
|
36
35
|
# setup authorization
|
37
36
|
PulpPythonClient.configure do |config|
|
@@ -42,24 +41,41 @@ end
|
|
42
41
|
|
43
42
|
api_instance = PulpPythonClient::RemotesPythonApi.new
|
44
43
|
python_python_remote_href = 'python_python_remote_href_example' # String |
|
45
|
-
nested_role = PulpPythonClient::NestedRole.new # NestedRole |
|
44
|
+
nested_role = PulpPythonClient::NestedRole.new({role: 'role_example'}) # NestedRole |
|
46
45
|
|
47
46
|
begin
|
48
|
-
#Add a role
|
47
|
+
# Add a role
|
49
48
|
result = api_instance.add_role(python_python_remote_href, nested_role)
|
50
49
|
p result
|
51
50
|
rescue PulpPythonClient::ApiError => e
|
52
|
-
puts "
|
51
|
+
puts "Error when calling RemotesPythonApi->add_role: #{e}"
|
53
52
|
end
|
54
53
|
```
|
55
54
|
|
56
|
-
|
55
|
+
#### Using the add_role_with_http_info variant
|
57
56
|
|
57
|
+
This returns an Array which contains the response data, status code and headers.
|
58
58
|
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
59
|
+
> <Array(<NestedRoleResponse>, Integer, Hash)> add_role_with_http_info(python_python_remote_href, nested_role)
|
60
|
+
|
61
|
+
```ruby
|
62
|
+
begin
|
63
|
+
# Add a role
|
64
|
+
data, status_code, headers = api_instance.add_role_with_http_info(python_python_remote_href, nested_role)
|
65
|
+
p status_code # => 2xx
|
66
|
+
p headers # => { ... }
|
67
|
+
p data # => <NestedRoleResponse>
|
68
|
+
rescue PulpPythonClient::ApiError => e
|
69
|
+
puts "Error when calling RemotesPythonApi->add_role_with_http_info: #{e}"
|
70
|
+
end
|
71
|
+
```
|
72
|
+
|
73
|
+
### Parameters
|
74
|
+
|
75
|
+
| Name | Type | Description | Notes |
|
76
|
+
| ---- | ---- | ----------- | ----- |
|
77
|
+
| **python_python_remote_href** | **String** | | |
|
78
|
+
| **nested_role** | [**NestedRole**](NestedRole.md) | | |
|
63
79
|
|
64
80
|
### Return type
|
65
81
|
|
@@ -77,16 +93,16 @@ Name | Type | Description | Notes
|
|
77
93
|
|
78
94
|
## create
|
79
95
|
|
80
|
-
> PythonPythonRemoteResponse create(python_python_remote)
|
96
|
+
> <PythonPythonRemoteResponse> create(python_python_remote)
|
81
97
|
|
82
98
|
Create a python remote
|
83
99
|
|
84
100
|
Python Remotes are representations of an external repository of Python content, eg. PyPI. Fields include upstream repository config. Python Remotes are also used to `sync` from upstream repositories, and contains sync settings.
|
85
101
|
|
86
|
-
###
|
102
|
+
### Examples
|
87
103
|
|
88
104
|
```ruby
|
89
|
-
|
105
|
+
require 'time'
|
90
106
|
require 'pulp_python_client'
|
91
107
|
# setup authorization
|
92
108
|
PulpPythonClient.configure do |config|
|
@@ -96,23 +112,40 @@ PulpPythonClient.configure do |config|
|
|
96
112
|
end
|
97
113
|
|
98
114
|
api_instance = PulpPythonClient::RemotesPythonApi.new
|
99
|
-
python_python_remote = PulpPythonClient::PythonPythonRemote.new # PythonPythonRemote |
|
115
|
+
python_python_remote = PulpPythonClient::PythonPythonRemote.new({name: 'name_example', url: 'url_example'}) # PythonPythonRemote |
|
100
116
|
|
101
117
|
begin
|
102
|
-
#Create a python remote
|
118
|
+
# Create a python remote
|
103
119
|
result = api_instance.create(python_python_remote)
|
104
120
|
p result
|
105
121
|
rescue PulpPythonClient::ApiError => e
|
106
|
-
puts "
|
122
|
+
puts "Error when calling RemotesPythonApi->create: #{e}"
|
107
123
|
end
|
108
124
|
```
|
109
125
|
|
110
|
-
|
126
|
+
#### Using the create_with_http_info variant
|
111
127
|
|
128
|
+
This returns an Array which contains the response data, status code and headers.
|
112
129
|
|
113
|
-
|
114
|
-
|
115
|
-
|
130
|
+
> <Array(<PythonPythonRemoteResponse>, Integer, Hash)> create_with_http_info(python_python_remote)
|
131
|
+
|
132
|
+
```ruby
|
133
|
+
begin
|
134
|
+
# Create a python remote
|
135
|
+
data, status_code, headers = api_instance.create_with_http_info(python_python_remote)
|
136
|
+
p status_code # => 2xx
|
137
|
+
p headers # => { ... }
|
138
|
+
p data # => <PythonPythonRemoteResponse>
|
139
|
+
rescue PulpPythonClient::ApiError => e
|
140
|
+
puts "Error when calling RemotesPythonApi->create_with_http_info: #{e}"
|
141
|
+
end
|
142
|
+
```
|
143
|
+
|
144
|
+
### Parameters
|
145
|
+
|
146
|
+
| Name | Type | Description | Notes |
|
147
|
+
| ---- | ---- | ----------- | ----- |
|
148
|
+
| **python_python_remote** | [**PythonPythonRemote**](PythonPythonRemote.md) | | |
|
116
149
|
|
117
150
|
### Return type
|
118
151
|
|
@@ -130,16 +163,16 @@ Name | Type | Description | Notes
|
|
130
163
|
|
131
164
|
## delete
|
132
165
|
|
133
|
-
> AsyncOperationResponse delete(python_python_remote_href)
|
166
|
+
> <AsyncOperationResponse> delete(python_python_remote_href)
|
134
167
|
|
135
168
|
Delete a python remote
|
136
169
|
|
137
170
|
Trigger an asynchronous delete task
|
138
171
|
|
139
|
-
###
|
172
|
+
### Examples
|
140
173
|
|
141
174
|
```ruby
|
142
|
-
|
175
|
+
require 'time'
|
143
176
|
require 'pulp_python_client'
|
144
177
|
# setup authorization
|
145
178
|
PulpPythonClient.configure do |config|
|
@@ -152,20 +185,37 @@ api_instance = PulpPythonClient::RemotesPythonApi.new
|
|
152
185
|
python_python_remote_href = 'python_python_remote_href_example' # String |
|
153
186
|
|
154
187
|
begin
|
155
|
-
#Delete a python remote
|
188
|
+
# Delete a python remote
|
156
189
|
result = api_instance.delete(python_python_remote_href)
|
157
190
|
p result
|
158
191
|
rescue PulpPythonClient::ApiError => e
|
159
|
-
puts "
|
192
|
+
puts "Error when calling RemotesPythonApi->delete: #{e}"
|
160
193
|
end
|
161
194
|
```
|
162
195
|
|
163
|
-
|
196
|
+
#### Using the delete_with_http_info variant
|
197
|
+
|
198
|
+
This returns an Array which contains the response data, status code and headers.
|
199
|
+
|
200
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> delete_with_http_info(python_python_remote_href)
|
201
|
+
|
202
|
+
```ruby
|
203
|
+
begin
|
204
|
+
# Delete a python remote
|
205
|
+
data, status_code, headers = api_instance.delete_with_http_info(python_python_remote_href)
|
206
|
+
p status_code # => 2xx
|
207
|
+
p headers # => { ... }
|
208
|
+
p data # => <AsyncOperationResponse>
|
209
|
+
rescue PulpPythonClient::ApiError => e
|
210
|
+
puts "Error when calling RemotesPythonApi->delete_with_http_info: #{e}"
|
211
|
+
end
|
212
|
+
```
|
164
213
|
|
214
|
+
### Parameters
|
165
215
|
|
166
|
-
Name | Type | Description
|
167
|
-
|
168
|
-
**python_python_remote_href** | **String
|
216
|
+
| Name | Type | Description | Notes |
|
217
|
+
| ---- | ---- | ----------- | ----- |
|
218
|
+
| **python_python_remote_href** | **String** | | |
|
169
219
|
|
170
220
|
### Return type
|
171
221
|
|
@@ -183,16 +233,16 @@ Name | Type | Description | Notes
|
|
183
233
|
|
184
234
|
## from_bandersnatch
|
185
235
|
|
186
|
-
> PythonPythonRemoteResponse from_bandersnatch(config, name, opts)
|
236
|
+
> <PythonPythonRemoteResponse> from_bandersnatch(config, name, opts)
|
187
237
|
|
188
238
|
Create from Bandersnatch
|
189
239
|
|
190
240
|
Takes the fields specified in the Bandersnatch config and creates a Python Remote from it.
|
191
241
|
|
192
|
-
###
|
242
|
+
### Examples
|
193
243
|
|
194
244
|
```ruby
|
195
|
-
|
245
|
+
require 'time'
|
196
246
|
require 'pulp_python_client'
|
197
247
|
# setup authorization
|
198
248
|
PulpPythonClient.configure do |config|
|
@@ -202,29 +252,46 @@ PulpPythonClient.configure do |config|
|
|
202
252
|
end
|
203
253
|
|
204
254
|
api_instance = PulpPythonClient::RemotesPythonApi.new
|
205
|
-
config = File.new('/path/to/file') # File | A Bandersnatch config that may be used to construct a Python Remote.
|
255
|
+
config = File.new('/path/to/some/file') # File | A Bandersnatch config that may be used to construct a Python Remote.
|
206
256
|
name = 'name_example' # String | A unique name for this remote
|
207
257
|
opts = {
|
208
|
-
policy: PulpPythonClient::PolicyEnum
|
258
|
+
policy: PulpPythonClient::PolicyEnum::IMMEDIATE # PolicyEnum | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'on_demand' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again.
|
209
259
|
}
|
210
260
|
|
211
261
|
begin
|
212
|
-
#Create from Bandersnatch
|
262
|
+
# Create from Bandersnatch
|
213
263
|
result = api_instance.from_bandersnatch(config, name, opts)
|
214
264
|
p result
|
215
265
|
rescue PulpPythonClient::ApiError => e
|
216
|
-
puts "
|
266
|
+
puts "Error when calling RemotesPythonApi->from_bandersnatch: #{e}"
|
217
267
|
end
|
218
268
|
```
|
219
269
|
|
220
|
-
|
270
|
+
#### Using the from_bandersnatch_with_http_info variant
|
271
|
+
|
272
|
+
This returns an Array which contains the response data, status code and headers.
|
221
273
|
|
274
|
+
> <Array(<PythonPythonRemoteResponse>, Integer, Hash)> from_bandersnatch_with_http_info(config, name, opts)
|
222
275
|
|
223
|
-
|
224
|
-
|
225
|
-
|
226
|
-
|
227
|
-
|
276
|
+
```ruby
|
277
|
+
begin
|
278
|
+
# Create from Bandersnatch
|
279
|
+
data, status_code, headers = api_instance.from_bandersnatch_with_http_info(config, name, opts)
|
280
|
+
p status_code # => 2xx
|
281
|
+
p headers # => { ... }
|
282
|
+
p data # => <PythonPythonRemoteResponse>
|
283
|
+
rescue PulpPythonClient::ApiError => e
|
284
|
+
puts "Error when calling RemotesPythonApi->from_bandersnatch_with_http_info: #{e}"
|
285
|
+
end
|
286
|
+
```
|
287
|
+
|
288
|
+
### Parameters
|
289
|
+
|
290
|
+
| Name | Type | Description | Notes |
|
291
|
+
| ---- | ---- | ----------- | ----- |
|
292
|
+
| **config** | **File** | A Bandersnatch config that may be used to construct a Python Remote. | |
|
293
|
+
| **name** | **String** | A unique name for this remote | |
|
294
|
+
| **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'on_demand' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional] |
|
228
295
|
|
229
296
|
### Return type
|
230
297
|
|
@@ -242,16 +309,16 @@ Name | Type | Description | Notes
|
|
242
309
|
|
243
310
|
## list
|
244
311
|
|
245
|
-
> PaginatedpythonPythonRemoteResponseList list(opts)
|
312
|
+
> <PaginatedpythonPythonRemoteResponseList> list(opts)
|
246
313
|
|
247
314
|
List python remotes
|
248
315
|
|
249
316
|
Python Remotes are representations of an external repository of Python content, eg. PyPI. Fields include upstream repository config. Python Remotes are also used to `sync` from upstream repositories, and contains sync settings.
|
250
317
|
|
251
|
-
###
|
318
|
+
### Examples
|
252
319
|
|
253
320
|
```ruby
|
254
|
-
|
321
|
+
require 'time'
|
255
322
|
require 'pulp_python_client'
|
256
323
|
# setup authorization
|
257
324
|
PulpPythonClient.configure do |config|
|
@@ -267,67 +334,86 @@ opts = {
|
|
267
334
|
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
268
335
|
name__icontains: 'name__icontains_example', # String | Filter results where name contains value
|
269
336
|
name__iexact: 'name__iexact_example', # String | Filter results where name matches value
|
270
|
-
name__in: ['
|
337
|
+
name__in: ['inner_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
271
338
|
name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
|
272
339
|
name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
|
273
340
|
name__regex: 'name__regex_example', # String | Filter results where name matches regex value
|
274
341
|
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
|
275
342
|
offset: 56, # Integer | The initial index from which to return the results.
|
276
|
-
ordering: ['
|
277
|
-
prn__in: ['
|
278
|
-
pulp_href__in: ['
|
279
|
-
pulp_id__in: ['
|
343
|
+
ordering: ['-ca_cert'], # 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) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
344
|
+
prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
345
|
+
pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
346
|
+
pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
280
347
|
pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
|
281
|
-
pulp_last_updated:
|
282
|
-
pulp_last_updated__gt:
|
283
|
-
pulp_last_updated__gte:
|
284
|
-
|
285
|
-
|
286
|
-
|
348
|
+
pulp_last_updated: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_last_updated matches value
|
349
|
+
pulp_last_updated__gt: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_last_updated is greater than value
|
350
|
+
pulp_last_updated__gte: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_last_updated is greater than or equal to value
|
351
|
+
pulp_last_updated__isnull: true, # Boolean | Filter results where pulp_last_updated has a null value
|
352
|
+
pulp_last_updated__lt: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_last_updated is less than value
|
353
|
+
pulp_last_updated__lte: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_last_updated is less than or equal to value
|
354
|
+
pulp_last_updated__range: [Time.now], # Array<Time> | Filter results where pulp_last_updated is between two comma separated values
|
287
355
|
q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
|
288
|
-
fields: ['
|
289
|
-
exclude_fields: ['
|
356
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
357
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
290
358
|
}
|
291
359
|
|
292
360
|
begin
|
293
|
-
#List python remotes
|
361
|
+
# List python remotes
|
294
362
|
result = api_instance.list(opts)
|
295
363
|
p result
|
296
364
|
rescue PulpPythonClient::ApiError => e
|
297
|
-
puts "
|
365
|
+
puts "Error when calling RemotesPythonApi->list: #{e}"
|
298
366
|
end
|
299
367
|
```
|
300
368
|
|
301
|
-
|
369
|
+
#### Using the list_with_http_info variant
|
302
370
|
|
371
|
+
This returns an Array which contains the response data, status code and headers.
|
303
372
|
|
304
|
-
|
305
|
-
|
306
|
-
|
307
|
-
|
308
|
-
|
309
|
-
|
310
|
-
|
311
|
-
|
312
|
-
|
313
|
-
|
314
|
-
|
315
|
-
|
316
|
-
|
317
|
-
|
318
|
-
|
319
|
-
|
320
|
-
|
321
|
-
|
322
|
-
**
|
323
|
-
**
|
324
|
-
**
|
325
|
-
**
|
326
|
-
**
|
327
|
-
**
|
328
|
-
**
|
329
|
-
**
|
330
|
-
**
|
373
|
+
> <Array(<PaginatedpythonPythonRemoteResponseList>, Integer, Hash)> list_with_http_info(opts)
|
374
|
+
|
375
|
+
```ruby
|
376
|
+
begin
|
377
|
+
# List python remotes
|
378
|
+
data, status_code, headers = api_instance.list_with_http_info(opts)
|
379
|
+
p status_code # => 2xx
|
380
|
+
p headers # => { ... }
|
381
|
+
p data # => <PaginatedpythonPythonRemoteResponseList>
|
382
|
+
rescue PulpPythonClient::ApiError => e
|
383
|
+
puts "Error when calling RemotesPythonApi->list_with_http_info: #{e}"
|
384
|
+
end
|
385
|
+
```
|
386
|
+
|
387
|
+
### Parameters
|
388
|
+
|
389
|
+
| Name | Type | Description | Notes |
|
390
|
+
| ---- | ---- | ----------- | ----- |
|
391
|
+
| **limit** | **Integer** | Number of results to return per page. | [optional] |
|
392
|
+
| **name** | **String** | Filter results where name matches value | [optional] |
|
393
|
+
| **name__contains** | **String** | Filter results where name contains value | [optional] |
|
394
|
+
| **name__icontains** | **String** | Filter results where name contains value | [optional] |
|
395
|
+
| **name__iexact** | **String** | Filter results where name matches value | [optional] |
|
396
|
+
| **name__in** | [**Array<String>**](String.md) | Filter results where name is in a comma-separated list of values | [optional] |
|
397
|
+
| **name__iregex** | **String** | Filter results where name matches regex value | [optional] |
|
398
|
+
| **name__istartswith** | **String** | Filter results where name starts with value | [optional] |
|
399
|
+
| **name__regex** | **String** | Filter results where name matches regex value | [optional] |
|
400
|
+
| **name__startswith** | **String** | Filter results where name starts with value | [optional] |
|
401
|
+
| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
|
402
|
+
| **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) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] |
|
403
|
+
| **prn__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
404
|
+
| **pulp_href__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
405
|
+
| **pulp_id__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
406
|
+
| **pulp_label_select** | **String** | Filter labels by search string | [optional] |
|
407
|
+
| **pulp_last_updated** | **Time** | Filter results where pulp_last_updated matches value | [optional] |
|
408
|
+
| **pulp_last_updated__gt** | **Time** | Filter results where pulp_last_updated is greater than value | [optional] |
|
409
|
+
| **pulp_last_updated__gte** | **Time** | Filter results where pulp_last_updated is greater than or equal to value | [optional] |
|
410
|
+
| **pulp_last_updated__isnull** | **Boolean** | Filter results where pulp_last_updated has a null value | [optional] |
|
411
|
+
| **pulp_last_updated__lt** | **Time** | Filter results where pulp_last_updated is less than value | [optional] |
|
412
|
+
| **pulp_last_updated__lte** | **Time** | Filter results where pulp_last_updated is less than or equal to value | [optional] |
|
413
|
+
| **pulp_last_updated__range** | [**Array<Time>**](Time.md) | Filter results where pulp_last_updated is between two comma separated values | [optional] |
|
414
|
+
| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
|
415
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
416
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
331
417
|
|
332
418
|
### Return type
|
333
419
|
|
@@ -345,16 +431,16 @@ Name | Type | Description | Notes
|
|
345
431
|
|
346
432
|
## list_roles
|
347
433
|
|
348
|
-
> ObjectRolesResponse list_roles(python_python_remote_href, opts)
|
434
|
+
> <ObjectRolesResponse> list_roles(python_python_remote_href, opts)
|
349
435
|
|
350
436
|
List roles
|
351
437
|
|
352
438
|
List roles assigned to this object.
|
353
439
|
|
354
|
-
###
|
440
|
+
### Examples
|
355
441
|
|
356
442
|
```ruby
|
357
|
-
|
443
|
+
require 'time'
|
358
444
|
require 'pulp_python_client'
|
359
445
|
# setup authorization
|
360
446
|
PulpPythonClient.configure do |config|
|
@@ -366,27 +452,44 @@ end
|
|
366
452
|
api_instance = PulpPythonClient::RemotesPythonApi.new
|
367
453
|
python_python_remote_href = 'python_python_remote_href_example' # String |
|
368
454
|
opts = {
|
369
|
-
fields: ['
|
370
|
-
exclude_fields: ['
|
455
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
456
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
371
457
|
}
|
372
458
|
|
373
459
|
begin
|
374
|
-
#List roles
|
460
|
+
# List roles
|
375
461
|
result = api_instance.list_roles(python_python_remote_href, opts)
|
376
462
|
p result
|
377
463
|
rescue PulpPythonClient::ApiError => e
|
378
|
-
puts "
|
464
|
+
puts "Error when calling RemotesPythonApi->list_roles: #{e}"
|
379
465
|
end
|
380
466
|
```
|
381
467
|
|
382
|
-
|
468
|
+
#### Using the list_roles_with_http_info variant
|
469
|
+
|
470
|
+
This returns an Array which contains the response data, status code and headers.
|
471
|
+
|
472
|
+
> <Array(<ObjectRolesResponse>, Integer, Hash)> list_roles_with_http_info(python_python_remote_href, opts)
|
473
|
+
|
474
|
+
```ruby
|
475
|
+
begin
|
476
|
+
# List roles
|
477
|
+
data, status_code, headers = api_instance.list_roles_with_http_info(python_python_remote_href, opts)
|
478
|
+
p status_code # => 2xx
|
479
|
+
p headers # => { ... }
|
480
|
+
p data # => <ObjectRolesResponse>
|
481
|
+
rescue PulpPythonClient::ApiError => e
|
482
|
+
puts "Error when calling RemotesPythonApi->list_roles_with_http_info: #{e}"
|
483
|
+
end
|
484
|
+
```
|
383
485
|
|
486
|
+
### Parameters
|
384
487
|
|
385
|
-
Name | Type | Description
|
386
|
-
|
387
|
-
**python_python_remote_href** | **String
|
388
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
389
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
488
|
+
| Name | Type | Description | Notes |
|
489
|
+
| ---- | ---- | ----------- | ----- |
|
490
|
+
| **python_python_remote_href** | **String** | | |
|
491
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
492
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
390
493
|
|
391
494
|
### Return type
|
392
495
|
|
@@ -404,16 +507,16 @@ Name | Type | Description | Notes
|
|
404
507
|
|
405
508
|
## my_permissions
|
406
509
|
|
407
|
-
> MyPermissionsResponse my_permissions(python_python_remote_href, opts)
|
510
|
+
> <MyPermissionsResponse> my_permissions(python_python_remote_href, opts)
|
408
511
|
|
409
512
|
List user permissions
|
410
513
|
|
411
514
|
List permissions available to the current user on this object.
|
412
515
|
|
413
|
-
###
|
516
|
+
### Examples
|
414
517
|
|
415
518
|
```ruby
|
416
|
-
|
519
|
+
require 'time'
|
417
520
|
require 'pulp_python_client'
|
418
521
|
# setup authorization
|
419
522
|
PulpPythonClient.configure do |config|
|
@@ -425,27 +528,44 @@ end
|
|
425
528
|
api_instance = PulpPythonClient::RemotesPythonApi.new
|
426
529
|
python_python_remote_href = 'python_python_remote_href_example' # String |
|
427
530
|
opts = {
|
428
|
-
fields: ['
|
429
|
-
exclude_fields: ['
|
531
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
532
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
430
533
|
}
|
431
534
|
|
432
535
|
begin
|
433
|
-
#List user permissions
|
536
|
+
# List user permissions
|
434
537
|
result = api_instance.my_permissions(python_python_remote_href, opts)
|
435
538
|
p result
|
436
539
|
rescue PulpPythonClient::ApiError => e
|
437
|
-
puts "
|
540
|
+
puts "Error when calling RemotesPythonApi->my_permissions: #{e}"
|
438
541
|
end
|
439
542
|
```
|
440
543
|
|
441
|
-
|
544
|
+
#### Using the my_permissions_with_http_info variant
|
442
545
|
|
546
|
+
This returns an Array which contains the response data, status code and headers.
|
443
547
|
|
444
|
-
|
445
|
-
|
446
|
-
|
447
|
-
|
448
|
-
|
548
|
+
> <Array(<MyPermissionsResponse>, Integer, Hash)> my_permissions_with_http_info(python_python_remote_href, opts)
|
549
|
+
|
550
|
+
```ruby
|
551
|
+
begin
|
552
|
+
# List user permissions
|
553
|
+
data, status_code, headers = api_instance.my_permissions_with_http_info(python_python_remote_href, opts)
|
554
|
+
p status_code # => 2xx
|
555
|
+
p headers # => { ... }
|
556
|
+
p data # => <MyPermissionsResponse>
|
557
|
+
rescue PulpPythonClient::ApiError => e
|
558
|
+
puts "Error when calling RemotesPythonApi->my_permissions_with_http_info: #{e}"
|
559
|
+
end
|
560
|
+
```
|
561
|
+
|
562
|
+
### Parameters
|
563
|
+
|
564
|
+
| Name | Type | Description | Notes |
|
565
|
+
| ---- | ---- | ----------- | ----- |
|
566
|
+
| **python_python_remote_href** | **String** | | |
|
567
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
568
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
449
569
|
|
450
570
|
### Return type
|
451
571
|
|
@@ -463,16 +583,16 @@ Name | Type | Description | Notes
|
|
463
583
|
|
464
584
|
## partial_update
|
465
585
|
|
466
|
-
> AsyncOperationResponse partial_update(python_python_remote_href, patchedpython_python_remote)
|
586
|
+
> <AsyncOperationResponse> partial_update(python_python_remote_href, patchedpython_python_remote)
|
467
587
|
|
468
588
|
Update a python remote
|
469
589
|
|
470
590
|
Trigger an asynchronous partial update task
|
471
591
|
|
472
|
-
###
|
592
|
+
### Examples
|
473
593
|
|
474
594
|
```ruby
|
475
|
-
|
595
|
+
require 'time'
|
476
596
|
require 'pulp_python_client'
|
477
597
|
# setup authorization
|
478
598
|
PulpPythonClient.configure do |config|
|
@@ -486,21 +606,38 @@ python_python_remote_href = 'python_python_remote_href_example' # String |
|
|
486
606
|
patchedpython_python_remote = PulpPythonClient::PatchedpythonPythonRemote.new # PatchedpythonPythonRemote |
|
487
607
|
|
488
608
|
begin
|
489
|
-
#Update a python remote
|
609
|
+
# Update a python remote
|
490
610
|
result = api_instance.partial_update(python_python_remote_href, patchedpython_python_remote)
|
491
611
|
p result
|
492
612
|
rescue PulpPythonClient::ApiError => e
|
493
|
-
puts "
|
613
|
+
puts "Error when calling RemotesPythonApi->partial_update: #{e}"
|
494
614
|
end
|
495
615
|
```
|
496
616
|
|
497
|
-
|
617
|
+
#### Using the partial_update_with_http_info variant
|
498
618
|
|
619
|
+
This returns an Array which contains the response data, status code and headers.
|
499
620
|
|
500
|
-
|
501
|
-
|
502
|
-
|
503
|
-
|
621
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> partial_update_with_http_info(python_python_remote_href, patchedpython_python_remote)
|
622
|
+
|
623
|
+
```ruby
|
624
|
+
begin
|
625
|
+
# Update a python remote
|
626
|
+
data, status_code, headers = api_instance.partial_update_with_http_info(python_python_remote_href, patchedpython_python_remote)
|
627
|
+
p status_code # => 2xx
|
628
|
+
p headers # => { ... }
|
629
|
+
p data # => <AsyncOperationResponse>
|
630
|
+
rescue PulpPythonClient::ApiError => e
|
631
|
+
puts "Error when calling RemotesPythonApi->partial_update_with_http_info: #{e}"
|
632
|
+
end
|
633
|
+
```
|
634
|
+
|
635
|
+
### Parameters
|
636
|
+
|
637
|
+
| Name | Type | Description | Notes |
|
638
|
+
| ---- | ---- | ----------- | ----- |
|
639
|
+
| **python_python_remote_href** | **String** | | |
|
640
|
+
| **patchedpython_python_remote** | [**PatchedpythonPythonRemote**](PatchedpythonPythonRemote.md) | | |
|
504
641
|
|
505
642
|
### Return type
|
506
643
|
|
@@ -518,16 +655,16 @@ Name | Type | Description | Notes
|
|
518
655
|
|
519
656
|
## read
|
520
657
|
|
521
|
-
> PythonPythonRemoteResponse read(python_python_remote_href, opts)
|
658
|
+
> <PythonPythonRemoteResponse> read(python_python_remote_href, opts)
|
522
659
|
|
523
660
|
Inspect a python remote
|
524
661
|
|
525
662
|
Python Remotes are representations of an external repository of Python content, eg. PyPI. Fields include upstream repository config. Python Remotes are also used to `sync` from upstream repositories, and contains sync settings.
|
526
663
|
|
527
|
-
###
|
664
|
+
### Examples
|
528
665
|
|
529
666
|
```ruby
|
530
|
-
|
667
|
+
require 'time'
|
531
668
|
require 'pulp_python_client'
|
532
669
|
# setup authorization
|
533
670
|
PulpPythonClient.configure do |config|
|
@@ -539,27 +676,44 @@ end
|
|
539
676
|
api_instance = PulpPythonClient::RemotesPythonApi.new
|
540
677
|
python_python_remote_href = 'python_python_remote_href_example' # String |
|
541
678
|
opts = {
|
542
|
-
fields: ['
|
543
|
-
exclude_fields: ['
|
679
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
680
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
544
681
|
}
|
545
682
|
|
546
683
|
begin
|
547
|
-
#Inspect a python remote
|
684
|
+
# Inspect a python remote
|
548
685
|
result = api_instance.read(python_python_remote_href, opts)
|
549
686
|
p result
|
550
687
|
rescue PulpPythonClient::ApiError => e
|
551
|
-
puts "
|
688
|
+
puts "Error when calling RemotesPythonApi->read: #{e}"
|
552
689
|
end
|
553
690
|
```
|
554
691
|
|
555
|
-
|
692
|
+
#### Using the read_with_http_info variant
|
556
693
|
|
694
|
+
This returns an Array which contains the response data, status code and headers.
|
557
695
|
|
558
|
-
|
559
|
-
|
560
|
-
|
561
|
-
|
562
|
-
|
696
|
+
> <Array(<PythonPythonRemoteResponse>, Integer, Hash)> read_with_http_info(python_python_remote_href, opts)
|
697
|
+
|
698
|
+
```ruby
|
699
|
+
begin
|
700
|
+
# Inspect a python remote
|
701
|
+
data, status_code, headers = api_instance.read_with_http_info(python_python_remote_href, opts)
|
702
|
+
p status_code # => 2xx
|
703
|
+
p headers # => { ... }
|
704
|
+
p data # => <PythonPythonRemoteResponse>
|
705
|
+
rescue PulpPythonClient::ApiError => e
|
706
|
+
puts "Error when calling RemotesPythonApi->read_with_http_info: #{e}"
|
707
|
+
end
|
708
|
+
```
|
709
|
+
|
710
|
+
### Parameters
|
711
|
+
|
712
|
+
| Name | Type | Description | Notes |
|
713
|
+
| ---- | ---- | ----------- | ----- |
|
714
|
+
| **python_python_remote_href** | **String** | | |
|
715
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
716
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
563
717
|
|
564
718
|
### Return type
|
565
719
|
|
@@ -577,16 +731,16 @@ Name | Type | Description | Notes
|
|
577
731
|
|
578
732
|
## remove_role
|
579
733
|
|
580
|
-
> NestedRoleResponse remove_role(python_python_remote_href, nested_role)
|
734
|
+
> <NestedRoleResponse> remove_role(python_python_remote_href, nested_role)
|
581
735
|
|
582
736
|
Remove a role
|
583
737
|
|
584
738
|
Remove a role for this object from users/groups.
|
585
739
|
|
586
|
-
###
|
740
|
+
### Examples
|
587
741
|
|
588
742
|
```ruby
|
589
|
-
|
743
|
+
require 'time'
|
590
744
|
require 'pulp_python_client'
|
591
745
|
# setup authorization
|
592
746
|
PulpPythonClient.configure do |config|
|
@@ -597,24 +751,41 @@ end
|
|
597
751
|
|
598
752
|
api_instance = PulpPythonClient::RemotesPythonApi.new
|
599
753
|
python_python_remote_href = 'python_python_remote_href_example' # String |
|
600
|
-
nested_role = PulpPythonClient::NestedRole.new # NestedRole |
|
754
|
+
nested_role = PulpPythonClient::NestedRole.new({role: 'role_example'}) # NestedRole |
|
601
755
|
|
602
756
|
begin
|
603
|
-
#Remove a role
|
757
|
+
# Remove a role
|
604
758
|
result = api_instance.remove_role(python_python_remote_href, nested_role)
|
605
759
|
p result
|
606
760
|
rescue PulpPythonClient::ApiError => e
|
607
|
-
puts "
|
761
|
+
puts "Error when calling RemotesPythonApi->remove_role: #{e}"
|
608
762
|
end
|
609
763
|
```
|
610
764
|
|
611
|
-
|
765
|
+
#### Using the remove_role_with_http_info variant
|
766
|
+
|
767
|
+
This returns an Array which contains the response data, status code and headers.
|
612
768
|
|
769
|
+
> <Array(<NestedRoleResponse>, Integer, Hash)> remove_role_with_http_info(python_python_remote_href, nested_role)
|
613
770
|
|
614
|
-
|
615
|
-
|
616
|
-
|
617
|
-
|
771
|
+
```ruby
|
772
|
+
begin
|
773
|
+
# Remove a role
|
774
|
+
data, status_code, headers = api_instance.remove_role_with_http_info(python_python_remote_href, nested_role)
|
775
|
+
p status_code # => 2xx
|
776
|
+
p headers # => { ... }
|
777
|
+
p data # => <NestedRoleResponse>
|
778
|
+
rescue PulpPythonClient::ApiError => e
|
779
|
+
puts "Error when calling RemotesPythonApi->remove_role_with_http_info: #{e}"
|
780
|
+
end
|
781
|
+
```
|
782
|
+
|
783
|
+
### Parameters
|
784
|
+
|
785
|
+
| Name | Type | Description | Notes |
|
786
|
+
| ---- | ---- | ----------- | ----- |
|
787
|
+
| **python_python_remote_href** | **String** | | |
|
788
|
+
| **nested_role** | [**NestedRole**](NestedRole.md) | | |
|
618
789
|
|
619
790
|
### Return type
|
620
791
|
|
@@ -632,16 +803,16 @@ Name | Type | Description | Notes
|
|
632
803
|
|
633
804
|
## set_label
|
634
805
|
|
635
|
-
> SetLabelResponse set_label(python_python_remote_href, set_label)
|
806
|
+
> <SetLabelResponse> set_label(python_python_remote_href, set_label)
|
636
807
|
|
637
808
|
Set a label
|
638
809
|
|
639
810
|
Set a single pulp_label on the object to a specific value or null.
|
640
811
|
|
641
|
-
###
|
812
|
+
### Examples
|
642
813
|
|
643
814
|
```ruby
|
644
|
-
|
815
|
+
require 'time'
|
645
816
|
require 'pulp_python_client'
|
646
817
|
# setup authorization
|
647
818
|
PulpPythonClient.configure do |config|
|
@@ -652,24 +823,41 @@ end
|
|
652
823
|
|
653
824
|
api_instance = PulpPythonClient::RemotesPythonApi.new
|
654
825
|
python_python_remote_href = 'python_python_remote_href_example' # String |
|
655
|
-
set_label = PulpPythonClient::SetLabel.new # SetLabel |
|
826
|
+
set_label = PulpPythonClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel |
|
656
827
|
|
657
828
|
begin
|
658
|
-
#Set a label
|
829
|
+
# Set a label
|
659
830
|
result = api_instance.set_label(python_python_remote_href, set_label)
|
660
831
|
p result
|
661
832
|
rescue PulpPythonClient::ApiError => e
|
662
|
-
puts "
|
833
|
+
puts "Error when calling RemotesPythonApi->set_label: #{e}"
|
663
834
|
end
|
664
835
|
```
|
665
836
|
|
666
|
-
|
837
|
+
#### Using the set_label_with_http_info variant
|
838
|
+
|
839
|
+
This returns an Array which contains the response data, status code and headers.
|
840
|
+
|
841
|
+
> <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(python_python_remote_href, set_label)
|
842
|
+
|
843
|
+
```ruby
|
844
|
+
begin
|
845
|
+
# Set a label
|
846
|
+
data, status_code, headers = api_instance.set_label_with_http_info(python_python_remote_href, set_label)
|
847
|
+
p status_code # => 2xx
|
848
|
+
p headers # => { ... }
|
849
|
+
p data # => <SetLabelResponse>
|
850
|
+
rescue PulpPythonClient::ApiError => e
|
851
|
+
puts "Error when calling RemotesPythonApi->set_label_with_http_info: #{e}"
|
852
|
+
end
|
853
|
+
```
|
667
854
|
|
855
|
+
### Parameters
|
668
856
|
|
669
|
-
Name | Type | Description
|
670
|
-
|
671
|
-
**python_python_remote_href** | **String
|
672
|
-
**set_label** | [**SetLabel**](SetLabel.md)| |
|
857
|
+
| Name | Type | Description | Notes |
|
858
|
+
| ---- | ---- | ----------- | ----- |
|
859
|
+
| **python_python_remote_href** | **String** | | |
|
860
|
+
| **set_label** | [**SetLabel**](SetLabel.md) | | |
|
673
861
|
|
674
862
|
### Return type
|
675
863
|
|
@@ -687,16 +875,16 @@ Name | Type | Description | Notes
|
|
687
875
|
|
688
876
|
## unset_label
|
689
877
|
|
690
|
-
> UnsetLabelResponse unset_label(python_python_remote_href, unset_label)
|
878
|
+
> <UnsetLabelResponse> unset_label(python_python_remote_href, unset_label)
|
691
879
|
|
692
880
|
Unset a label
|
693
881
|
|
694
882
|
Unset a single pulp_label on the object.
|
695
883
|
|
696
|
-
###
|
884
|
+
### Examples
|
697
885
|
|
698
886
|
```ruby
|
699
|
-
|
887
|
+
require 'time'
|
700
888
|
require 'pulp_python_client'
|
701
889
|
# setup authorization
|
702
890
|
PulpPythonClient.configure do |config|
|
@@ -707,24 +895,41 @@ end
|
|
707
895
|
|
708
896
|
api_instance = PulpPythonClient::RemotesPythonApi.new
|
709
897
|
python_python_remote_href = 'python_python_remote_href_example' # String |
|
710
|
-
unset_label = PulpPythonClient::UnsetLabel.new # UnsetLabel |
|
898
|
+
unset_label = PulpPythonClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel |
|
711
899
|
|
712
900
|
begin
|
713
|
-
#Unset a label
|
901
|
+
# Unset a label
|
714
902
|
result = api_instance.unset_label(python_python_remote_href, unset_label)
|
715
903
|
p result
|
716
904
|
rescue PulpPythonClient::ApiError => e
|
717
|
-
puts "
|
905
|
+
puts "Error when calling RemotesPythonApi->unset_label: #{e}"
|
718
906
|
end
|
719
907
|
```
|
720
908
|
|
721
|
-
|
909
|
+
#### Using the unset_label_with_http_info variant
|
910
|
+
|
911
|
+
This returns an Array which contains the response data, status code and headers.
|
912
|
+
|
913
|
+
> <Array(<UnsetLabelResponse>, Integer, Hash)> unset_label_with_http_info(python_python_remote_href, unset_label)
|
914
|
+
|
915
|
+
```ruby
|
916
|
+
begin
|
917
|
+
# Unset a label
|
918
|
+
data, status_code, headers = api_instance.unset_label_with_http_info(python_python_remote_href, unset_label)
|
919
|
+
p status_code # => 2xx
|
920
|
+
p headers # => { ... }
|
921
|
+
p data # => <UnsetLabelResponse>
|
922
|
+
rescue PulpPythonClient::ApiError => e
|
923
|
+
puts "Error when calling RemotesPythonApi->unset_label_with_http_info: #{e}"
|
924
|
+
end
|
925
|
+
```
|
722
926
|
|
927
|
+
### Parameters
|
723
928
|
|
724
|
-
Name | Type | Description
|
725
|
-
|
726
|
-
**python_python_remote_href** | **String
|
727
|
-
**unset_label** | [**UnsetLabel**](UnsetLabel.md)| |
|
929
|
+
| Name | Type | Description | Notes |
|
930
|
+
| ---- | ---- | ----------- | ----- |
|
931
|
+
| **python_python_remote_href** | **String** | | |
|
932
|
+
| **unset_label** | [**UnsetLabel**](UnsetLabel.md) | | |
|
728
933
|
|
729
934
|
### Return type
|
730
935
|
|
@@ -742,16 +947,16 @@ Name | Type | Description | Notes
|
|
742
947
|
|
743
948
|
## update
|
744
949
|
|
745
|
-
> AsyncOperationResponse update(python_python_remote_href, python_python_remote)
|
950
|
+
> <AsyncOperationResponse> update(python_python_remote_href, python_python_remote)
|
746
951
|
|
747
952
|
Update a python remote
|
748
953
|
|
749
954
|
Trigger an asynchronous update task
|
750
955
|
|
751
|
-
###
|
956
|
+
### Examples
|
752
957
|
|
753
958
|
```ruby
|
754
|
-
|
959
|
+
require 'time'
|
755
960
|
require 'pulp_python_client'
|
756
961
|
# setup authorization
|
757
962
|
PulpPythonClient.configure do |config|
|
@@ -762,24 +967,41 @@ end
|
|
762
967
|
|
763
968
|
api_instance = PulpPythonClient::RemotesPythonApi.new
|
764
969
|
python_python_remote_href = 'python_python_remote_href_example' # String |
|
765
|
-
python_python_remote = PulpPythonClient::PythonPythonRemote.new # PythonPythonRemote |
|
970
|
+
python_python_remote = PulpPythonClient::PythonPythonRemote.new({name: 'name_example', url: 'url_example'}) # PythonPythonRemote |
|
766
971
|
|
767
972
|
begin
|
768
|
-
#Update a python remote
|
973
|
+
# Update a python remote
|
769
974
|
result = api_instance.update(python_python_remote_href, python_python_remote)
|
770
975
|
p result
|
771
976
|
rescue PulpPythonClient::ApiError => e
|
772
|
-
puts "
|
977
|
+
puts "Error when calling RemotesPythonApi->update: #{e}"
|
773
978
|
end
|
774
979
|
```
|
775
980
|
|
776
|
-
|
981
|
+
#### Using the update_with_http_info variant
|
982
|
+
|
983
|
+
This returns an Array which contains the response data, status code and headers.
|
777
984
|
|
985
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> update_with_http_info(python_python_remote_href, python_python_remote)
|
986
|
+
|
987
|
+
```ruby
|
988
|
+
begin
|
989
|
+
# Update a python remote
|
990
|
+
data, status_code, headers = api_instance.update_with_http_info(python_python_remote_href, python_python_remote)
|
991
|
+
p status_code # => 2xx
|
992
|
+
p headers # => { ... }
|
993
|
+
p data # => <AsyncOperationResponse>
|
994
|
+
rescue PulpPythonClient::ApiError => e
|
995
|
+
puts "Error when calling RemotesPythonApi->update_with_http_info: #{e}"
|
996
|
+
end
|
997
|
+
```
|
998
|
+
|
999
|
+
### Parameters
|
778
1000
|
|
779
|
-
Name | Type | Description
|
780
|
-
|
781
|
-
**python_python_remote_href** | **String
|
782
|
-
**python_python_remote** | [**PythonPythonRemote**](PythonPythonRemote.md)| |
|
1001
|
+
| Name | Type | Description | Notes |
|
1002
|
+
| ---- | ---- | ----------- | ----- |
|
1003
|
+
| **python_python_remote_href** | **String** | | |
|
1004
|
+
| **python_python_remote** | [**PythonPythonRemote**](PythonPythonRemote.md) | | |
|
783
1005
|
|
784
1006
|
### Return type
|
785
1007
|
|