pulp_python_client 3.11.4 → 3.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +31 -11
- data/docs/ContentPackagesApi.md +13 -13
- data/docs/DistributionsPypiApi.md +233 -1
- data/docs/MyPermissionsResponse.md +17 -0
- data/docs/NestedRole.md +21 -0
- data/docs/NestedRoleResponse.md +21 -0
- data/docs/ObjectRolesResponse.md +17 -0
- data/docs/PackageMetadataResponse.md +3 -3
- data/docs/PublicationsPypiApi.md +233 -1
- data/docs/PypiApi.md +8 -2
- data/docs/PypiLegacyApi.md +1 -1
- data/docs/PypiMetadataApi.md +8 -2
- data/docs/PypiSimpleApi.md +1 -1
- data/docs/PythonPythonPackageContent.md +6 -6
- data/docs/PythonPythonPackageContentResponse.md +6 -6
- data/docs/RemotesPythonApi.md +233 -1
- data/docs/RepositoriesPythonApi.md +233 -1
- data/docs/RepositoriesPythonVersionsApi.md +1 -1
- data/lib/pulp_python_client/api/content_packages_api.rb +12 -12
- data/lib/pulp_python_client/api/distributions_pypi_api.rb +276 -0
- data/lib/pulp_python_client/api/publications_pypi_api.rb +276 -0
- data/lib/pulp_python_client/api/pypi_api.rb +1 -1
- data/lib/pulp_python_client/api/pypi_metadata_api.rb +1 -1
- data/lib/pulp_python_client/api/remotes_python_api.rb +276 -0
- data/lib/pulp_python_client/api/repositories_python_api.rb +276 -0
- data/lib/pulp_python_client/configuration.rb +2 -2
- data/lib/pulp_python_client/models/my_permissions_response.rb +213 -0
- data/lib/pulp_python_client/models/nested_role.rb +253 -0
- data/lib/pulp_python_client/models/nested_role_response.rb +234 -0
- data/lib/pulp_python_client/models/object_roles_response.rb +213 -0
- data/lib/pulp_python_client/models/package_metadata_response.rb +3 -3
- data/lib/pulp_python_client/models/package_upload_task_response.rb +2 -10
- data/lib/pulp_python_client/models/python_python_package_content.rb +6 -6
- data/lib/pulp_python_client/models/python_python_package_content_response.rb +6 -6
- data/lib/pulp_python_client/version.rb +1 -1
- data/lib/pulp_python_client.rb +4 -0
- data/spec/api/content_packages_api_spec.rb +6 -6
- data/spec/api/distributions_pypi_api_spec.rb +54 -0
- data/spec/api/publications_pypi_api_spec.rb +54 -0
- data/spec/api/remotes_python_api_spec.rb +54 -0
- data/spec/api/repositories_python_api_spec.rb +54 -0
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/my_permissions_response_spec.rb +41 -0
- data/spec/models/nested_role_response_spec.rb +53 -0
- data/spec/models/nested_role_spec.rb +53 -0
- data/spec/models/object_roles_response_spec.rb +41 -0
- metadata +68 -52
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c1a750d6b6d4a7110a6faabcf0a5f4634b097501e685e6332cd69bab7d92d477
|
4
|
+
data.tar.gz: ce3abfcacfffc2a937c99fe6418bf2f7fbb5ebe7cae539d6fd136e7bb8d72ed6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e476276f6ead0e1cb94d9cb772d6cd0c432294cf812ff3548a0ad6e480f1f9ad3aa137d5704ede85b1bbcc2ba38f43d4ef9a73351a1b74e2a9c70a35e6a73410
|
7
|
+
data.tar.gz: 1480d47f402ef4ee306c87f76d4101bf7d7e878dfce5fdd8834ee3927db6722745ebfd3bdb0184937fc8a8e9fcfe384186f478efb9ed6748fa56d82e0850f3a1
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ Fetch, Upload, Organize, and Distribute Software Packages
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: v3
|
10
|
-
- Package version: 3.
|
10
|
+
- Package version: 3.12.0
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://pulpproject.org](https://pulpproject.org)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build pulp_python_client.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./pulp_python_client-3.
|
27
|
+
gem install ./pulp_python_client-3.12.0.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./pulp_python_client-3.
|
30
|
+
(for development, run `gem install --dev ./pulp_python_client-3.12.0.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'pulp_python_client', '~> 3.
|
36
|
+
gem 'pulp_python_client', '~> 3.12.0'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -85,14 +85,14 @@ opts = {
|
|
85
85
|
license: 'license_example', # String | Text indicating the license covering the distribution
|
86
86
|
requires_python: 'requires_python_example', # String | The Python version(s) that the distribution is guaranteed to be compatible with.
|
87
87
|
project_url: 'project_url_example', # String | A browsable URL for the project and a label for it, separated by a comma.
|
88
|
-
project_urls:
|
88
|
+
project_urls: PulpPythonClient::AnyType.new, # AnyType | A dictionary of labels and URLs for the project.
|
89
89
|
platform: 'platform_example', # String | A comma-separated list of platform specifications, summarizing the operating systems supported by the package.
|
90
90
|
supported_platform: 'supported_platform_example', # String | Field to specify the OS and CPU for which the binary package was compiled.
|
91
|
-
requires_dist:
|
92
|
-
provides_dist:
|
93
|
-
obsoletes_dist:
|
94
|
-
requires_external:
|
95
|
-
classifiers:
|
91
|
+
requires_dist: PulpPythonClient::AnyType.new, # AnyType | A JSON list containing names of some other distutils project required by this distribution.
|
92
|
+
provides_dist: PulpPythonClient::AnyType.new, # AnyType | A JSON list containing names of a Distutils project which is contained within this distribution.
|
93
|
+
obsoletes_dist: PulpPythonClient::AnyType.new, # AnyType | A JSON list containing names of a distutils project's distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time.
|
94
|
+
requires_external: PulpPythonClient::AnyType.new, # AnyType | A JSON list containing some dependency in the system that the distribution is to be used.
|
95
|
+
classifiers: PulpPythonClient::AnyType.new # AnyType | A JSON list containing classification values for a Python package.
|
96
96
|
}
|
97
97
|
|
98
98
|
begin
|
@@ -107,46 +107,62 @@ end
|
|
107
107
|
|
108
108
|
## Documentation for API Endpoints
|
109
109
|
|
110
|
-
All URIs are relative to *http://
|
110
|
+
All URIs are relative to *http://pulp*
|
111
111
|
|
112
112
|
Class | Method | HTTP request | Description
|
113
113
|
------------ | ------------- | ------------- | -------------
|
114
114
|
*PulpPythonClient::ContentPackagesApi* | [**create**](docs/ContentPackagesApi.md#create) | **POST** /pulp/api/v3/content/python/packages/ | Create a python package content
|
115
115
|
*PulpPythonClient::ContentPackagesApi* | [**list**](docs/ContentPackagesApi.md#list) | **GET** /pulp/api/v3/content/python/packages/ | List python package contents
|
116
116
|
*PulpPythonClient::ContentPackagesApi* | [**read**](docs/ContentPackagesApi.md#read) | **GET** {python_python_package_content_href} | Inspect a python package content
|
117
|
+
*PulpPythonClient::DistributionsPypiApi* | [**add_role**](docs/DistributionsPypiApi.md#add_role) | **POST** {python_python_distribution_href}add_role/ | Add a role
|
117
118
|
*PulpPythonClient::DistributionsPypiApi* | [**create**](docs/DistributionsPypiApi.md#create) | **POST** /pulp/api/v3/distributions/python/pypi/ | Create a python distribution
|
118
119
|
*PulpPythonClient::DistributionsPypiApi* | [**delete**](docs/DistributionsPypiApi.md#delete) | **DELETE** {python_python_distribution_href} | Delete a python distribution
|
119
120
|
*PulpPythonClient::DistributionsPypiApi* | [**list**](docs/DistributionsPypiApi.md#list) | **GET** /pulp/api/v3/distributions/python/pypi/ | List python distributions
|
121
|
+
*PulpPythonClient::DistributionsPypiApi* | [**list_roles**](docs/DistributionsPypiApi.md#list_roles) | **GET** {python_python_distribution_href}list_roles/ | List roles
|
122
|
+
*PulpPythonClient::DistributionsPypiApi* | [**my_permissions**](docs/DistributionsPypiApi.md#my_permissions) | **GET** {python_python_distribution_href}my_permissions/ | List user permissions
|
120
123
|
*PulpPythonClient::DistributionsPypiApi* | [**partial_update**](docs/DistributionsPypiApi.md#partial_update) | **PATCH** {python_python_distribution_href} | Update a python distribution
|
121
124
|
*PulpPythonClient::DistributionsPypiApi* | [**read**](docs/DistributionsPypiApi.md#read) | **GET** {python_python_distribution_href} | Inspect a python distribution
|
125
|
+
*PulpPythonClient::DistributionsPypiApi* | [**remove_role**](docs/DistributionsPypiApi.md#remove_role) | **POST** {python_python_distribution_href}remove_role/ | Remove a role
|
122
126
|
*PulpPythonClient::DistributionsPypiApi* | [**set_label**](docs/DistributionsPypiApi.md#set_label) | **POST** {python_python_distribution_href}set_label/ | Set a label
|
123
127
|
*PulpPythonClient::DistributionsPypiApi* | [**unset_label**](docs/DistributionsPypiApi.md#unset_label) | **POST** {python_python_distribution_href}unset_label/ | Unset a label
|
124
128
|
*PulpPythonClient::DistributionsPypiApi* | [**update**](docs/DistributionsPypiApi.md#update) | **PUT** {python_python_distribution_href} | Update a python distribution
|
129
|
+
*PulpPythonClient::PublicationsPypiApi* | [**add_role**](docs/PublicationsPypiApi.md#add_role) | **POST** {python_python_publication_href}add_role/ | Add a role
|
125
130
|
*PulpPythonClient::PublicationsPypiApi* | [**create**](docs/PublicationsPypiApi.md#create) | **POST** /pulp/api/v3/publications/python/pypi/ | Create a python publication
|
126
131
|
*PulpPythonClient::PublicationsPypiApi* | [**delete**](docs/PublicationsPypiApi.md#delete) | **DELETE** {python_python_publication_href} | Delete a python publication
|
127
132
|
*PulpPythonClient::PublicationsPypiApi* | [**list**](docs/PublicationsPypiApi.md#list) | **GET** /pulp/api/v3/publications/python/pypi/ | List python publications
|
133
|
+
*PulpPythonClient::PublicationsPypiApi* | [**list_roles**](docs/PublicationsPypiApi.md#list_roles) | **GET** {python_python_publication_href}list_roles/ | List roles
|
134
|
+
*PulpPythonClient::PublicationsPypiApi* | [**my_permissions**](docs/PublicationsPypiApi.md#my_permissions) | **GET** {python_python_publication_href}my_permissions/ | List user permissions
|
128
135
|
*PulpPythonClient::PublicationsPypiApi* | [**read**](docs/PublicationsPypiApi.md#read) | **GET** {python_python_publication_href} | Inspect a python publication
|
136
|
+
*PulpPythonClient::PublicationsPypiApi* | [**remove_role**](docs/PublicationsPypiApi.md#remove_role) | **POST** {python_python_publication_href}remove_role/ | Remove a role
|
129
137
|
*PulpPythonClient::PypiApi* | [**read**](docs/PypiApi.md#read) | **GET** /pypi/{path}/ | Get index summary
|
130
138
|
*PulpPythonClient::PypiLegacyApi* | [**create**](docs/PypiLegacyApi.md#create) | **POST** /pypi/{path}/legacy/ | Upload a package
|
131
139
|
*PulpPythonClient::PypiMetadataApi* | [**read**](docs/PypiMetadataApi.md#read) | **GET** /pypi/{path}/pypi/{meta}/ | Get package metadata
|
132
140
|
*PulpPythonClient::PypiSimpleApi* | [**create**](docs/PypiSimpleApi.md#create) | **POST** /pypi/{path}/simple/ | Upload a package
|
133
141
|
*PulpPythonClient::PypiSimpleApi* | [**pypi_simple_package_read**](docs/PypiSimpleApi.md#pypi_simple_package_read) | **GET** /pypi/{path}/simple/{package}/ | Get package simple page
|
134
142
|
*PulpPythonClient::PypiSimpleApi* | [**read**](docs/PypiSimpleApi.md#read) | **GET** /pypi/{path}/simple/ | Get index simple page
|
143
|
+
*PulpPythonClient::RemotesPythonApi* | [**add_role**](docs/RemotesPythonApi.md#add_role) | **POST** {python_python_remote_href}add_role/ | Add a role
|
135
144
|
*PulpPythonClient::RemotesPythonApi* | [**create**](docs/RemotesPythonApi.md#create) | **POST** /pulp/api/v3/remotes/python/python/ | Create a python remote
|
136
145
|
*PulpPythonClient::RemotesPythonApi* | [**delete**](docs/RemotesPythonApi.md#delete) | **DELETE** {python_python_remote_href} | Delete a python remote
|
137
146
|
*PulpPythonClient::RemotesPythonApi* | [**from_bandersnatch**](docs/RemotesPythonApi.md#from_bandersnatch) | **POST** /pulp/api/v3/remotes/python/python/from_bandersnatch/ | Create from Bandersnatch
|
138
147
|
*PulpPythonClient::RemotesPythonApi* | [**list**](docs/RemotesPythonApi.md#list) | **GET** /pulp/api/v3/remotes/python/python/ | List python remotes
|
148
|
+
*PulpPythonClient::RemotesPythonApi* | [**list_roles**](docs/RemotesPythonApi.md#list_roles) | **GET** {python_python_remote_href}list_roles/ | List roles
|
149
|
+
*PulpPythonClient::RemotesPythonApi* | [**my_permissions**](docs/RemotesPythonApi.md#my_permissions) | **GET** {python_python_remote_href}my_permissions/ | List user permissions
|
139
150
|
*PulpPythonClient::RemotesPythonApi* | [**partial_update**](docs/RemotesPythonApi.md#partial_update) | **PATCH** {python_python_remote_href} | Update a python remote
|
140
151
|
*PulpPythonClient::RemotesPythonApi* | [**read**](docs/RemotesPythonApi.md#read) | **GET** {python_python_remote_href} | Inspect a python remote
|
152
|
+
*PulpPythonClient::RemotesPythonApi* | [**remove_role**](docs/RemotesPythonApi.md#remove_role) | **POST** {python_python_remote_href}remove_role/ | Remove a role
|
141
153
|
*PulpPythonClient::RemotesPythonApi* | [**set_label**](docs/RemotesPythonApi.md#set_label) | **POST** {python_python_remote_href}set_label/ | Set a label
|
142
154
|
*PulpPythonClient::RemotesPythonApi* | [**unset_label**](docs/RemotesPythonApi.md#unset_label) | **POST** {python_python_remote_href}unset_label/ | Unset a label
|
143
155
|
*PulpPythonClient::RemotesPythonApi* | [**update**](docs/RemotesPythonApi.md#update) | **PUT** {python_python_remote_href} | Update a python remote
|
156
|
+
*PulpPythonClient::RepositoriesPythonApi* | [**add_role**](docs/RepositoriesPythonApi.md#add_role) | **POST** {python_python_repository_href}add_role/ | Add a role
|
144
157
|
*PulpPythonClient::RepositoriesPythonApi* | [**create**](docs/RepositoriesPythonApi.md#create) | **POST** /pulp/api/v3/repositories/python/python/ | Create a python repository
|
145
158
|
*PulpPythonClient::RepositoriesPythonApi* | [**delete**](docs/RepositoriesPythonApi.md#delete) | **DELETE** {python_python_repository_href} | Delete a python repository
|
146
159
|
*PulpPythonClient::RepositoriesPythonApi* | [**list**](docs/RepositoriesPythonApi.md#list) | **GET** /pulp/api/v3/repositories/python/python/ | List python repositorys
|
160
|
+
*PulpPythonClient::RepositoriesPythonApi* | [**list_roles**](docs/RepositoriesPythonApi.md#list_roles) | **GET** {python_python_repository_href}list_roles/ | List roles
|
147
161
|
*PulpPythonClient::RepositoriesPythonApi* | [**modify**](docs/RepositoriesPythonApi.md#modify) | **POST** {python_python_repository_href}modify/ | Modify Repository Content
|
162
|
+
*PulpPythonClient::RepositoriesPythonApi* | [**my_permissions**](docs/RepositoriesPythonApi.md#my_permissions) | **GET** {python_python_repository_href}my_permissions/ | List user permissions
|
148
163
|
*PulpPythonClient::RepositoriesPythonApi* | [**partial_update**](docs/RepositoriesPythonApi.md#partial_update) | **PATCH** {python_python_repository_href} | Update a python repository
|
149
164
|
*PulpPythonClient::RepositoriesPythonApi* | [**read**](docs/RepositoriesPythonApi.md#read) | **GET** {python_python_repository_href} | Inspect a python repository
|
165
|
+
*PulpPythonClient::RepositoriesPythonApi* | [**remove_role**](docs/RepositoriesPythonApi.md#remove_role) | **POST** {python_python_repository_href}remove_role/ | Remove a role
|
150
166
|
*PulpPythonClient::RepositoriesPythonApi* | [**set_label**](docs/RepositoriesPythonApi.md#set_label) | **POST** {python_python_repository_href}set_label/ | Set a label
|
151
167
|
*PulpPythonClient::RepositoriesPythonApi* | [**sync**](docs/RepositoriesPythonApi.md#sync) | **POST** {python_python_repository_href}sync/ | Sync from remote
|
152
168
|
*PulpPythonClient::RepositoriesPythonApi* | [**unset_label**](docs/RepositoriesPythonApi.md#unset_label) | **POST** {python_python_repository_href}unset_label/ | Unset a label
|
@@ -162,6 +178,10 @@ Class | Method | HTTP request | Description
|
|
162
178
|
- [PulpPythonClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
|
163
179
|
- [PulpPythonClient::ContentSummaryResponse](docs/ContentSummaryResponse.md)
|
164
180
|
- [PulpPythonClient::ExcludePlatformsEnum](docs/ExcludePlatformsEnum.md)
|
181
|
+
- [PulpPythonClient::MyPermissionsResponse](docs/MyPermissionsResponse.md)
|
182
|
+
- [PulpPythonClient::NestedRole](docs/NestedRole.md)
|
183
|
+
- [PulpPythonClient::NestedRoleResponse](docs/NestedRoleResponse.md)
|
184
|
+
- [PulpPythonClient::ObjectRolesResponse](docs/ObjectRolesResponse.md)
|
165
185
|
- [PulpPythonClient::PackageMetadataResponse](docs/PackageMetadataResponse.md)
|
166
186
|
- [PulpPythonClient::PackageTypesEnum](docs/PackageTypesEnum.md)
|
167
187
|
- [PulpPythonClient::PackageUpload](docs/PackageUpload.md)
|
data/docs/ContentPackagesApi.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# PulpPythonClient::ContentPackagesApi
|
2
2
|
|
3
|
-
All URIs are relative to *http://
|
3
|
+
All URIs are relative to *http://pulp*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
@@ -51,14 +51,14 @@ opts = {
|
|
51
51
|
license: 'license_example', # String | Text indicating the license covering the distribution
|
52
52
|
requires_python: 'requires_python_example', # String | The Python version(s) that the distribution is guaranteed to be compatible with.
|
53
53
|
project_url: 'project_url_example', # String | A browsable URL for the project and a label for it, separated by a comma.
|
54
|
-
project_urls:
|
54
|
+
project_urls: PulpPythonClient::AnyType.new, # AnyType | A dictionary of labels and URLs for the project.
|
55
55
|
platform: 'platform_example', # String | A comma-separated list of platform specifications, summarizing the operating systems supported by the package.
|
56
56
|
supported_platform: 'supported_platform_example', # String | Field to specify the OS and CPU for which the binary package was compiled.
|
57
|
-
requires_dist:
|
58
|
-
provides_dist:
|
59
|
-
obsoletes_dist:
|
60
|
-
requires_external:
|
61
|
-
classifiers:
|
57
|
+
requires_dist: PulpPythonClient::AnyType.new, # AnyType | A JSON list containing names of some other distutils project required by this distribution.
|
58
|
+
provides_dist: PulpPythonClient::AnyType.new, # AnyType | A JSON list containing names of a Distutils project which is contained within this distribution.
|
59
|
+
obsoletes_dist: PulpPythonClient::AnyType.new, # AnyType | A JSON list containing names of a distutils project's distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time.
|
60
|
+
requires_external: PulpPythonClient::AnyType.new, # AnyType | A JSON list containing some dependency in the system that the distribution is to be used.
|
61
|
+
classifiers: PulpPythonClient::AnyType.new # AnyType | A JSON list containing classification values for a Python package.
|
62
62
|
}
|
63
63
|
|
64
64
|
begin
|
@@ -94,14 +94,14 @@ Name | Type | Description | Notes
|
|
94
94
|
**license** | **String**| Text indicating the license covering the distribution | [optional]
|
95
95
|
**requires_python** | **String**| The Python version(s) that the distribution is guaranteed to be compatible with. | [optional]
|
96
96
|
**project_url** | **String**| A browsable URL for the project and a label for it, separated by a comma. | [optional]
|
97
|
-
**project_urls** | [**
|
97
|
+
**project_urls** | [**AnyType**](AnyType.md)| A dictionary of labels and URLs for the project. | [optional]
|
98
98
|
**platform** | **String**| A comma-separated list of platform specifications, summarizing the operating systems supported by the package. | [optional]
|
99
99
|
**supported_platform** | **String**| Field to specify the OS and CPU for which the binary package was compiled. | [optional]
|
100
|
-
**requires_dist** | [**
|
101
|
-
**provides_dist** | [**
|
102
|
-
**obsoletes_dist** | [**
|
103
|
-
**requires_external** | [**
|
104
|
-
**classifiers** | [**
|
100
|
+
**requires_dist** | [**AnyType**](AnyType.md)| A JSON list containing names of some other distutils project required by this distribution. | [optional]
|
101
|
+
**provides_dist** | [**AnyType**](AnyType.md)| A JSON list containing names of a Distutils project which is contained within this distribution. | [optional]
|
102
|
+
**obsoletes_dist** | [**AnyType**](AnyType.md)| A JSON list containing names of a distutils project's distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time. | [optional]
|
103
|
+
**requires_external** | [**AnyType**](AnyType.md)| A JSON list containing some dependency in the system that the distribution is to be used. | [optional]
|
104
|
+
**classifiers** | [**AnyType**](AnyType.md)| A JSON list containing classification values for a Python package. | [optional]
|
105
105
|
|
106
106
|
### Return type
|
107
107
|
|
@@ -1,20 +1,79 @@
|
|
1
1
|
# PulpPythonClient::DistributionsPypiApi
|
2
2
|
|
3
|
-
All URIs are relative to *http://
|
3
|
+
All URIs are relative to *http://pulp*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**add_role**](DistributionsPypiApi.md#add_role) | **POST** {python_python_distribution_href}add_role/ | Add a role
|
7
8
|
[**create**](DistributionsPypiApi.md#create) | **POST** /pulp/api/v3/distributions/python/pypi/ | Create a python distribution
|
8
9
|
[**delete**](DistributionsPypiApi.md#delete) | **DELETE** {python_python_distribution_href} | Delete a python distribution
|
9
10
|
[**list**](DistributionsPypiApi.md#list) | **GET** /pulp/api/v3/distributions/python/pypi/ | List python distributions
|
11
|
+
[**list_roles**](DistributionsPypiApi.md#list_roles) | **GET** {python_python_distribution_href}list_roles/ | List roles
|
12
|
+
[**my_permissions**](DistributionsPypiApi.md#my_permissions) | **GET** {python_python_distribution_href}my_permissions/ | List user permissions
|
10
13
|
[**partial_update**](DistributionsPypiApi.md#partial_update) | **PATCH** {python_python_distribution_href} | Update a python distribution
|
11
14
|
[**read**](DistributionsPypiApi.md#read) | **GET** {python_python_distribution_href} | Inspect a python distribution
|
15
|
+
[**remove_role**](DistributionsPypiApi.md#remove_role) | **POST** {python_python_distribution_href}remove_role/ | Remove a role
|
12
16
|
[**set_label**](DistributionsPypiApi.md#set_label) | **POST** {python_python_distribution_href}set_label/ | Set a label
|
13
17
|
[**unset_label**](DistributionsPypiApi.md#unset_label) | **POST** {python_python_distribution_href}unset_label/ | Unset a label
|
14
18
|
[**update**](DistributionsPypiApi.md#update) | **PUT** {python_python_distribution_href} | Update a python distribution
|
15
19
|
|
16
20
|
|
17
21
|
|
22
|
+
## add_role
|
23
|
+
|
24
|
+
> NestedRoleResponse add_role(python_python_distribution_href, nested_role)
|
25
|
+
|
26
|
+
Add a role
|
27
|
+
|
28
|
+
Add a role for this object to users/groups.
|
29
|
+
|
30
|
+
### Example
|
31
|
+
|
32
|
+
```ruby
|
33
|
+
# load the gem
|
34
|
+
require 'pulp_python_client'
|
35
|
+
# setup authorization
|
36
|
+
PulpPythonClient.configure do |config|
|
37
|
+
# Configure HTTP basic authorization: basicAuth
|
38
|
+
config.username = 'YOUR USERNAME'
|
39
|
+
config.password = 'YOUR PASSWORD'
|
40
|
+
end
|
41
|
+
|
42
|
+
api_instance = PulpPythonClient::DistributionsPypiApi.new
|
43
|
+
python_python_distribution_href = 'python_python_distribution_href_example' # String |
|
44
|
+
nested_role = PulpPythonClient::NestedRole.new # NestedRole |
|
45
|
+
|
46
|
+
begin
|
47
|
+
#Add a role
|
48
|
+
result = api_instance.add_role(python_python_distribution_href, nested_role)
|
49
|
+
p result
|
50
|
+
rescue PulpPythonClient::ApiError => e
|
51
|
+
puts "Exception when calling DistributionsPypiApi->add_role: #{e}"
|
52
|
+
end
|
53
|
+
```
|
54
|
+
|
55
|
+
### Parameters
|
56
|
+
|
57
|
+
|
58
|
+
Name | Type | Description | Notes
|
59
|
+
------------- | ------------- | ------------- | -------------
|
60
|
+
**python_python_distribution_href** | **String**| |
|
61
|
+
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
62
|
+
|
63
|
+
### Return type
|
64
|
+
|
65
|
+
[**NestedRoleResponse**](NestedRoleResponse.md)
|
66
|
+
|
67
|
+
### Authorization
|
68
|
+
|
69
|
+
[basicAuth](../README.md#basicAuth)
|
70
|
+
|
71
|
+
### HTTP request headers
|
72
|
+
|
73
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
74
|
+
- **Accept**: application/json
|
75
|
+
|
76
|
+
|
18
77
|
## create
|
19
78
|
|
20
79
|
> AsyncOperationResponse create(python_python_distribution)
|
@@ -224,6 +283,124 @@ Name | Type | Description | Notes
|
|
224
283
|
- **Accept**: application/json
|
225
284
|
|
226
285
|
|
286
|
+
## list_roles
|
287
|
+
|
288
|
+
> ObjectRolesResponse list_roles(python_python_distribution_href, opts)
|
289
|
+
|
290
|
+
List roles
|
291
|
+
|
292
|
+
List roles assigned to this object.
|
293
|
+
|
294
|
+
### Example
|
295
|
+
|
296
|
+
```ruby
|
297
|
+
# load the gem
|
298
|
+
require 'pulp_python_client'
|
299
|
+
# setup authorization
|
300
|
+
PulpPythonClient.configure do |config|
|
301
|
+
# Configure HTTP basic authorization: basicAuth
|
302
|
+
config.username = 'YOUR USERNAME'
|
303
|
+
config.password = 'YOUR PASSWORD'
|
304
|
+
end
|
305
|
+
|
306
|
+
api_instance = PulpPythonClient::DistributionsPypiApi.new
|
307
|
+
python_python_distribution_href = 'python_python_distribution_href_example' # String |
|
308
|
+
opts = {
|
309
|
+
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
310
|
+
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
311
|
+
}
|
312
|
+
|
313
|
+
begin
|
314
|
+
#List roles
|
315
|
+
result = api_instance.list_roles(python_python_distribution_href, opts)
|
316
|
+
p result
|
317
|
+
rescue PulpPythonClient::ApiError => e
|
318
|
+
puts "Exception when calling DistributionsPypiApi->list_roles: #{e}"
|
319
|
+
end
|
320
|
+
```
|
321
|
+
|
322
|
+
### Parameters
|
323
|
+
|
324
|
+
|
325
|
+
Name | Type | Description | Notes
|
326
|
+
------------- | ------------- | ------------- | -------------
|
327
|
+
**python_python_distribution_href** | **String**| |
|
328
|
+
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
329
|
+
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
330
|
+
|
331
|
+
### Return type
|
332
|
+
|
333
|
+
[**ObjectRolesResponse**](ObjectRolesResponse.md)
|
334
|
+
|
335
|
+
### Authorization
|
336
|
+
|
337
|
+
[basicAuth](../README.md#basicAuth)
|
338
|
+
|
339
|
+
### HTTP request headers
|
340
|
+
|
341
|
+
- **Content-Type**: Not defined
|
342
|
+
- **Accept**: application/json
|
343
|
+
|
344
|
+
|
345
|
+
## my_permissions
|
346
|
+
|
347
|
+
> MyPermissionsResponse my_permissions(python_python_distribution_href, opts)
|
348
|
+
|
349
|
+
List user permissions
|
350
|
+
|
351
|
+
List permissions available to the current user on this object.
|
352
|
+
|
353
|
+
### Example
|
354
|
+
|
355
|
+
```ruby
|
356
|
+
# load the gem
|
357
|
+
require 'pulp_python_client'
|
358
|
+
# setup authorization
|
359
|
+
PulpPythonClient.configure do |config|
|
360
|
+
# Configure HTTP basic authorization: basicAuth
|
361
|
+
config.username = 'YOUR USERNAME'
|
362
|
+
config.password = 'YOUR PASSWORD'
|
363
|
+
end
|
364
|
+
|
365
|
+
api_instance = PulpPythonClient::DistributionsPypiApi.new
|
366
|
+
python_python_distribution_href = 'python_python_distribution_href_example' # String |
|
367
|
+
opts = {
|
368
|
+
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
369
|
+
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
370
|
+
}
|
371
|
+
|
372
|
+
begin
|
373
|
+
#List user permissions
|
374
|
+
result = api_instance.my_permissions(python_python_distribution_href, opts)
|
375
|
+
p result
|
376
|
+
rescue PulpPythonClient::ApiError => e
|
377
|
+
puts "Exception when calling DistributionsPypiApi->my_permissions: #{e}"
|
378
|
+
end
|
379
|
+
```
|
380
|
+
|
381
|
+
### Parameters
|
382
|
+
|
383
|
+
|
384
|
+
Name | Type | Description | Notes
|
385
|
+
------------- | ------------- | ------------- | -------------
|
386
|
+
**python_python_distribution_href** | **String**| |
|
387
|
+
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
388
|
+
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
389
|
+
|
390
|
+
### Return type
|
391
|
+
|
392
|
+
[**MyPermissionsResponse**](MyPermissionsResponse.md)
|
393
|
+
|
394
|
+
### Authorization
|
395
|
+
|
396
|
+
[basicAuth](../README.md#basicAuth)
|
397
|
+
|
398
|
+
### HTTP request headers
|
399
|
+
|
400
|
+
- **Content-Type**: Not defined
|
401
|
+
- **Accept**: application/json
|
402
|
+
|
403
|
+
|
227
404
|
## partial_update
|
228
405
|
|
229
406
|
> AsyncOperationResponse partial_update(python_python_distribution_href, patchedpython_python_distribution)
|
@@ -338,6 +515,61 @@ Name | Type | Description | Notes
|
|
338
515
|
- **Accept**: application/json
|
339
516
|
|
340
517
|
|
518
|
+
## remove_role
|
519
|
+
|
520
|
+
> NestedRoleResponse remove_role(python_python_distribution_href, nested_role)
|
521
|
+
|
522
|
+
Remove a role
|
523
|
+
|
524
|
+
Remove a role for this object from users/groups.
|
525
|
+
|
526
|
+
### Example
|
527
|
+
|
528
|
+
```ruby
|
529
|
+
# load the gem
|
530
|
+
require 'pulp_python_client'
|
531
|
+
# setup authorization
|
532
|
+
PulpPythonClient.configure do |config|
|
533
|
+
# Configure HTTP basic authorization: basicAuth
|
534
|
+
config.username = 'YOUR USERNAME'
|
535
|
+
config.password = 'YOUR PASSWORD'
|
536
|
+
end
|
537
|
+
|
538
|
+
api_instance = PulpPythonClient::DistributionsPypiApi.new
|
539
|
+
python_python_distribution_href = 'python_python_distribution_href_example' # String |
|
540
|
+
nested_role = PulpPythonClient::NestedRole.new # NestedRole |
|
541
|
+
|
542
|
+
begin
|
543
|
+
#Remove a role
|
544
|
+
result = api_instance.remove_role(python_python_distribution_href, nested_role)
|
545
|
+
p result
|
546
|
+
rescue PulpPythonClient::ApiError => e
|
547
|
+
puts "Exception when calling DistributionsPypiApi->remove_role: #{e}"
|
548
|
+
end
|
549
|
+
```
|
550
|
+
|
551
|
+
### Parameters
|
552
|
+
|
553
|
+
|
554
|
+
Name | Type | Description | Notes
|
555
|
+
------------- | ------------- | ------------- | -------------
|
556
|
+
**python_python_distribution_href** | **String**| |
|
557
|
+
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
558
|
+
|
559
|
+
### Return type
|
560
|
+
|
561
|
+
[**NestedRoleResponse**](NestedRoleResponse.md)
|
562
|
+
|
563
|
+
### Authorization
|
564
|
+
|
565
|
+
[basicAuth](../README.md#basicAuth)
|
566
|
+
|
567
|
+
### HTTP request headers
|
568
|
+
|
569
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
570
|
+
- **Accept**: application/json
|
571
|
+
|
572
|
+
|
341
573
|
## set_label
|
342
574
|
|
343
575
|
> SetLabelResponse set_label(python_python_distribution_href, set_label)
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# PulpPythonClient::MyPermissionsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**permissions** | **Array<String>** | |
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'PulpPythonClient'
|
13
|
+
|
14
|
+
instance = PulpPythonClient::MyPermissionsResponse.new(permissions: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
data/docs/NestedRole.md
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
# PulpPythonClient::NestedRole
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**users** | **Array<String>** | | [optional]
|
8
|
+
**groups** | **Array<String>** | | [optional]
|
9
|
+
**role** | **String** | |
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'PulpPythonClient'
|
15
|
+
|
16
|
+
instance = PulpPythonClient::NestedRole.new(users: null,
|
17
|
+
groups: null,
|
18
|
+
role: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# PulpPythonClient::NestedRoleResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**users** | **Array<String>** | | [optional]
|
8
|
+
**groups** | **Array<String>** | | [optional]
|
9
|
+
**role** | **String** | |
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'PulpPythonClient'
|
15
|
+
|
16
|
+
instance = PulpPythonClient::NestedRoleResponse.new(users: null,
|
17
|
+
groups: null,
|
18
|
+
role: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# PulpPythonClient::ObjectRolesResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**roles** | [**Array<NestedRoleResponse>**](NestedRoleResponse.md) | |
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'PulpPythonClient'
|
13
|
+
|
14
|
+
instance = PulpPythonClient::ObjectRolesResponse.new(roles: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -5,9 +5,9 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**last_serial** | **Integer** | Cache value from last PyPI sync |
|
8
|
-
**info** | [**
|
9
|
-
**releases** | [**
|
10
|
-
**urls** | [**
|
8
|
+
**info** | [**AnyType**](.md) | Core metadata of the package |
|
9
|
+
**releases** | [**AnyType**](.md) | List of all the releases of the package |
|
10
|
+
**urls** | [**AnyType**](.md) | |
|
11
11
|
|
12
12
|
## Code Sample
|
13
13
|
|