pulp_maven_client 0.25.1 → 0.27.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 +17 -4
- data/docs/ContentMavenIndexPageApi.md +341 -0
- data/docs/ContentPackageApi.md +6 -0
- data/docs/MavenMavenIndexPageResponse.md +32 -0
- data/docs/MavenMavenPackageResponse.md +2 -0
- data/docs/MavenPackageReleaseResponse.md +22 -0
- data/docs/MavenRepositoryMetricsResponse.md +22 -0
- data/docs/MavenRepositoryPackageResponse.md +24 -0
- data/docs/PaginatedMavenRepositoryPackageListResponse.md +24 -0
- data/docs/PaginatedmavenMavenIndexPageResponseList.md +24 -0
- data/docs/RepositoriesMavenApi.md +241 -0
- data/lib/pulp_maven_client/api/content_maven_index_page_api.rb +354 -0
- data/lib/pulp_maven_client/api/content_package_api.rb +9 -0
- data/lib/pulp_maven_client/api/repositories_maven_api.rb +222 -0
- data/lib/pulp_maven_client/models/maven_maven_index_page_response.rb +286 -0
- data/lib/pulp_maven_client/models/maven_maven_package_response.rb +11 -1
- data/lib/pulp_maven_client/models/maven_package_release_response.rb +257 -0
- data/lib/pulp_maven_client/models/maven_repository_metrics_response.rb +257 -0
- data/lib/pulp_maven_client/models/maven_repository_package_response.rb +278 -0
- data/lib/pulp_maven_client/models/nested_role.rb +1 -1
- data/lib/pulp_maven_client/models/nested_role_response.rb +1 -1
- data/lib/pulp_maven_client/models/paginated_maven_repository_package_list_response.rb +263 -0
- data/lib/pulp_maven_client/models/paginatedmaven_maven_index_page_response_list.rb +257 -0
- data/lib/pulp_maven_client/models/repository_add_remove_content.rb +1 -1
- data/lib/pulp_maven_client/models/repository_version_response.rb +1 -1
- data/lib/pulp_maven_client/version.rb +1 -1
- data/lib/pulp_maven_client.rb +7 -0
- data/spec/api/content_maven_index_page_api_spec.rb +104 -0
- data/spec/api/content_package_api_spec.rb +3 -0
- data/spec/api/repositories_maven_api_spec.rb +47 -0
- data/spec/models/maven_maven_index_page_response_spec.rb +78 -0
- data/spec/models/maven_maven_package_response_spec.rb +6 -0
- data/spec/models/maven_package_release_response_spec.rb +48 -0
- data/spec/models/maven_repository_metrics_response_spec.rb +48 -0
- data/spec/models/maven_repository_package_response_spec.rb +54 -0
- data/spec/models/paginated_maven_repository_package_list_response_spec.rb +54 -0
- data/spec/models/paginatedmaven_maven_index_page_response_list_spec.rb +54 -0
- metadata +60 -32
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 94e3ffaf335fe606500d36b0f02e15090ac7fbe16c48802b84a2ce7d5e53c7d1
|
|
4
|
+
data.tar.gz: cc280132a00c810b2c1ea801e6dbca60061839de632cbd31ca60f43dc74bde0a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a0525a65f64878d26a234190ab92b83a4c14ed2c164709a1805035ccca9900b713907b86f2e9758a512cba41c39d0b1f8a9e44a1d0ee7bf616847277db13ea55
|
|
7
|
+
data.tar.gz: e2133f19b48f294a4a210ae036a4a74121b3f4922b924436f8202cdbf411850057b68c8d9ce768ca110ccea1f940da70f97d145cafaf74f0d7fbd6ab009ed3ba
|
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: 0.
|
|
10
|
+
- Package version: 0.27.0
|
|
11
11
|
- Generator version: 7.10.0
|
|
12
12
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
13
13
|
For more information, please visit [https://pulpproject.org](https://pulpproject.org)
|
|
@@ -25,16 +25,16 @@ gem build pulp_maven_client.gemspec
|
|
|
25
25
|
Then either install the gem locally:
|
|
26
26
|
|
|
27
27
|
```shell
|
|
28
|
-
gem install ./pulp_maven_client-0.
|
|
28
|
+
gem install ./pulp_maven_client-0.27.0.gem
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
(for development, run `gem install --dev ./pulp_maven_client-0.
|
|
31
|
+
(for development, run `gem install --dev ./pulp_maven_client-0.27.0.gem` to install the development dependencies)
|
|
32
32
|
|
|
33
33
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
34
34
|
|
|
35
35
|
Finally add this to the Gemfile:
|
|
36
36
|
|
|
37
|
-
gem 'pulp_maven_client', '~> 0.
|
|
37
|
+
gem 'pulp_maven_client', '~> 0.27.0'
|
|
38
38
|
|
|
39
39
|
### Install from Git
|
|
40
40
|
|
|
@@ -103,6 +103,10 @@ Class | Method | HTTP request | Description
|
|
|
103
103
|
*PulpMavenClient::ContentArtifactApi* | [**set_label**](docs/ContentArtifactApi.md#set_label) | **POST** {maven_maven_artifact_href}set_label/ | Set a label
|
|
104
104
|
*PulpMavenClient::ContentArtifactApi* | [**unset_label**](docs/ContentArtifactApi.md#unset_label) | **POST** {maven_maven_artifact_href}unset_label/ | Unset a label
|
|
105
105
|
*PulpMavenClient::ContentArtifactApi* | [**upload**](docs/ContentArtifactApi.md#upload) | **POST** /pulp/api/v3/content/maven/artifact/upload/ | Upload a Maven artifact synchronously.
|
|
106
|
+
*PulpMavenClient::ContentMavenIndexPageApi* | [**list**](docs/ContentMavenIndexPageApi.md#list) | **GET** /pulp/api/v3/content/maven/maven/index-page/ | List maven index pages
|
|
107
|
+
*PulpMavenClient::ContentMavenIndexPageApi* | [**read**](docs/ContentMavenIndexPageApi.md#read) | **GET** {maven_maven_index_page_href} | Inspect a maven index page
|
|
108
|
+
*PulpMavenClient::ContentMavenIndexPageApi* | [**set_label**](docs/ContentMavenIndexPageApi.md#set_label) | **POST** {maven_maven_index_page_href}set_label/ | Set a label
|
|
109
|
+
*PulpMavenClient::ContentMavenIndexPageApi* | [**unset_label**](docs/ContentMavenIndexPageApi.md#unset_label) | **POST** {maven_maven_index_page_href}unset_label/ | Unset a label
|
|
106
110
|
*PulpMavenClient::ContentMetadataApi* | [**create**](docs/ContentMetadataApi.md#create) | **POST** /pulp/api/v3/content/maven/metadata/ | Create a maven metadata
|
|
107
111
|
*PulpMavenClient::ContentMetadataApi* | [**list**](docs/ContentMetadataApi.md#list) | **GET** /pulp/api/v3/content/maven/metadata/ | List maven metadatas
|
|
108
112
|
*PulpMavenClient::ContentMetadataApi* | [**read**](docs/ContentMetadataApi.md#read) | **GET** {maven_maven_metadata_href} | Inspect a maven metadata
|
|
@@ -145,11 +149,14 @@ Class | Method | HTTP request | Description
|
|
|
145
149
|
*PulpMavenClient::RepositoriesMavenApi* | [**delete**](docs/RepositoriesMavenApi.md#delete) | **DELETE** {maven_maven_repository_href} | Delete a maven repository
|
|
146
150
|
*PulpMavenClient::RepositoriesMavenApi* | [**list**](docs/RepositoriesMavenApi.md#list) | **GET** /pulp/api/v3/repositories/maven/maven/ | List maven repositorys
|
|
147
151
|
*PulpMavenClient::RepositoriesMavenApi* | [**list_roles**](docs/RepositoriesMavenApi.md#list_roles) | **GET** {maven_maven_repository_href}list_roles/ | List roles
|
|
152
|
+
*PulpMavenClient::RepositoriesMavenApi* | [**metrics**](docs/RepositoriesMavenApi.md#metrics) | **GET** {maven_maven_repository_href}metrics/ | Repository metrics
|
|
148
153
|
*PulpMavenClient::RepositoriesMavenApi* | [**modify**](docs/RepositoriesMavenApi.md#modify) | **POST** {maven_maven_repository_href}modify/ | Modify Repository Content
|
|
149
154
|
*PulpMavenClient::RepositoriesMavenApi* | [**my_permissions**](docs/RepositoriesMavenApi.md#my_permissions) | **GET** {maven_maven_repository_href}my_permissions/ | List user permissions
|
|
155
|
+
*PulpMavenClient::RepositoriesMavenApi* | [**packages**](docs/RepositoriesMavenApi.md#packages) | **GET** {maven_maven_repository_href}packages/ | List packages
|
|
150
156
|
*PulpMavenClient::RepositoriesMavenApi* | [**partial_update**](docs/RepositoriesMavenApi.md#partial_update) | **PATCH** {maven_maven_repository_href} | Update a maven repository
|
|
151
157
|
*PulpMavenClient::RepositoriesMavenApi* | [**read**](docs/RepositoriesMavenApi.md#read) | **GET** {maven_maven_repository_href} | Inspect a maven repository
|
|
152
158
|
*PulpMavenClient::RepositoriesMavenApi* | [**remove_role**](docs/RepositoriesMavenApi.md#remove_role) | **POST** {maven_maven_repository_href}remove_role/ | Remove a role
|
|
159
|
+
*PulpMavenClient::RepositoriesMavenApi* | [**repair_index_pages**](docs/RepositoriesMavenApi.md#repair_index_pages) | **POST** {maven_maven_repository_href}repair_index_pages/ | Repair index pages
|
|
153
160
|
*PulpMavenClient::RepositoriesMavenApi* | [**repair_metadata**](docs/RepositoriesMavenApi.md#repair_metadata) | **POST** {maven_maven_repository_href}repair_metadata/ | Repair metadata
|
|
154
161
|
*PulpMavenClient::RepositoriesMavenApi* | [**set_label**](docs/RepositoriesMavenApi.md#set_label) | **POST** {maven_maven_repository_href}set_label/ | Set a label
|
|
155
162
|
*PulpMavenClient::RepositoriesMavenApi* | [**unset_label**](docs/RepositoriesMavenApi.md#unset_label) | **POST** {maven_maven_repository_href}unset_label/ | Unset a label
|
|
@@ -167,6 +174,7 @@ Class | Method | HTTP request | Description
|
|
|
167
174
|
- [PulpMavenClient::MavenMavenArtifactResponse](docs/MavenMavenArtifactResponse.md)
|
|
168
175
|
- [PulpMavenClient::MavenMavenDistribution](docs/MavenMavenDistribution.md)
|
|
169
176
|
- [PulpMavenClient::MavenMavenDistributionResponse](docs/MavenMavenDistributionResponse.md)
|
|
177
|
+
- [PulpMavenClient::MavenMavenIndexPageResponse](docs/MavenMavenIndexPageResponse.md)
|
|
170
178
|
- [PulpMavenClient::MavenMavenMetadataResponse](docs/MavenMavenMetadataResponse.md)
|
|
171
179
|
- [PulpMavenClient::MavenMavenPackageResponse](docs/MavenMavenPackageResponse.md)
|
|
172
180
|
- [PulpMavenClient::MavenMavenRemote](docs/MavenMavenRemote.md)
|
|
@@ -174,13 +182,18 @@ Class | Method | HTTP request | Description
|
|
|
174
182
|
- [PulpMavenClient::MavenMavenRemoteResponseHiddenFieldsInner](docs/MavenMavenRemoteResponseHiddenFieldsInner.md)
|
|
175
183
|
- [PulpMavenClient::MavenMavenRepository](docs/MavenMavenRepository.md)
|
|
176
184
|
- [PulpMavenClient::MavenMavenRepositoryResponse](docs/MavenMavenRepositoryResponse.md)
|
|
185
|
+
- [PulpMavenClient::MavenPackageReleaseResponse](docs/MavenPackageReleaseResponse.md)
|
|
186
|
+
- [PulpMavenClient::MavenRepositoryMetricsResponse](docs/MavenRepositoryMetricsResponse.md)
|
|
187
|
+
- [PulpMavenClient::MavenRepositoryPackageResponse](docs/MavenRepositoryPackageResponse.md)
|
|
177
188
|
- [PulpMavenClient::MyPermissionsResponse](docs/MyPermissionsResponse.md)
|
|
178
189
|
- [PulpMavenClient::NestedRole](docs/NestedRole.md)
|
|
179
190
|
- [PulpMavenClient::NestedRoleResponse](docs/NestedRoleResponse.md)
|
|
180
191
|
- [PulpMavenClient::ObjectRolesResponse](docs/ObjectRolesResponse.md)
|
|
192
|
+
- [PulpMavenClient::PaginatedMavenRepositoryPackageListResponse](docs/PaginatedMavenRepositoryPackageListResponse.md)
|
|
181
193
|
- [PulpMavenClient::PaginatedRepositoryVersionResponseList](docs/PaginatedRepositoryVersionResponseList.md)
|
|
182
194
|
- [PulpMavenClient::PaginatedmavenMavenArtifactResponseList](docs/PaginatedmavenMavenArtifactResponseList.md)
|
|
183
195
|
- [PulpMavenClient::PaginatedmavenMavenDistributionResponseList](docs/PaginatedmavenMavenDistributionResponseList.md)
|
|
196
|
+
- [PulpMavenClient::PaginatedmavenMavenIndexPageResponseList](docs/PaginatedmavenMavenIndexPageResponseList.md)
|
|
184
197
|
- [PulpMavenClient::PaginatedmavenMavenMetadataResponseList](docs/PaginatedmavenMavenMetadataResponseList.md)
|
|
185
198
|
- [PulpMavenClient::PaginatedmavenMavenPackageResponseList](docs/PaginatedmavenMavenPackageResponseList.md)
|
|
186
199
|
- [PulpMavenClient::PaginatedmavenMavenRemoteResponseList](docs/PaginatedmavenMavenRemoteResponseList.md)
|
|
@@ -0,0 +1,341 @@
|
|
|
1
|
+
# PulpMavenClient::ContentMavenIndexPageApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**list**](ContentMavenIndexPageApi.md#list) | **GET** /pulp/api/v3/content/maven/maven/index-page/ | List maven index pages |
|
|
8
|
+
| [**read**](ContentMavenIndexPageApi.md#read) | **GET** {maven_maven_index_page_href} | Inspect a maven index page |
|
|
9
|
+
| [**set_label**](ContentMavenIndexPageApi.md#set_label) | **POST** {maven_maven_index_page_href}set_label/ | Set a label |
|
|
10
|
+
| [**unset_label**](ContentMavenIndexPageApi.md#unset_label) | **POST** {maven_maven_index_page_href}unset_label/ | Unset a label |
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## list
|
|
14
|
+
|
|
15
|
+
> <PaginatedmavenMavenIndexPageResponseList> list(opts)
|
|
16
|
+
|
|
17
|
+
List maven index pages
|
|
18
|
+
|
|
19
|
+
A read-only ViewSet for MavenIndexPage.
|
|
20
|
+
|
|
21
|
+
### Examples
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'time'
|
|
25
|
+
require 'pulp_maven_client'
|
|
26
|
+
# setup authorization
|
|
27
|
+
PulpMavenClient.configure do |config|
|
|
28
|
+
# Configure HTTP basic authorization: basicAuth
|
|
29
|
+
config.username = 'YOUR USERNAME'
|
|
30
|
+
config.password = 'YOUR PASSWORD'
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
api_instance = PulpMavenClient::ContentMavenIndexPageApi.new
|
|
34
|
+
opts = {
|
|
35
|
+
x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
|
|
36
|
+
limit: 56, # Integer | Number of results to return per page.
|
|
37
|
+
offset: 56, # Integer | The initial index from which to return the results.
|
|
38
|
+
ordering: ['-pk'], # Array<String> | Ordering * `pk` - Pk * `-pk` - Pk (descending)
|
|
39
|
+
orphaned_for: 8.14, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
|
|
40
|
+
prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
|
41
|
+
pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
|
42
|
+
pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
|
43
|
+
pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
|
|
44
|
+
q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
|
|
45
|
+
repository_version: 'repository_version_example', # String |
|
|
46
|
+
repository_version_added: 'repository_version_added_example', # String |
|
|
47
|
+
repository_version_removed: 'repository_version_removed_example', # String |
|
|
48
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
|
49
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
begin
|
|
53
|
+
# List maven index pages
|
|
54
|
+
result = api_instance.list(opts)
|
|
55
|
+
p result
|
|
56
|
+
rescue PulpMavenClient::ApiError => e
|
|
57
|
+
puts "Error when calling ContentMavenIndexPageApi->list: #{e}"
|
|
58
|
+
end
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
#### Using the list_with_http_info variant
|
|
62
|
+
|
|
63
|
+
This returns an Array which contains the response data, status code and headers.
|
|
64
|
+
|
|
65
|
+
> <Array(<PaginatedmavenMavenIndexPageResponseList>, Integer, Hash)> list_with_http_info(opts)
|
|
66
|
+
|
|
67
|
+
```ruby
|
|
68
|
+
begin
|
|
69
|
+
# List maven index pages
|
|
70
|
+
data, status_code, headers = api_instance.list_with_http_info(opts)
|
|
71
|
+
p status_code # => 2xx
|
|
72
|
+
p headers # => { ... }
|
|
73
|
+
p data # => <PaginatedmavenMavenIndexPageResponseList>
|
|
74
|
+
rescue PulpMavenClient::ApiError => e
|
|
75
|
+
puts "Error when calling ContentMavenIndexPageApi->list_with_http_info: #{e}"
|
|
76
|
+
end
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### Parameters
|
|
80
|
+
|
|
81
|
+
| Name | Type | Description | Notes |
|
|
82
|
+
| ---- | ---- | ----------- | ----- |
|
|
83
|
+
| **x_task_diagnostics** | [**Array<String>**](String.md) | List of profilers to use on tasks. | [optional] |
|
|
84
|
+
| **limit** | **Integer** | Number of results to return per page. | [optional] |
|
|
85
|
+
| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
|
|
86
|
+
| **ordering** | [**Array<String>**](String.md) | Ordering * `pk` - Pk * `-pk` - Pk (descending) | [optional] |
|
|
87
|
+
| **orphaned_for** | **Float** | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [optional] |
|
|
88
|
+
| **prn__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
|
89
|
+
| **pulp_href__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
|
90
|
+
| **pulp_id__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
|
91
|
+
| **pulp_label_select** | **String** | Filter labels by search string | [optional] |
|
|
92
|
+
| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
|
|
93
|
+
| **repository_version** | **String** | | [optional] |
|
|
94
|
+
| **repository_version_added** | **String** | | [optional] |
|
|
95
|
+
| **repository_version_removed** | **String** | | [optional] |
|
|
96
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
|
97
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
|
98
|
+
|
|
99
|
+
### Return type
|
|
100
|
+
|
|
101
|
+
[**PaginatedmavenMavenIndexPageResponseList**](PaginatedmavenMavenIndexPageResponseList.md)
|
|
102
|
+
|
|
103
|
+
### Authorization
|
|
104
|
+
|
|
105
|
+
[basicAuth](../README.md#basicAuth)
|
|
106
|
+
|
|
107
|
+
### HTTP request headers
|
|
108
|
+
|
|
109
|
+
- **Content-Type**: Not defined
|
|
110
|
+
- **Accept**: application/json
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
## read
|
|
114
|
+
|
|
115
|
+
> <MavenMavenIndexPageResponse> read(maven_maven_index_page_href, opts)
|
|
116
|
+
|
|
117
|
+
Inspect a maven index page
|
|
118
|
+
|
|
119
|
+
A read-only ViewSet for MavenIndexPage.
|
|
120
|
+
|
|
121
|
+
### Examples
|
|
122
|
+
|
|
123
|
+
```ruby
|
|
124
|
+
require 'time'
|
|
125
|
+
require 'pulp_maven_client'
|
|
126
|
+
# setup authorization
|
|
127
|
+
PulpMavenClient.configure do |config|
|
|
128
|
+
# Configure HTTP basic authorization: basicAuth
|
|
129
|
+
config.username = 'YOUR USERNAME'
|
|
130
|
+
config.password = 'YOUR PASSWORD'
|
|
131
|
+
end
|
|
132
|
+
|
|
133
|
+
api_instance = PulpMavenClient::ContentMavenIndexPageApi.new
|
|
134
|
+
maven_maven_index_page_href = 'maven_maven_index_page_href_example' # String |
|
|
135
|
+
opts = {
|
|
136
|
+
x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
|
|
137
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
|
138
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
begin
|
|
142
|
+
# Inspect a maven index page
|
|
143
|
+
result = api_instance.read(maven_maven_index_page_href, opts)
|
|
144
|
+
p result
|
|
145
|
+
rescue PulpMavenClient::ApiError => e
|
|
146
|
+
puts "Error when calling ContentMavenIndexPageApi->read: #{e}"
|
|
147
|
+
end
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
#### Using the read_with_http_info variant
|
|
151
|
+
|
|
152
|
+
This returns an Array which contains the response data, status code and headers.
|
|
153
|
+
|
|
154
|
+
> <Array(<MavenMavenIndexPageResponse>, Integer, Hash)> read_with_http_info(maven_maven_index_page_href, opts)
|
|
155
|
+
|
|
156
|
+
```ruby
|
|
157
|
+
begin
|
|
158
|
+
# Inspect a maven index page
|
|
159
|
+
data, status_code, headers = api_instance.read_with_http_info(maven_maven_index_page_href, opts)
|
|
160
|
+
p status_code # => 2xx
|
|
161
|
+
p headers # => { ... }
|
|
162
|
+
p data # => <MavenMavenIndexPageResponse>
|
|
163
|
+
rescue PulpMavenClient::ApiError => e
|
|
164
|
+
puts "Error when calling ContentMavenIndexPageApi->read_with_http_info: #{e}"
|
|
165
|
+
end
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
### Parameters
|
|
169
|
+
|
|
170
|
+
| Name | Type | Description | Notes |
|
|
171
|
+
| ---- | ---- | ----------- | ----- |
|
|
172
|
+
| **maven_maven_index_page_href** | **String** | | |
|
|
173
|
+
| **x_task_diagnostics** | [**Array<String>**](String.md) | List of profilers to use on tasks. | [optional] |
|
|
174
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
|
175
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
|
176
|
+
|
|
177
|
+
### Return type
|
|
178
|
+
|
|
179
|
+
[**MavenMavenIndexPageResponse**](MavenMavenIndexPageResponse.md)
|
|
180
|
+
|
|
181
|
+
### Authorization
|
|
182
|
+
|
|
183
|
+
[basicAuth](../README.md#basicAuth)
|
|
184
|
+
|
|
185
|
+
### HTTP request headers
|
|
186
|
+
|
|
187
|
+
- **Content-Type**: Not defined
|
|
188
|
+
- **Accept**: application/json
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
## set_label
|
|
192
|
+
|
|
193
|
+
> <SetLabelResponse> set_label(maven_maven_index_page_href, set_label, opts)
|
|
194
|
+
|
|
195
|
+
Set a label
|
|
196
|
+
|
|
197
|
+
Set a single pulp_label on the object to a specific value or null.
|
|
198
|
+
|
|
199
|
+
### Examples
|
|
200
|
+
|
|
201
|
+
```ruby
|
|
202
|
+
require 'time'
|
|
203
|
+
require 'pulp_maven_client'
|
|
204
|
+
# setup authorization
|
|
205
|
+
PulpMavenClient.configure do |config|
|
|
206
|
+
# Configure HTTP basic authorization: basicAuth
|
|
207
|
+
config.username = 'YOUR USERNAME'
|
|
208
|
+
config.password = 'YOUR PASSWORD'
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
api_instance = PulpMavenClient::ContentMavenIndexPageApi.new
|
|
212
|
+
maven_maven_index_page_href = 'maven_maven_index_page_href_example' # String |
|
|
213
|
+
set_label = PulpMavenClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel |
|
|
214
|
+
opts = {
|
|
215
|
+
x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
begin
|
|
219
|
+
# Set a label
|
|
220
|
+
result = api_instance.set_label(maven_maven_index_page_href, set_label, opts)
|
|
221
|
+
p result
|
|
222
|
+
rescue PulpMavenClient::ApiError => e
|
|
223
|
+
puts "Error when calling ContentMavenIndexPageApi->set_label: #{e}"
|
|
224
|
+
end
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
#### Using the set_label_with_http_info variant
|
|
228
|
+
|
|
229
|
+
This returns an Array which contains the response data, status code and headers.
|
|
230
|
+
|
|
231
|
+
> <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(maven_maven_index_page_href, set_label, opts)
|
|
232
|
+
|
|
233
|
+
```ruby
|
|
234
|
+
begin
|
|
235
|
+
# Set a label
|
|
236
|
+
data, status_code, headers = api_instance.set_label_with_http_info(maven_maven_index_page_href, set_label, opts)
|
|
237
|
+
p status_code # => 2xx
|
|
238
|
+
p headers # => { ... }
|
|
239
|
+
p data # => <SetLabelResponse>
|
|
240
|
+
rescue PulpMavenClient::ApiError => e
|
|
241
|
+
puts "Error when calling ContentMavenIndexPageApi->set_label_with_http_info: #{e}"
|
|
242
|
+
end
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
### Parameters
|
|
246
|
+
|
|
247
|
+
| Name | Type | Description | Notes |
|
|
248
|
+
| ---- | ---- | ----------- | ----- |
|
|
249
|
+
| **maven_maven_index_page_href** | **String** | | |
|
|
250
|
+
| **set_label** | [**SetLabel**](SetLabel.md) | | |
|
|
251
|
+
| **x_task_diagnostics** | [**Array<String>**](String.md) | List of profilers to use on tasks. | [optional] |
|
|
252
|
+
|
|
253
|
+
### Return type
|
|
254
|
+
|
|
255
|
+
[**SetLabelResponse**](SetLabelResponse.md)
|
|
256
|
+
|
|
257
|
+
### Authorization
|
|
258
|
+
|
|
259
|
+
[basicAuth](../README.md#basicAuth)
|
|
260
|
+
|
|
261
|
+
### HTTP request headers
|
|
262
|
+
|
|
263
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
264
|
+
- **Accept**: application/json
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
## unset_label
|
|
268
|
+
|
|
269
|
+
> <UnsetLabelResponse> unset_label(maven_maven_index_page_href, unset_label, opts)
|
|
270
|
+
|
|
271
|
+
Unset a label
|
|
272
|
+
|
|
273
|
+
Unset a single pulp_label on the object.
|
|
274
|
+
|
|
275
|
+
### Examples
|
|
276
|
+
|
|
277
|
+
```ruby
|
|
278
|
+
require 'time'
|
|
279
|
+
require 'pulp_maven_client'
|
|
280
|
+
# setup authorization
|
|
281
|
+
PulpMavenClient.configure do |config|
|
|
282
|
+
# Configure HTTP basic authorization: basicAuth
|
|
283
|
+
config.username = 'YOUR USERNAME'
|
|
284
|
+
config.password = 'YOUR PASSWORD'
|
|
285
|
+
end
|
|
286
|
+
|
|
287
|
+
api_instance = PulpMavenClient::ContentMavenIndexPageApi.new
|
|
288
|
+
maven_maven_index_page_href = 'maven_maven_index_page_href_example' # String |
|
|
289
|
+
unset_label = PulpMavenClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel |
|
|
290
|
+
opts = {
|
|
291
|
+
x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
begin
|
|
295
|
+
# Unset a label
|
|
296
|
+
result = api_instance.unset_label(maven_maven_index_page_href, unset_label, opts)
|
|
297
|
+
p result
|
|
298
|
+
rescue PulpMavenClient::ApiError => e
|
|
299
|
+
puts "Error when calling ContentMavenIndexPageApi->unset_label: #{e}"
|
|
300
|
+
end
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
#### Using the unset_label_with_http_info variant
|
|
304
|
+
|
|
305
|
+
This returns an Array which contains the response data, status code and headers.
|
|
306
|
+
|
|
307
|
+
> <Array(<UnsetLabelResponse>, Integer, Hash)> unset_label_with_http_info(maven_maven_index_page_href, unset_label, opts)
|
|
308
|
+
|
|
309
|
+
```ruby
|
|
310
|
+
begin
|
|
311
|
+
# Unset a label
|
|
312
|
+
data, status_code, headers = api_instance.unset_label_with_http_info(maven_maven_index_page_href, unset_label, opts)
|
|
313
|
+
p status_code # => 2xx
|
|
314
|
+
p headers # => { ... }
|
|
315
|
+
p data # => <UnsetLabelResponse>
|
|
316
|
+
rescue PulpMavenClient::ApiError => e
|
|
317
|
+
puts "Error when calling ContentMavenIndexPageApi->unset_label_with_http_info: #{e}"
|
|
318
|
+
end
|
|
319
|
+
```
|
|
320
|
+
|
|
321
|
+
### Parameters
|
|
322
|
+
|
|
323
|
+
| Name | Type | Description | Notes |
|
|
324
|
+
| ---- | ---- | ----------- | ----- |
|
|
325
|
+
| **maven_maven_index_page_href** | **String** | | |
|
|
326
|
+
| **unset_label** | [**UnsetLabel**](UnsetLabel.md) | | |
|
|
327
|
+
| **x_task_diagnostics** | [**Array<String>**](String.md) | List of profilers to use on tasks. | [optional] |
|
|
328
|
+
|
|
329
|
+
### Return type
|
|
330
|
+
|
|
331
|
+
[**UnsetLabelResponse**](UnsetLabelResponse.md)
|
|
332
|
+
|
|
333
|
+
### Authorization
|
|
334
|
+
|
|
335
|
+
[basicAuth](../README.md#basicAuth)
|
|
336
|
+
|
|
337
|
+
### HTTP request headers
|
|
338
|
+
|
|
339
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
340
|
+
- **Accept**: application/json
|
|
341
|
+
|
data/docs/ContentPackageApi.md
CHANGED
|
@@ -34,6 +34,8 @@ api_instance = PulpMavenClient::ContentPackageApi.new
|
|
|
34
34
|
opts = {
|
|
35
35
|
x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
|
|
36
36
|
artifact_id: 'artifact_id_example', # String | Filter results where artifact_id matches value
|
|
37
|
+
base_version: 'base_version_example', # String | Match units whose version strips to this logical version (same suffix as collapse_builds: \\.[a-zA-Z]+-\\d+$). 5.3.18 matches 5.3.18 and 5.3.18.rhlw-00003, but not 5.3.180.
|
|
38
|
+
collapse_builds: true, # Boolean | When true, collapse rebuilds of the same logical version: strip a trailing suffix matching \\.[a-zA-Z]+-\\d+$ from version, then keep one MavenPackage per (group_id, artifact_id, base_version) with the latest pulp_created. Default false.
|
|
37
39
|
group_id: 'group_id_example', # String | Filter results where group_id matches value
|
|
38
40
|
limit: 56, # Integer | Number of results to return per page.
|
|
39
41
|
name: 'name_example', # String | Filter results where name matches value
|
|
@@ -50,6 +52,7 @@ opts = {
|
|
|
50
52
|
repository_version_added: 'repository_version_added_example', # String |
|
|
51
53
|
repository_version_removed: 'repository_version_removed_example', # String |
|
|
52
54
|
version: 'version_example', # String | Filter results where version matches value
|
|
55
|
+
version__startswith: 'version__startswith_example', # String | Filter results where version starts with value
|
|
53
56
|
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
|
54
57
|
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
|
55
58
|
}
|
|
@@ -87,6 +90,8 @@ end
|
|
|
87
90
|
| ---- | ---- | ----------- | ----- |
|
|
88
91
|
| **x_task_diagnostics** | [**Array<String>**](String.md) | List of profilers to use on tasks. | [optional] |
|
|
89
92
|
| **artifact_id** | **String** | Filter results where artifact_id matches value | [optional] |
|
|
93
|
+
| **base_version** | **String** | Match units whose version strips to this logical version (same suffix as collapse_builds: \\.[a-zA-Z]+-\\d+$). 5.3.18 matches 5.3.18 and 5.3.18.rhlw-00003, but not 5.3.180. | [optional] |
|
|
94
|
+
| **collapse_builds** | **Boolean** | When true, collapse rebuilds of the same logical version: strip a trailing suffix matching \\.[a-zA-Z]+-\\d+$ from version, then keep one MavenPackage per (group_id, artifact_id, base_version) with the latest pulp_created. Default false. | [optional] |
|
|
90
95
|
| **group_id** | **String** | Filter results where group_id matches value | [optional] |
|
|
91
96
|
| **limit** | **Integer** | Number of results to return per page. | [optional] |
|
|
92
97
|
| **name** | **String** | Filter results where name matches value | [optional] |
|
|
@@ -103,6 +108,7 @@ end
|
|
|
103
108
|
| **repository_version_added** | **String** | | [optional] |
|
|
104
109
|
| **repository_version_removed** | **String** | | [optional] |
|
|
105
110
|
| **version** | **String** | Filter results where version matches value | [optional] |
|
|
111
|
+
| **version__startswith** | **String** | Filter results where version starts with value | [optional] |
|
|
106
112
|
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
|
107
113
|
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
|
108
114
|
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# PulpMavenClient::MavenMavenIndexPageResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
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
|
+
| **pulp_labels** | **Hash<String, String>** | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. | [optional] |
|
|
12
|
+
| **vuln_report** | **String** | | [optional][readonly] |
|
|
13
|
+
| **path** | **String** | Directory path this page indexes. | [optional][readonly] |
|
|
14
|
+
| **sha256** | **String** | SHA256 digest of the HTML content. | [optional][readonly] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'pulp_maven_client'
|
|
20
|
+
|
|
21
|
+
instance = PulpMavenClient::MavenMavenIndexPageResponse.new(
|
|
22
|
+
pulp_href: null,
|
|
23
|
+
prn: null,
|
|
24
|
+
pulp_created: null,
|
|
25
|
+
pulp_last_updated: null,
|
|
26
|
+
pulp_labels: null,
|
|
27
|
+
vuln_report: null,
|
|
28
|
+
path: null,
|
|
29
|
+
sha256: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| **group_id** | **String** | Group Id of the package. | [optional][readonly] |
|
|
14
14
|
| **artifact_id** | **String** | Artifact Id of the package. | [optional][readonly] |
|
|
15
15
|
| **version** | **String** | Version of the package. | [optional][readonly] |
|
|
16
|
+
| **base_version** | **String** | The package version with a trailing rebuild suffix stripped (matching \\.[a-zA-Z]+-\\d+$). Equal to version when no suffix is present. | [optional][readonly] |
|
|
16
17
|
| **name** | **String** | Human-readable name from the POM. | [optional][readonly] |
|
|
17
18
|
| **description** | **String** | Description from the POM. | [optional][readonly] |
|
|
18
19
|
| **packaging** | **String** | Packaging type (jar, war, pom, etc). | [optional][readonly] |
|
|
@@ -36,6 +37,7 @@ instance = PulpMavenClient::MavenMavenPackageResponse.new(
|
|
|
36
37
|
group_id: null,
|
|
37
38
|
artifact_id: null,
|
|
38
39
|
version: null,
|
|
40
|
+
base_version: null,
|
|
39
41
|
name: null,
|
|
40
42
|
description: null,
|
|
41
43
|
packaging: null,
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# PulpMavenClient::MavenPackageReleaseResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **version** | **String** | Logical version key (rebuild suffix stripped). | |
|
|
8
|
+
| **release** | **String** | Rebuild/release qualifier within the version line (e.g. rhlw-00003). Empty when the selected unit has no rebuild suffix. | |
|
|
9
|
+
| **created_at** | **Time** | When this logical version entered the repository: RepositoryContent.pulp_created of the newest rebuild, falling back to the content unit's pulp_created. | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'pulp_maven_client'
|
|
15
|
+
|
|
16
|
+
instance = PulpMavenClient::MavenPackageReleaseResponse.new(
|
|
17
|
+
version: null,
|
|
18
|
+
release: null,
|
|
19
|
+
created_at: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# PulpMavenClient::MavenRepositoryMetricsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **package_count** | **Integer** | Distinct (group_id, artifact_id) pairs among MavenPackage units. | |
|
|
8
|
+
| **version_count** | **Integer** | Distinct (group_id, artifact_id, base_version) triples after rebuild-suffix strip. | |
|
|
9
|
+
| **build_count** | **Integer** | Distinct (group_id, artifact_id, full version) GAVs among MavenPackage units. | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'pulp_maven_client'
|
|
15
|
+
|
|
16
|
+
instance = PulpMavenClient::MavenRepositoryMetricsResponse.new(
|
|
17
|
+
package_count: null,
|
|
18
|
+
version_count: null,
|
|
19
|
+
build_count: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# PulpMavenClient::MavenRepositoryPackageResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **group_id** | **String** | Maven groupId. Index rows are unique on GA. | |
|
|
8
|
+
| **artifact_id** | **String** | Maven artifactId. Index rows are unique on GA. | |
|
|
9
|
+
| **versions** | **Array<String>** | Distinct logical version keys after rebuild-suffix strip. The set of values matches latest_releases[].version. | |
|
|
10
|
+
| **latest_releases** | [**Array<MavenPackageReleaseResponse>**](MavenPackageReleaseResponse.md) | Newest rebuild per logical version (latest pulp_created). set(versions) === set(latest_releases[].version). | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'pulp_maven_client'
|
|
16
|
+
|
|
17
|
+
instance = PulpMavenClient::MavenRepositoryPackageResponse.new(
|
|
18
|
+
group_id: null,
|
|
19
|
+
artifact_id: null,
|
|
20
|
+
versions: null,
|
|
21
|
+
latest_releases: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# PulpMavenClient::PaginatedMavenRepositoryPackageListResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **count** | **Integer** | | |
|
|
8
|
+
| **_next** | **String** | | |
|
|
9
|
+
| **previous** | **String** | | |
|
|
10
|
+
| **results** | [**Array<MavenRepositoryPackageResponse>**](MavenRepositoryPackageResponse.md) | | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'pulp_maven_client'
|
|
16
|
+
|
|
17
|
+
instance = PulpMavenClient::PaginatedMavenRepositoryPackageListResponse.new(
|
|
18
|
+
count: null,
|
|
19
|
+
_next: null,
|
|
20
|
+
previous: null,
|
|
21
|
+
results: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# PulpMavenClient::PaginatedmavenMavenIndexPageResponseList
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **count** | **Integer** | | |
|
|
8
|
+
| **_next** | **String** | | [optional] |
|
|
9
|
+
| **previous** | **String** | | [optional] |
|
|
10
|
+
| **results** | [**Array<MavenMavenIndexPageResponse>**](MavenMavenIndexPageResponse.md) | | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'pulp_maven_client'
|
|
16
|
+
|
|
17
|
+
instance = PulpMavenClient::PaginatedmavenMavenIndexPageResponseList.new(
|
|
18
|
+
count: 123,
|
|
19
|
+
_next: http://api.example.org/accounts/?offset=400&limit=100,
|
|
20
|
+
previous: http://api.example.org/accounts/?offset=200&limit=100,
|
|
21
|
+
results: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|