pulp_python_client 3.12.5 → 3.13.1
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 +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/PypiApi.md
CHANGED
@@ -2,24 +2,23 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost:24817*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**read**](PypiApi.md#read) | **GET** /pypi/{path}/ | Get index summary
|
8
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**read**](PypiApi.md#read) | **GET** /pypi/{path}/ | Get index summary |
|
9
8
|
|
10
9
|
|
11
10
|
## read
|
12
11
|
|
13
|
-
> SummaryResponse read(path, opts)
|
12
|
+
> <SummaryResponse> read(path, opts)
|
14
13
|
|
15
14
|
Get index summary
|
16
15
|
|
17
16
|
Gets package summary stats of index.
|
18
17
|
|
19
|
-
###
|
18
|
+
### Examples
|
20
19
|
|
21
20
|
```ruby
|
22
|
-
|
21
|
+
require 'time'
|
23
22
|
require 'pulp_python_client'
|
24
23
|
# setup authorization
|
25
24
|
PulpPythonClient.configure do |config|
|
@@ -31,27 +30,44 @@ end
|
|
31
30
|
api_instance = PulpPythonClient::PypiApi.new
|
32
31
|
path = 'path_example' # String |
|
33
32
|
opts = {
|
34
|
-
fields: ['
|
35
|
-
exclude_fields: ['
|
33
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
34
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
36
35
|
}
|
37
36
|
|
38
37
|
begin
|
39
|
-
#Get index summary
|
38
|
+
# Get index summary
|
40
39
|
result = api_instance.read(path, opts)
|
41
40
|
p result
|
42
41
|
rescue PulpPythonClient::ApiError => e
|
43
|
-
puts "
|
42
|
+
puts "Error when calling PypiApi->read: #{e}"
|
44
43
|
end
|
45
44
|
```
|
46
45
|
|
47
|
-
|
46
|
+
#### Using the read_with_http_info variant
|
47
|
+
|
48
|
+
This returns an Array which contains the response data, status code and headers.
|
48
49
|
|
50
|
+
> <Array(<SummaryResponse>, Integer, Hash)> read_with_http_info(path, opts)
|
51
|
+
|
52
|
+
```ruby
|
53
|
+
begin
|
54
|
+
# Get index summary
|
55
|
+
data, status_code, headers = api_instance.read_with_http_info(path, opts)
|
56
|
+
p status_code # => 2xx
|
57
|
+
p headers # => { ... }
|
58
|
+
p data # => <SummaryResponse>
|
59
|
+
rescue PulpPythonClient::ApiError => e
|
60
|
+
puts "Error when calling PypiApi->read_with_http_info: #{e}"
|
61
|
+
end
|
62
|
+
```
|
63
|
+
|
64
|
+
### Parameters
|
49
65
|
|
50
|
-
Name | Type | Description
|
51
|
-
|
52
|
-
**path** | **String
|
53
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
54
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
66
|
+
| Name | Type | Description | Notes |
|
67
|
+
| ---- | ---- | ----------- | ----- |
|
68
|
+
| **path** | **String** | | |
|
69
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
70
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
55
71
|
|
56
72
|
### Return type
|
57
73
|
|
data/docs/PypiLegacyApi.md
CHANGED
@@ -2,24 +2,23 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost:24817*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**create**](PypiLegacyApi.md#create) | **POST** /pypi/{path}/legacy/ | Upload a package
|
8
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create**](PypiLegacyApi.md#create) | **POST** /pypi/{path}/legacy/ | Upload a package |
|
9
8
|
|
10
9
|
|
11
10
|
## create
|
12
11
|
|
13
|
-
> PackageUploadTaskResponse create(path, content, sha256_digest, opts)
|
12
|
+
> <PackageUploadTaskResponse> create(path, content, sha256_digest, opts)
|
14
13
|
|
15
14
|
Upload a package
|
16
15
|
|
17
16
|
Upload package to the index. This is the endpoint that tools like Twine and Poetry use for their upload commands.
|
18
17
|
|
19
|
-
###
|
18
|
+
### Examples
|
20
19
|
|
21
20
|
```ruby
|
22
|
-
|
21
|
+
require 'time'
|
23
22
|
require 'pulp_python_client'
|
24
23
|
# setup authorization
|
25
24
|
PulpPythonClient.configure do |config|
|
@@ -30,30 +29,47 @@ end
|
|
30
29
|
|
31
30
|
api_instance = PulpPythonClient::PypiLegacyApi.new
|
32
31
|
path = 'path_example' # String |
|
33
|
-
content = File.new('/path/to/file') # File | A Python package release file to upload to the index.
|
32
|
+
content = File.new('/path/to/some/file') # File | A Python package release file to upload to the index.
|
34
33
|
sha256_digest = 'sha256_digest_example' # String | SHA256 of package to validate upload integrity.
|
35
34
|
opts = {
|
36
|
-
action: '
|
35
|
+
action: 'action_example' # String | Defaults to `file_upload`, don't change it or request will fail!
|
37
36
|
}
|
38
37
|
|
39
38
|
begin
|
40
|
-
#Upload a package
|
39
|
+
# Upload a package
|
41
40
|
result = api_instance.create(path, content, sha256_digest, opts)
|
42
41
|
p result
|
43
42
|
rescue PulpPythonClient::ApiError => e
|
44
|
-
puts "
|
43
|
+
puts "Error when calling PypiLegacyApi->create: #{e}"
|
45
44
|
end
|
46
45
|
```
|
47
46
|
|
48
|
-
|
47
|
+
#### Using the create_with_http_info variant
|
48
|
+
|
49
|
+
This returns an Array which contains the response data, status code and headers.
|
49
50
|
|
51
|
+
> <Array(<PackageUploadTaskResponse>, Integer, Hash)> create_with_http_info(path, content, sha256_digest, opts)
|
52
|
+
|
53
|
+
```ruby
|
54
|
+
begin
|
55
|
+
# Upload a package
|
56
|
+
data, status_code, headers = api_instance.create_with_http_info(path, content, sha256_digest, opts)
|
57
|
+
p status_code # => 2xx
|
58
|
+
p headers # => { ... }
|
59
|
+
p data # => <PackageUploadTaskResponse>
|
60
|
+
rescue PulpPythonClient::ApiError => e
|
61
|
+
puts "Error when calling PypiLegacyApi->create_with_http_info: #{e}"
|
62
|
+
end
|
63
|
+
```
|
64
|
+
|
65
|
+
### Parameters
|
50
66
|
|
51
|
-
Name | Type | Description
|
52
|
-
|
53
|
-
**path** | **String
|
54
|
-
**content** | **File
|
55
|
-
**sha256_digest** | **String
|
56
|
-
**action** | **String
|
67
|
+
| Name | Type | Description | Notes |
|
68
|
+
| ---- | ---- | ----------- | ----- |
|
69
|
+
| **path** | **String** | | |
|
70
|
+
| **content** | **File** | A Python package release file to upload to the index. | |
|
71
|
+
| **sha256_digest** | **String** | SHA256 of package to validate upload integrity. | |
|
72
|
+
| **action** | **String** | Defaults to `file_upload`, don't change it or request will fail! | [optional][default to 'file_upload'] |
|
57
73
|
|
58
74
|
### Return type
|
59
75
|
|
data/docs/PypiMetadataApi.md
CHANGED
@@ -2,24 +2,23 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost:24817*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**read**](PypiMetadataApi.md#read) | **GET** /pypi/{path}/pypi/{meta}/ | Get package metadata
|
8
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**read**](PypiMetadataApi.md#read) | **GET** /pypi/{path}/pypi/{meta}/ | Get package metadata |
|
9
8
|
|
10
9
|
|
11
10
|
## read
|
12
11
|
|
13
|
-
> PackageMetadataResponse read(meta, path, opts)
|
12
|
+
> <PackageMetadataResponse> read(meta, path, opts)
|
14
13
|
|
15
14
|
Get package metadata
|
16
15
|
|
17
16
|
Retrieves the package's core-metadata specified by https://packaging.python.org/specifications/core-metadata/. `meta` must be a path in form of `{package}/json/` or `{package}/{version}/json/`
|
18
17
|
|
19
|
-
###
|
18
|
+
### Examples
|
20
19
|
|
21
20
|
```ruby
|
22
|
-
|
21
|
+
require 'time'
|
23
22
|
require 'pulp_python_client'
|
24
23
|
# setup authorization
|
25
24
|
PulpPythonClient.configure do |config|
|
@@ -32,28 +31,45 @@ api_instance = PulpPythonClient::PypiMetadataApi.new
|
|
32
31
|
meta = 'meta_example' # String |
|
33
32
|
path = 'path_example' # String |
|
34
33
|
opts = {
|
35
|
-
fields: ['
|
36
|
-
exclude_fields: ['
|
34
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
35
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
37
36
|
}
|
38
37
|
|
39
38
|
begin
|
40
|
-
#Get package metadata
|
39
|
+
# Get package metadata
|
41
40
|
result = api_instance.read(meta, path, opts)
|
42
41
|
p result
|
43
42
|
rescue PulpPythonClient::ApiError => e
|
44
|
-
puts "
|
43
|
+
puts "Error when calling PypiMetadataApi->read: #{e}"
|
45
44
|
end
|
46
45
|
```
|
47
46
|
|
48
|
-
|
47
|
+
#### Using the read_with_http_info variant
|
48
|
+
|
49
|
+
This returns an Array which contains the response data, status code and headers.
|
49
50
|
|
51
|
+
> <Array(<PackageMetadataResponse>, Integer, Hash)> read_with_http_info(meta, path, opts)
|
52
|
+
|
53
|
+
```ruby
|
54
|
+
begin
|
55
|
+
# Get package metadata
|
56
|
+
data, status_code, headers = api_instance.read_with_http_info(meta, path, opts)
|
57
|
+
p status_code # => 2xx
|
58
|
+
p headers # => { ... }
|
59
|
+
p data # => <PackageMetadataResponse>
|
60
|
+
rescue PulpPythonClient::ApiError => e
|
61
|
+
puts "Error when calling PypiMetadataApi->read_with_http_info: #{e}"
|
62
|
+
end
|
63
|
+
```
|
64
|
+
|
65
|
+
### Parameters
|
50
66
|
|
51
|
-
Name | Type | Description
|
52
|
-
|
53
|
-
**meta** | **String
|
54
|
-
**path** | **String
|
55
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
56
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
67
|
+
| Name | Type | Description | Notes |
|
68
|
+
| ---- | ---- | ----------- | ----- |
|
69
|
+
| **meta** | **String** | | |
|
70
|
+
| **path** | **String** | | |
|
71
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
72
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
57
73
|
|
58
74
|
### Return type
|
59
75
|
|
data/docs/PypiSimpleApi.md
CHANGED
@@ -2,26 +2,25 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost:24817*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**create**](PypiSimpleApi.md#create) | **POST** /pypi/{path}/simple/ | Upload a package
|
8
|
-
[**pypi_simple_package_read**](PypiSimpleApi.md#pypi_simple_package_read) | **GET** /pypi/{path}/simple/{package}/ | Get package simple page
|
9
|
-
[**read**](PypiSimpleApi.md#read) | **GET** /pypi/{path}/simple/ | Get index simple page
|
10
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create**](PypiSimpleApi.md#create) | **POST** /pypi/{path}/simple/ | Upload a package |
|
8
|
+
| [**pypi_simple_package_read**](PypiSimpleApi.md#pypi_simple_package_read) | **GET** /pypi/{path}/simple/{package}/ | Get package simple page |
|
9
|
+
| [**read**](PypiSimpleApi.md#read) | **GET** /pypi/{path}/simple/ | Get index simple page |
|
11
10
|
|
12
11
|
|
13
12
|
## create
|
14
13
|
|
15
|
-
> PackageUploadTaskResponse create(path, content, sha256_digest, opts)
|
14
|
+
> <PackageUploadTaskResponse> create(path, content, sha256_digest, opts)
|
16
15
|
|
17
16
|
Upload a package
|
18
17
|
|
19
18
|
Upload package to the index. This endpoint has the same functionality as the upload endpoint at the `/legacy` url of the index. This is provided for convenience for users who want a single index url for all their Python tools. (pip, twine, poetry, pipenv, ...)
|
20
19
|
|
21
|
-
###
|
20
|
+
### Examples
|
22
21
|
|
23
22
|
```ruby
|
24
|
-
|
23
|
+
require 'time'
|
25
24
|
require 'pulp_python_client'
|
26
25
|
# setup authorization
|
27
26
|
PulpPythonClient.configure do |config|
|
@@ -32,30 +31,47 @@ end
|
|
32
31
|
|
33
32
|
api_instance = PulpPythonClient::PypiSimpleApi.new
|
34
33
|
path = 'path_example' # String |
|
35
|
-
content = File.new('/path/to/file') # File | A Python package release file to upload to the index.
|
34
|
+
content = File.new('/path/to/some/file') # File | A Python package release file to upload to the index.
|
36
35
|
sha256_digest = 'sha256_digest_example' # String | SHA256 of package to validate upload integrity.
|
37
36
|
opts = {
|
38
|
-
action: '
|
37
|
+
action: 'action_example' # String | Defaults to `file_upload`, don't change it or request will fail!
|
39
38
|
}
|
40
39
|
|
41
40
|
begin
|
42
|
-
#Upload a package
|
41
|
+
# Upload a package
|
43
42
|
result = api_instance.create(path, content, sha256_digest, opts)
|
44
43
|
p result
|
45
44
|
rescue PulpPythonClient::ApiError => e
|
46
|
-
puts "
|
45
|
+
puts "Error when calling PypiSimpleApi->create: #{e}"
|
47
46
|
end
|
48
47
|
```
|
49
48
|
|
50
|
-
|
49
|
+
#### Using the create_with_http_info variant
|
50
|
+
|
51
|
+
This returns an Array which contains the response data, status code and headers.
|
52
|
+
|
53
|
+
> <Array(<PackageUploadTaskResponse>, Integer, Hash)> create_with_http_info(path, content, sha256_digest, opts)
|
54
|
+
|
55
|
+
```ruby
|
56
|
+
begin
|
57
|
+
# Upload a package
|
58
|
+
data, status_code, headers = api_instance.create_with_http_info(path, content, sha256_digest, opts)
|
59
|
+
p status_code # => 2xx
|
60
|
+
p headers # => { ... }
|
61
|
+
p data # => <PackageUploadTaskResponse>
|
62
|
+
rescue PulpPythonClient::ApiError => e
|
63
|
+
puts "Error when calling PypiSimpleApi->create_with_http_info: #{e}"
|
64
|
+
end
|
65
|
+
```
|
51
66
|
|
67
|
+
### Parameters
|
52
68
|
|
53
|
-
Name | Type | Description
|
54
|
-
|
55
|
-
**path** | **String
|
56
|
-
**content** | **File
|
57
|
-
**sha256_digest** | **String
|
58
|
-
**action** | **String
|
69
|
+
| Name | Type | Description | Notes |
|
70
|
+
| ---- | ---- | ----------- | ----- |
|
71
|
+
| **path** | **String** | | |
|
72
|
+
| **content** | **File** | A Python package release file to upload to the index. | |
|
73
|
+
| **sha256_digest** | **String** | SHA256 of package to validate upload integrity. | |
|
74
|
+
| **action** | **String** | Defaults to `file_upload`, don't change it or request will fail! | [optional][default to 'file_upload'] |
|
59
75
|
|
60
76
|
### Return type
|
61
77
|
|
@@ -79,10 +95,10 @@ Get package simple page
|
|
79
95
|
|
80
96
|
Retrieves the simple api html page for a package.
|
81
97
|
|
82
|
-
###
|
98
|
+
### Examples
|
83
99
|
|
84
100
|
```ruby
|
85
|
-
|
101
|
+
require 'time'
|
86
102
|
require 'pulp_python_client'
|
87
103
|
# setup authorization
|
88
104
|
PulpPythonClient.configure do |config|
|
@@ -95,27 +111,44 @@ api_instance = PulpPythonClient::PypiSimpleApi.new
|
|
95
111
|
package = 'package_example' # String |
|
96
112
|
path = 'path_example' # String |
|
97
113
|
opts = {
|
98
|
-
fields: ['
|
99
|
-
exclude_fields: ['
|
114
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
115
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
100
116
|
}
|
101
117
|
|
102
118
|
begin
|
103
|
-
#Get package simple page
|
119
|
+
# Get package simple page
|
104
120
|
api_instance.pypi_simple_package_read(package, path, opts)
|
105
121
|
rescue PulpPythonClient::ApiError => e
|
106
|
-
puts "
|
122
|
+
puts "Error when calling PypiSimpleApi->pypi_simple_package_read: #{e}"
|
107
123
|
end
|
108
124
|
```
|
109
125
|
|
110
|
-
|
126
|
+
#### Using the pypi_simple_package_read_with_http_info variant
|
111
127
|
|
128
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
112
129
|
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
|
130
|
+
> <Array(nil, Integer, Hash)> pypi_simple_package_read_with_http_info(package, path, opts)
|
131
|
+
|
132
|
+
```ruby
|
133
|
+
begin
|
134
|
+
# Get package simple page
|
135
|
+
data, status_code, headers = api_instance.pypi_simple_package_read_with_http_info(package, path, opts)
|
136
|
+
p status_code # => 2xx
|
137
|
+
p headers # => { ... }
|
138
|
+
p data # => nil
|
139
|
+
rescue PulpPythonClient::ApiError => e
|
140
|
+
puts "Error when calling PypiSimpleApi->pypi_simple_package_read_with_http_info: #{e}"
|
141
|
+
end
|
142
|
+
```
|
143
|
+
|
144
|
+
### Parameters
|
145
|
+
|
146
|
+
| Name | Type | Description | Notes |
|
147
|
+
| ---- | ---- | ----------- | ----- |
|
148
|
+
| **package** | **String** | | |
|
149
|
+
| **path** | **String** | | |
|
150
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
151
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
119
152
|
|
120
153
|
### Return type
|
121
154
|
|
@@ -139,10 +172,10 @@ Get index simple page
|
|
139
172
|
|
140
173
|
Gets the simple api html page for the index.
|
141
174
|
|
142
|
-
###
|
175
|
+
### Examples
|
143
176
|
|
144
177
|
```ruby
|
145
|
-
|
178
|
+
require 'time'
|
146
179
|
require 'pulp_python_client'
|
147
180
|
# setup authorization
|
148
181
|
PulpPythonClient.configure do |config|
|
@@ -154,26 +187,43 @@ end
|
|
154
187
|
api_instance = PulpPythonClient::PypiSimpleApi.new
|
155
188
|
path = 'path_example' # String |
|
156
189
|
opts = {
|
157
|
-
fields: ['
|
158
|
-
exclude_fields: ['
|
190
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
191
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
159
192
|
}
|
160
193
|
|
161
194
|
begin
|
162
|
-
#Get index simple page
|
195
|
+
# Get index simple page
|
163
196
|
api_instance.read(path, opts)
|
164
197
|
rescue PulpPythonClient::ApiError => e
|
165
|
-
puts "
|
198
|
+
puts "Error when calling PypiSimpleApi->read: #{e}"
|
166
199
|
end
|
167
200
|
```
|
168
201
|
|
169
|
-
|
202
|
+
#### Using the read_with_http_info variant
|
203
|
+
|
204
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
205
|
+
|
206
|
+
> <Array(nil, Integer, Hash)> read_with_http_info(path, opts)
|
170
207
|
|
208
|
+
```ruby
|
209
|
+
begin
|
210
|
+
# Get index simple page
|
211
|
+
data, status_code, headers = api_instance.read_with_http_info(path, opts)
|
212
|
+
p status_code # => 2xx
|
213
|
+
p headers # => { ... }
|
214
|
+
p data # => nil
|
215
|
+
rescue PulpPythonClient::ApiError => e
|
216
|
+
puts "Error when calling PypiSimpleApi->read_with_http_info: #{e}"
|
217
|
+
end
|
218
|
+
```
|
219
|
+
|
220
|
+
### Parameters
|
171
221
|
|
172
|
-
Name | Type | Description
|
173
|
-
|
174
|
-
**path** | **String
|
175
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
176
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
222
|
+
| Name | Type | Description | Notes |
|
223
|
+
| ---- | ---- | ----------- | ----- |
|
224
|
+
| **path** | **String** | | |
|
225
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
226
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
177
227
|
|
178
228
|
### Return type
|
179
229
|
|
@@ -2,32 +2,33 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") |
|
8
|
-
**content_guard** | **String** | An optional content-guard. | [optional]
|
9
|
-
**hidden** | **Boolean** | Whether this distribution should be shown in the content app. | [optional]
|
10
|
-
**pulp_labels** | **Hash<String, String>** | | [optional]
|
11
|
-
**name** | **String** | A unique name. Ex, `rawhide` and `stable`. |
|
12
|
-
**repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional]
|
13
|
-
**publication** | **String** | Publication to be served | [optional]
|
14
|
-
**allow_uploads** | **Boolean** | Allow packages to be uploaded to this index. | [optional]
|
15
|
-
**remote** | **String** | Remote that can be used to fetch content when using pull-through caching. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") | |
|
8
|
+
| **content_guard** | **String** | An optional content-guard. | [optional] |
|
9
|
+
| **hidden** | **Boolean** | Whether this distribution should be shown in the content app. | [optional][default to false] |
|
10
|
+
| **pulp_labels** | **Hash<String, String>** | | [optional] |
|
11
|
+
| **name** | **String** | A unique name. Ex, `rawhide` and `stable`. | |
|
12
|
+
| **repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional] |
|
13
|
+
| **publication** | **String** | Publication to be served | [optional] |
|
14
|
+
| **allow_uploads** | **Boolean** | Allow packages to be uploaded to this index. | [optional][default to true] |
|
15
|
+
| **remote** | **String** | Remote that can be used to fetch content when using pull-through caching. | [optional] |
|
16
16
|
|
17
|
-
##
|
17
|
+
## Example
|
18
18
|
|
19
19
|
```ruby
|
20
|
-
require '
|
20
|
+
require 'pulp_python_client'
|
21
21
|
|
22
|
-
instance = PulpPythonClient::PythonPythonDistribution.new(
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
22
|
+
instance = PulpPythonClient::PythonPythonDistribution.new(
|
23
|
+
base_path: null,
|
24
|
+
content_guard: null,
|
25
|
+
hidden: null,
|
26
|
+
pulp_labels: null,
|
27
|
+
name: null,
|
28
|
+
repository: null,
|
29
|
+
publication: null,
|
30
|
+
allow_uploads: null,
|
31
|
+
remote: null
|
32
|
+
)
|
31
33
|
```
|
32
34
|
|
33
|
-
|
@@ -2,44 +2,45 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**pulp_href** | **String** | | [optional]
|
8
|
-
**prn** | **String** | The Pulp Resource Name (PRN). | [optional]
|
9
|
-
**pulp_created** | **
|
10
|
-
**pulp_last_updated** | **
|
11
|
-
**base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") |
|
12
|
-
**base_url** | **String** | | [optional]
|
13
|
-
**content_guard** | **String** | An optional content-guard. | [optional]
|
14
|
-
**no_content_change_since** | **String** | Timestamp since when the distributed content served by this distribution has not changed. If equals to `null`, no guarantee is provided about content changes. | [optional]
|
15
|
-
**hidden** | **Boolean** | Whether this distribution should be shown in the content app. | [optional]
|
16
|
-
**pulp_labels** | **Hash<String, String>** | | [optional]
|
17
|
-
**name** | **String** | A unique name. Ex, `rawhide` and `stable`. |
|
18
|
-
**repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional]
|
19
|
-
**publication** | **String** | Publication to be served | [optional]
|
20
|
-
**allow_uploads** | **Boolean** | Allow packages to be uploaded to this index. | [optional]
|
21
|
-
**remote** | **String** | Remote that can be used to fetch content when using pull-through caching. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **pulp_href** | **String** | | [optional][readonly] |
|
8
|
+
| **prn** | **String** | The Pulp Resource Name (PRN). | [optional][readonly] |
|
9
|
+
| **pulp_created** | **Time** | Timestamp of creation. | [optional][readonly] |
|
10
|
+
| **pulp_last_updated** | **Time** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional][readonly] |
|
11
|
+
| **base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") | |
|
12
|
+
| **base_url** | **String** | | [optional][readonly] |
|
13
|
+
| **content_guard** | **String** | An optional content-guard. | [optional] |
|
14
|
+
| **no_content_change_since** | **String** | Timestamp since when the distributed content served by this distribution has not changed. If equals to `null`, no guarantee is provided about content changes. | [optional][readonly] |
|
15
|
+
| **hidden** | **Boolean** | Whether this distribution should be shown in the content app. | [optional][default to false] |
|
16
|
+
| **pulp_labels** | **Hash<String, String>** | | [optional] |
|
17
|
+
| **name** | **String** | A unique name. Ex, `rawhide` and `stable`. | |
|
18
|
+
| **repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional] |
|
19
|
+
| **publication** | **String** | Publication to be served | [optional] |
|
20
|
+
| **allow_uploads** | **Boolean** | Allow packages to be uploaded to this index. | [optional][default to true] |
|
21
|
+
| **remote** | **String** | Remote that can be used to fetch content when using pull-through caching. | [optional] |
|
22
22
|
|
23
|
-
##
|
23
|
+
## Example
|
24
24
|
|
25
25
|
```ruby
|
26
|
-
require '
|
26
|
+
require 'pulp_python_client'
|
27
27
|
|
28
|
-
instance = PulpPythonClient::PythonPythonDistributionResponse.new(
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
28
|
+
instance = PulpPythonClient::PythonPythonDistributionResponse.new(
|
29
|
+
pulp_href: null,
|
30
|
+
prn: null,
|
31
|
+
pulp_created: null,
|
32
|
+
pulp_last_updated: null,
|
33
|
+
base_path: null,
|
34
|
+
base_url: null,
|
35
|
+
content_guard: null,
|
36
|
+
no_content_change_since: null,
|
37
|
+
hidden: null,
|
38
|
+
pulp_labels: null,
|
39
|
+
name: null,
|
40
|
+
repository: null,
|
41
|
+
publication: null,
|
42
|
+
allow_uploads: null,
|
43
|
+
remote: null
|
44
|
+
)
|
43
45
|
```
|
44
46
|
|
45
|
-
|