pulp_maven_client 0.3.3 → 0.4.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.
Files changed (48) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +7 -4
  3. data/docs/ContentArtifactApi.md +8 -8
  4. data/docs/DistributionsMavenApi.md +18 -12
  5. data/docs/MavenMavenDistribution.md +1 -1
  6. data/docs/MavenMavenDistributionResponse.md +1 -1
  7. data/docs/MavenMavenRemote.md +1 -1
  8. data/docs/MavenMavenRemoteResponse.md +4 -2
  9. data/docs/MavenMavenRemoteResponseHiddenFields.md +19 -0
  10. data/docs/MavenMavenRepository.md +2 -2
  11. data/docs/MavenMavenRepositoryResponse.md +2 -2
  12. data/docs/PatchedmavenMavenDistribution.md +1 -1
  13. data/docs/PatchedmavenMavenRemote.md +1 -1
  14. data/docs/PatchedmavenMavenRepository.md +2 -2
  15. data/docs/PulpMavenApi.md +110 -0
  16. data/docs/RemotesMavenApi.md +12 -12
  17. data/docs/RepositoriesMavenApi.md +28 -10
  18. data/docs/RepositoriesMavenVersionsApi.md +12 -12
  19. data/lib/pulp_maven_client/api/content_artifact_api.rb +13 -13
  20. data/lib/pulp_maven_client/api/distributions_maven_api.rb +26 -17
  21. data/lib/pulp_maven_client/api/pulp_maven_api.rb +176 -0
  22. data/lib/pulp_maven_client/api/remotes_maven_api.rb +17 -17
  23. data/lib/pulp_maven_client/api/repositories_maven_api.rb +42 -15
  24. data/lib/pulp_maven_client/api/repositories_maven_versions_api.rb +17 -17
  25. data/lib/pulp_maven_client/api_client.rb +1 -1
  26. data/lib/pulp_maven_client/models/maven_maven_distribution.rb +4 -2
  27. data/lib/pulp_maven_client/models/maven_maven_distribution_response.rb +4 -2
  28. data/lib/pulp_maven_client/models/maven_maven_remote.rb +4 -2
  29. data/lib/pulp_maven_client/models/maven_maven_remote_response.rb +21 -7
  30. data/lib/pulp_maven_client/models/maven_maven_remote_response_hidden_fields.rb +215 -0
  31. data/lib/pulp_maven_client/models/maven_maven_repository.rb +5 -3
  32. data/lib/pulp_maven_client/models/maven_maven_repository_response.rb +5 -3
  33. data/lib/pulp_maven_client/models/patchedmaven_maven_distribution.rb +4 -2
  34. data/lib/pulp_maven_client/models/patchedmaven_maven_remote.rb +4 -2
  35. data/lib/pulp_maven_client/models/patchedmaven_maven_repository.rb +5 -3
  36. data/lib/pulp_maven_client/version.rb +1 -1
  37. data/lib/pulp_maven_client.rb +2 -0
  38. data/pulp_maven_client.gemspec +3 -3
  39. data/spec/api/content_artifact_api_spec.rb +4 -4
  40. data/spec/api/distributions_maven_api_spec.rb +9 -6
  41. data/spec/api/pulp_maven_api_spec.rb +61 -0
  42. data/spec/api/remotes_maven_api_spec.rb +6 -6
  43. data/spec/api/repositories_maven_api_spec.rb +14 -5
  44. data/spec/api/repositories_maven_versions_api_spec.rb +6 -6
  45. data/spec/models/maven_maven_remote_response_hidden_fields_spec.rb +47 -0
  46. data/spec/models/maven_maven_remote_response_spec.rb +6 -0
  47. metadata +34 -27
  48. data/git_push.sh +0 -58
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5f49c339b5ad7c1705e11e6dd6702cbb0882ba6fc1de6dde1d34e90502a52e1f
4
- data.tar.gz: cea28224fdb24aa34e1b6da1e1925831a7012814499c0d7bf3e9dbf0eecdca1d
3
+ metadata.gz: 3ebe8636fd7e0dac61d2b70b47da83a2790a6cd12e3721e554226908b8679ba9
4
+ data.tar.gz: 80d203c6f017eb08bd98edd13ffe827db1f44844fe6e53fb3234794085daf825
5
5
  SHA512:
6
- metadata.gz: 89a6fbef49de90991122b65d4b735230e2ec2a777a3804f39f48febff578ea40f7e41797910e1ed848015b2a5de92338aa1ee0e7b76b01adb8f0faf904de96d5
7
- data.tar.gz: 0cb46b7529cfb551ae4b69dba581eb21ae84110056a28378ace083b86859ffaa041421df62f4af4d35eb594b123900b72290d252a7ab301c18f83b3950ccf3dc
6
+ metadata.gz: 35f32d399eea63f8d68aad44abb19db3cd955c194c347c6d7ab02ce3f6143b7bca5ba351547280aee64041122d3e6d7bda86a01683feebe4588299d455eed339
7
+ data.tar.gz: 27f4635f95fb3279f0fd46d4b04900201e83f1f0c70acde426f7364fdb30fcbdff24f82c11ca5443241738e78c55b296c1a5ded9d587b5fd5254d1c8a367ae69
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.3.3
10
+ - Package version: 0.4.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_maven_client.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./pulp_maven_client-0.3.3.gem
27
+ gem install ./pulp_maven_client-0.4.0.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./pulp_maven_client-0.3.3.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./pulp_maven_client-0.4.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_maven_client', '~> 0.3.3'
36
+ gem 'pulp_maven_client', '~> 0.4.0'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -92,6 +92,8 @@ Class | Method | HTTP request | Description
92
92
  *PulpMavenClient::DistributionsMavenApi* | [**partial_update**](docs/DistributionsMavenApi.md#partial_update) | **PATCH** {maven_maven_distribution_href} | Update a maven distribution
93
93
  *PulpMavenClient::DistributionsMavenApi* | [**read**](docs/DistributionsMavenApi.md#read) | **GET** {maven_maven_distribution_href} | Inspect a maven distribution
94
94
  *PulpMavenClient::DistributionsMavenApi* | [**update**](docs/DistributionsMavenApi.md#update) | **PUT** {maven_maven_distribution_href} | Update a maven distribution
95
+ *PulpMavenClient::PulpMavenApi* | [**get**](docs/PulpMavenApi.md#get) | **GET** /pulp/maven/{name}/{path} |
96
+ *PulpMavenClient::PulpMavenApi* | [**put**](docs/PulpMavenApi.md#put) | **PUT** /pulp/maven/{name}/{path} |
95
97
  *PulpMavenClient::RemotesMavenApi* | [**create**](docs/RemotesMavenApi.md#create) | **POST** /pulp/api/v3/remotes/maven/maven/ | Create a maven remote
96
98
  *PulpMavenClient::RemotesMavenApi* | [**delete**](docs/RemotesMavenApi.md#delete) | **DELETE** {maven_maven_remote_href} | Delete a maven remote
97
99
  *PulpMavenClient::RemotesMavenApi* | [**list**](docs/RemotesMavenApi.md#list) | **GET** /pulp/api/v3/remotes/maven/maven/ | List maven remotes
@@ -120,6 +122,7 @@ Class | Method | HTTP request | Description
120
122
  - [PulpMavenClient::MavenMavenDistributionResponse](docs/MavenMavenDistributionResponse.md)
121
123
  - [PulpMavenClient::MavenMavenRemote](docs/MavenMavenRemote.md)
122
124
  - [PulpMavenClient::MavenMavenRemoteResponse](docs/MavenMavenRemoteResponse.md)
125
+ - [PulpMavenClient::MavenMavenRemoteResponseHiddenFields](docs/MavenMavenRemoteResponseHiddenFields.md)
123
126
  - [PulpMavenClient::MavenMavenRepository](docs/MavenMavenRepository.md)
124
127
  - [PulpMavenClient::MavenMavenRepositoryResponse](docs/MavenMavenRepositoryResponse.md)
125
128
  - [PulpMavenClient::PaginatedRepositoryVersionResponseList](docs/PaginatedRepositoryVersionResponseList.md)
@@ -95,8 +95,8 @@ opts = {
95
95
  repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF
96
96
  repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF
97
97
  version: 'version_example', # String | Filter results where version matches value
98
- fields: 'fields_example', # String | A list of fields to include in the response.
99
- exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
98
+ fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
99
+ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
100
100
  }
101
101
 
102
102
  begin
@@ -123,8 +123,8 @@ Name | Type | Description | Notes
123
123
  **repository_version_added** | **String**| Repository Version referenced by HREF | [optional]
124
124
  **repository_version_removed** | **String**| Repository Version referenced by HREF | [optional]
125
125
  **version** | **String**| Filter results where version matches value | [optional]
126
- **fields** | **String**| A list of fields to include in the response. | [optional]
127
- **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
126
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
127
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
128
128
 
129
129
  ### Return type
130
130
 
@@ -163,8 +163,8 @@ end
163
163
  api_instance = PulpMavenClient::ContentArtifactApi.new
164
164
  maven_maven_artifact_href = 'maven_maven_artifact_href_example' # String |
165
165
  opts = {
166
- fields: 'fields_example', # String | A list of fields to include in the response.
167
- exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
166
+ fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
167
+ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
168
168
  }
169
169
 
170
170
  begin
@@ -182,8 +182,8 @@ end
182
182
  Name | Type | Description | Notes
183
183
  ------------- | ------------- | ------------- | -------------
184
184
  **maven_maven_artifact_href** | **String**| |
185
- **fields** | **String**| A list of fields to include in the response. | [optional]
186
- **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
185
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
186
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
187
187
 
188
188
  ### Return type
189
189
 
@@ -141,12 +141,12 @@ end
141
141
 
142
142
  api_instance = PulpMavenClient::DistributionsMavenApi.new
143
143
  opts = {
144
- base_path: 'base_path_example', # String |
144
+ base_path: 'base_path_example', # String | Filter results where base_path matches value
145
145
  base_path__contains: 'base_path__contains_example', # String | Filter results where base_path contains value
146
146
  base_path__icontains: 'base_path__icontains_example', # String | Filter results where base_path contains value
147
147
  base_path__in: ['base_path__in_example'], # Array<String> | Filter results where base_path is in a comma-separated list of values
148
148
  limit: 56, # Integer | Number of results to return per page.
149
- name: 'name_example', # String |
149
+ name: 'name_example', # String | Filter results where name matches value
150
150
  name__contains: 'name__contains_example', # String | Filter results where name contains value
151
151
  name__icontains: 'name__icontains_example', # String | Filter results where name contains value
152
152
  name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
@@ -154,8 +154,11 @@ opts = {
154
154
  offset: 56, # Integer | The initial index from which to return the results.
155
155
  ordering: ['ordering_example'], # Array<String> | Ordering
156
156
  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
157
- fields: 'fields_example', # String | A list of fields to include in the response.
158
- exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
157
+ repository: 'repository_example', # String | Filter results where repository matches value
158
+ repository__in: ['repository__in_example'], # Array<String> | Filter results where repository is in a comma-separated list of values
159
+ with_content: 'with_content_example', # String | Filter distributions based on the content served by them
160
+ fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
161
+ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
159
162
  }
160
163
 
161
164
  begin
@@ -172,12 +175,12 @@ end
172
175
 
173
176
  Name | Type | Description | Notes
174
177
  ------------- | ------------- | ------------- | -------------
175
- **base_path** | **String**| | [optional]
178
+ **base_path** | **String**| Filter results where base_path matches value | [optional]
176
179
  **base_path__contains** | **String**| Filter results where base_path contains value | [optional]
177
180
  **base_path__icontains** | **String**| Filter results where base_path contains value | [optional]
178
181
  **base_path__in** | [**Array&lt;String&gt;**](String.md)| Filter results where base_path is in a comma-separated list of values | [optional]
179
182
  **limit** | **Integer**| Number of results to return per page. | [optional]
180
- **name** | **String**| | [optional]
183
+ **name** | **String**| Filter results where name matches value | [optional]
181
184
  **name__contains** | **String**| Filter results where name contains value | [optional]
182
185
  **name__icontains** | **String**| Filter results where name contains value | [optional]
183
186
  **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
@@ -185,8 +188,11 @@ Name | Type | Description | Notes
185
188
  **offset** | **Integer**| The initial index from which to return the results. | [optional]
186
189
  **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional]
187
190
  **pulp_label_select** | **String**| Filter labels by search string | [optional]
188
- **fields** | **String**| A list of fields to include in the response. | [optional]
189
- **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
191
+ **repository** | **String**| Filter results where repository matches value | [optional]
192
+ **repository__in** | [**Array&lt;String&gt;**](String.md)| Filter results where repository is in a comma-separated list of values | [optional]
193
+ **with_content** | **String**| Filter distributions based on the content served by them | [optional]
194
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
195
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
190
196
 
191
197
  ### Return type
192
198
 
@@ -280,8 +286,8 @@ end
280
286
  api_instance = PulpMavenClient::DistributionsMavenApi.new
281
287
  maven_maven_distribution_href = 'maven_maven_distribution_href_example' # String |
282
288
  opts = {
283
- fields: 'fields_example', # String | A list of fields to include in the response.
284
- exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
289
+ fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
290
+ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
285
291
  }
286
292
 
287
293
  begin
@@ -299,8 +305,8 @@ end
299
305
  Name | Type | Description | Notes
300
306
  ------------- | ------------- | ------------- | -------------
301
307
  **maven_maven_distribution_href** | **String**| |
302
- **fields** | **String**| A list of fields to include in the response. | [optional]
303
- **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
308
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
309
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
304
310
 
305
311
  ### Return type
306
312
 
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \&quot;foo\&quot; and \&quot;foo/bar\&quot;) |
8
8
  **content_guard** | **String** | An optional content-guard. | [optional]
9
- **pulp_labels** | [**Object**](.md) | | [optional]
9
+ **pulp_labels** | **Hash&lt;String, String&gt;** | | [optional]
10
10
  **name** | **String** | A unique name. Ex, &#x60;rawhide&#x60; and &#x60;stable&#x60;. |
11
11
  **repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional]
12
12
  **remote** | **String** | Remote that can be used to fetch content when using pull-through caching. | [optional]
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
9
9
  **base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \&quot;foo\&quot; and \&quot;foo/bar\&quot;) |
10
10
  **base_url** | **String** | The URL for accessing the publication as defined by this distribution. | [optional] [readonly]
11
11
  **content_guard** | **String** | An optional content-guard. | [optional]
12
- **pulp_labels** | [**Object**](.md) | | [optional]
12
+ **pulp_labels** | **Hash&lt;String, String&gt;** | | [optional]
13
13
  **name** | **String** | A unique name. Ex, &#x60;rawhide&#x60; and &#x60;stable&#x60;. |
14
14
  **repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional]
15
15
  **remote** | **String** | Remote that can be used to fetch content when using pull-through caching. | [optional]
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
15
15
  **proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional]
16
16
  **username** | **String** | The username to be used for authentication when syncing. | [optional]
17
17
  **password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional]
18
- **pulp_labels** | [**Object**](.md) | | [optional]
18
+ **pulp_labels** | **Hash&lt;String, String&gt;** | | [optional]
19
19
  **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional]
20
20
  **max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional]
21
21
  **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. | [optional]
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
12
12
  **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional]
13
13
  **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional]
14
14
  **proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional]
15
- **pulp_labels** | [**Object**](.md) | | [optional]
15
+ **pulp_labels** | **Hash&lt;String, String&gt;** | | [optional]
16
16
  **pulp_last_updated** | **DateTime** | Timestamp of the most recent update of the remote. | [optional] [readonly]
17
17
  **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional]
18
18
  **max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional]
@@ -23,6 +23,7 @@ Name | Type | Description | Notes
23
23
  **sock_read_timeout** | **Float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
24
24
  **headers** | **Array&lt;Object&gt;** | Headers for aiohttp.Clientsession | [optional]
25
25
  **rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional]
26
+ **hidden_fields** | [**Array&lt;MavenMavenRemoteResponseHiddenFields&gt;**](MavenMavenRemoteResponseHiddenFields.md) | List of hidden (write only) fields | [optional] [readonly]
26
27
 
27
28
  ## Code Sample
28
29
 
@@ -47,7 +48,8 @@ instance = PulpMavenClient::MavenMavenRemoteResponse.new(pulp_href: null,
47
48
  sock_connect_timeout: null,
48
49
  sock_read_timeout: null,
49
50
  headers: null,
50
- rate_limit: null)
51
+ rate_limit: null,
52
+ hidden_fields: null)
51
53
  ```
52
54
 
53
55
 
@@ -0,0 +1,19 @@
1
+ # PulpMavenClient::MavenMavenRemoteResponseHiddenFields
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **name** | **String** | | [optional]
8
+ **is_set** | **Boolean** | | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'PulpMavenClient'
14
+
15
+ instance = PulpMavenClient::MavenMavenRemoteResponseHiddenFields.new(name: null,
16
+ is_set: null)
17
+ ```
18
+
19
+
@@ -4,10 +4,10 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **pulp_labels** | [**Object**](.md) | | [optional]
7
+ **pulp_labels** | **Hash&lt;String, String&gt;** | | [optional]
8
8
  **name** | **String** | A unique name for this repository. |
9
9
  **description** | **String** | An optional description. | [optional]
10
- **retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. This is provided as a tech preview in Pulp 3 and may change in the future. | [optional]
10
+ **retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. | [optional]
11
11
  **remote** | **String** | An optional remote to use by default when syncing. | [optional]
12
12
 
13
13
  ## Code Sample
@@ -7,11 +7,11 @@ Name | Type | Description | Notes
7
7
  **pulp_href** | **String** | | [optional] [readonly]
8
8
  **pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
9
9
  **versions_href** | **String** | | [optional] [readonly]
10
- **pulp_labels** | [**Object**](.md) | | [optional]
10
+ **pulp_labels** | **Hash&lt;String, String&gt;** | | [optional]
11
11
  **latest_version_href** | **String** | | [optional] [readonly]
12
12
  **name** | **String** | A unique name for this repository. |
13
13
  **description** | **String** | An optional description. | [optional]
14
- **retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. This is provided as a tech preview in Pulp 3 and may change in the future. | [optional]
14
+ **retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. | [optional]
15
15
  **remote** | **String** | An optional remote to use by default when syncing. | [optional]
16
16
 
17
17
  ## Code Sample
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \&quot;foo\&quot; and \&quot;foo/bar\&quot;) | [optional]
8
8
  **content_guard** | **String** | An optional content-guard. | [optional]
9
- **pulp_labels** | [**Object**](.md) | | [optional]
9
+ **pulp_labels** | **Hash&lt;String, String&gt;** | | [optional]
10
10
  **name** | **String** | A unique name. Ex, &#x60;rawhide&#x60; and &#x60;stable&#x60;. | [optional]
11
11
  **repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional]
12
12
  **remote** | **String** | Remote that can be used to fetch content when using pull-through caching. | [optional]
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
15
15
  **proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional]
16
16
  **username** | **String** | The username to be used for authentication when syncing. | [optional]
17
17
  **password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional]
18
- **pulp_labels** | [**Object**](.md) | | [optional]
18
+ **pulp_labels** | **Hash&lt;String, String&gt;** | | [optional]
19
19
  **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional]
20
20
  **max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional]
21
21
  **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. | [optional]
@@ -4,10 +4,10 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **pulp_labels** | [**Object**](.md) | | [optional]
7
+ **pulp_labels** | **Hash&lt;String, String&gt;** | | [optional]
8
8
  **name** | **String** | A unique name for this repository. | [optional]
9
9
  **description** | **String** | An optional description. | [optional]
10
- **retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. This is provided as a tech preview in Pulp 3 and may change in the future. | [optional]
10
+ **retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. | [optional]
11
11
  **remote** | **String** | An optional remote to use by default when syncing. | [optional]
12
12
 
13
13
  ## Code Sample
@@ -0,0 +1,110 @@
1
+ # PulpMavenClient::PulpMavenApi
2
+
3
+ All URIs are relative to *https://pulp*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get**](PulpMavenApi.md#get) | **GET** /pulp/maven/{name}/{path} |
8
+ [**put**](PulpMavenApi.md#put) | **PUT** /pulp/maven/{name}/{path} |
9
+
10
+
11
+
12
+ ## get
13
+
14
+ > get(name, path, opts)
15
+
16
+
17
+
18
+ Responds to GET requests about manifests by reference
19
+
20
+ ### Example
21
+
22
+ ```ruby
23
+ # load the gem
24
+ require 'pulp_maven_client'
25
+
26
+ api_instance = PulpMavenClient::PulpMavenApi.new
27
+ name = 'name_example' # String |
28
+ path = 'path_example' # String |
29
+ opts = {
30
+ fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
31
+ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
32
+ }
33
+
34
+ begin
35
+ api_instance.get(name, path, opts)
36
+ rescue PulpMavenClient::ApiError => e
37
+ puts "Exception when calling PulpMavenApi->get: #{e}"
38
+ end
39
+ ```
40
+
41
+ ### Parameters
42
+
43
+
44
+ Name | Type | Description | Notes
45
+ ------------- | ------------- | ------------- | -------------
46
+ **name** | **String**| |
47
+ **path** | **String**| |
48
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
49
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
50
+
51
+ ### Return type
52
+
53
+ nil (empty response body)
54
+
55
+ ### Authorization
56
+
57
+ No authorization required
58
+
59
+ ### HTTP request headers
60
+
61
+ - **Content-Type**: Not defined
62
+ - **Accept**: Not defined
63
+
64
+
65
+ ## put
66
+
67
+ > put(name, path)
68
+
69
+
70
+
71
+ ViewSet for interacting with maven deploy API
72
+
73
+ ### Example
74
+
75
+ ```ruby
76
+ # load the gem
77
+ require 'pulp_maven_client'
78
+
79
+ api_instance = PulpMavenClient::PulpMavenApi.new
80
+ name = 'name_example' # String |
81
+ path = 'path_example' # String |
82
+
83
+ begin
84
+ api_instance.put(name, path)
85
+ rescue PulpMavenClient::ApiError => e
86
+ puts "Exception when calling PulpMavenApi->put: #{e}"
87
+ end
88
+ ```
89
+
90
+ ### Parameters
91
+
92
+
93
+ Name | Type | Description | Notes
94
+ ------------- | ------------- | ------------- | -------------
95
+ **name** | **String**| |
96
+ **path** | **String**| |
97
+
98
+ ### Return type
99
+
100
+ nil (empty response body)
101
+
102
+ ### Authorization
103
+
104
+ No authorization required
105
+
106
+ ### HTTP request headers
107
+
108
+ - **Content-Type**: Not defined
109
+ - **Accept**: Not defined
110
+
@@ -142,7 +142,7 @@ end
142
142
  api_instance = PulpMavenClient::RemotesMavenApi.new
143
143
  opts = {
144
144
  limit: 56, # Integer | Number of results to return per page.
145
- name: 'name_example', # String |
145
+ name: 'name_example', # String | Filter results where name matches value
146
146
  name__contains: 'name__contains_example', # String | Filter results where name contains value
147
147
  name__icontains: 'name__icontains_example', # String | Filter results where name contains value
148
148
  name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
@@ -150,14 +150,14 @@ opts = {
150
150
  offset: 56, # Integer | The initial index from which to return the results.
151
151
  ordering: ['ordering_example'], # Array<String> | Ordering
152
152
  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
153
- pulp_last_updated: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | ISO 8601 formatted dates are supported
153
+ pulp_last_updated: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated matches value
154
154
  pulp_last_updated__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is greater than value
155
155
  pulp_last_updated__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is greater than or equal to value
156
156
  pulp_last_updated__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is less than value
157
157
  pulp_last_updated__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is less than or equal to value
158
158
  pulp_last_updated__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array<DateTime> | Filter results where pulp_last_updated is between two comma separated values
159
- fields: 'fields_example', # String | A list of fields to include in the response.
160
- exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
159
+ fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
160
+ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
161
161
  }
162
162
 
163
163
  begin
@@ -175,7 +175,7 @@ end
175
175
  Name | Type | Description | Notes
176
176
  ------------- | ------------- | ------------- | -------------
177
177
  **limit** | **Integer**| Number of results to return per page. | [optional]
178
- **name** | **String**| | [optional]
178
+ **name** | **String**| Filter results where name matches value | [optional]
179
179
  **name__contains** | **String**| Filter results where name contains value | [optional]
180
180
  **name__icontains** | **String**| Filter results where name contains value | [optional]
181
181
  **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
@@ -183,14 +183,14 @@ Name | Type | Description | Notes
183
183
  **offset** | **Integer**| The initial index from which to return the results. | [optional]
184
184
  **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional]
185
185
  **pulp_label_select** | **String**| Filter labels by search string | [optional]
186
- **pulp_last_updated** | **DateTime**| ISO 8601 formatted dates are supported | [optional]
186
+ **pulp_last_updated** | **DateTime**| Filter results where pulp_last_updated matches value | [optional]
187
187
  **pulp_last_updated__gt** | **DateTime**| Filter results where pulp_last_updated is greater than value | [optional]
188
188
  **pulp_last_updated__gte** | **DateTime**| Filter results where pulp_last_updated is greater than or equal to value | [optional]
189
189
  **pulp_last_updated__lt** | **DateTime**| Filter results where pulp_last_updated is less than value | [optional]
190
190
  **pulp_last_updated__lte** | **DateTime**| Filter results where pulp_last_updated is less than or equal to value | [optional]
191
191
  **pulp_last_updated__range** | [**Array&lt;DateTime&gt;**](DateTime.md)| Filter results where pulp_last_updated is between two comma separated values | [optional]
192
- **fields** | **String**| A list of fields to include in the response. | [optional]
193
- **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
192
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
193
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
194
194
 
195
195
  ### Return type
196
196
 
@@ -284,8 +284,8 @@ end
284
284
  api_instance = PulpMavenClient::RemotesMavenApi.new
285
285
  maven_maven_remote_href = 'maven_maven_remote_href_example' # String |
286
286
  opts = {
287
- fields: 'fields_example', # String | A list of fields to include in the response.
288
- exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
287
+ fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
288
+ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
289
289
  }
290
290
 
291
291
  begin
@@ -303,8 +303,8 @@ end
303
303
  Name | Type | Description | Notes
304
304
  ------------- | ------------- | ------------- | -------------
305
305
  **maven_maven_remote_href** | **String**| |
306
- **fields** | **String**| A list of fields to include in the response. | [optional]
307
- **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
306
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
307
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
308
308
 
309
309
  ### Return type
310
310
 
@@ -142,7 +142,7 @@ end
142
142
  api_instance = PulpMavenClient::RepositoriesMavenApi.new
143
143
  opts = {
144
144
  limit: 56, # Integer | Number of results to return per page.
145
- name: 'name_example', # String |
145
+ name: 'name_example', # String | Filter results where name matches value
146
146
  name__contains: 'name__contains_example', # String | Filter results where name contains value
147
147
  name__icontains: 'name__icontains_example', # String | Filter results where name contains value
148
148
  name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
@@ -150,8 +150,17 @@ opts = {
150
150
  offset: 56, # Integer | The initial index from which to return the results.
151
151
  ordering: ['ordering_example'], # Array<String> | Ordering
152
152
  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
153
- fields: 'fields_example', # String | A list of fields to include in the response.
154
- exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
153
+ remote: 'remote_example', # String | Foreign Key referenced by HREF
154
+ retain_repo_versions: 56, # Integer | Filter results where retain_repo_versions matches value
155
+ retain_repo_versions__gt: 56, # Integer | Filter results where retain_repo_versions is greater than value
156
+ retain_repo_versions__gte: 56, # Integer | Filter results where retain_repo_versions is greater than or equal to value
157
+ retain_repo_versions__isnull: true, # Boolean | Filter results where retain_repo_versions has a null value
158
+ retain_repo_versions__lt: 56, # Integer | Filter results where retain_repo_versions is less than value
159
+ retain_repo_versions__lte: 56, # Integer | Filter results where retain_repo_versions is less than or equal to value
160
+ retain_repo_versions__ne: 56, # Integer | Filter results where retain_repo_versions not equal to value
161
+ retain_repo_versions__range: [56], # Array<Integer> | Filter results where retain_repo_versions is between two comma separated values
162
+ fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
163
+ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
155
164
  }
156
165
 
157
166
  begin
@@ -169,7 +178,7 @@ end
169
178
  Name | Type | Description | Notes
170
179
  ------------- | ------------- | ------------- | -------------
171
180
  **limit** | **Integer**| Number of results to return per page. | [optional]
172
- **name** | **String**| | [optional]
181
+ **name** | **String**| Filter results where name matches value | [optional]
173
182
  **name__contains** | **String**| Filter results where name contains value | [optional]
174
183
  **name__icontains** | **String**| Filter results where name contains value | [optional]
175
184
  **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
@@ -177,8 +186,17 @@ Name | Type | Description | Notes
177
186
  **offset** | **Integer**| The initial index from which to return the results. | [optional]
178
187
  **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional]
179
188
  **pulp_label_select** | **String**| Filter labels by search string | [optional]
180
- **fields** | **String**| A list of fields to include in the response. | [optional]
181
- **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
189
+ **remote** | **String**| Foreign Key referenced by HREF | [optional]
190
+ **retain_repo_versions** | **Integer**| Filter results where retain_repo_versions matches value | [optional]
191
+ **retain_repo_versions__gt** | **Integer**| Filter results where retain_repo_versions is greater than value | [optional]
192
+ **retain_repo_versions__gte** | **Integer**| Filter results where retain_repo_versions is greater than or equal to value | [optional]
193
+ **retain_repo_versions__isnull** | **Boolean**| Filter results where retain_repo_versions has a null value | [optional]
194
+ **retain_repo_versions__lt** | **Integer**| Filter results where retain_repo_versions is less than value | [optional]
195
+ **retain_repo_versions__lte** | **Integer**| Filter results where retain_repo_versions is less than or equal to value | [optional]
196
+ **retain_repo_versions__ne** | **Integer**| Filter results where retain_repo_versions not equal to value | [optional]
197
+ **retain_repo_versions__range** | [**Array&lt;Integer&gt;**](Integer.md)| Filter results where retain_repo_versions is between two comma separated values | [optional]
198
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
199
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
182
200
 
183
201
  ### Return type
184
202
 
@@ -272,8 +290,8 @@ end
272
290
  api_instance = PulpMavenClient::RepositoriesMavenApi.new
273
291
  maven_maven_repository_href = 'maven_maven_repository_href_example' # String |
274
292
  opts = {
275
- fields: 'fields_example', # String | A list of fields to include in the response.
276
- exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
293
+ fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
294
+ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
277
295
  }
278
296
 
279
297
  begin
@@ -291,8 +309,8 @@ end
291
309
  Name | Type | Description | Notes
292
310
  ------------- | ------------- | ------------- | -------------
293
311
  **maven_maven_repository_href** | **String**| |
294
- **fields** | **String**| A list of fields to include in the response. | [optional]
295
- **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
312
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
313
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
296
314
 
297
315
  ### Return type
298
316