pulp_npm_client 0.5.0 → 0.6.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 (37) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +13 -9
  3. data/docs/ContentPackagesApi.md +115 -22
  4. data/docs/DistributionsNpmApi.md +4 -4
  5. data/docs/NpmNpmRemote.md +6 -6
  6. data/docs/NpmNpmRemoteResponse.md +9 -9
  7. data/docs/NpmPackageResponse.md +3 -3
  8. data/docs/PatchednpmNpmRemote.md +6 -6
  9. data/docs/RemoteNetworkConfig.md +50 -0
  10. data/docs/RemoteNetworkConfigResponse.md +40 -0
  11. data/docs/RemotesNpmApi.md +3 -3
  12. data/docs/RepositoriesNpmApi.md +5 -5
  13. data/lib/pulp_npm_client/api/content_packages_api.rb +146 -47
  14. data/lib/pulp_npm_client/api/distributions_npm_api.rb +4 -4
  15. data/lib/pulp_npm_client/api/remotes_npm_api.rb +6 -6
  16. data/lib/pulp_npm_client/api/repositories_npm_api.rb +8 -8
  17. data/lib/pulp_npm_client/models/npm_npm_remote.rb +34 -34
  18. data/lib/pulp_npm_client/models/npm_npm_remote_response.rb +50 -50
  19. data/lib/pulp_npm_client/models/npm_npm_repository.rb +1 -1
  20. data/lib/pulp_npm_client/models/npm_npm_repository_response.rb +1 -1
  21. data/lib/pulp_npm_client/models/npm_package_response.rb +4 -22
  22. data/lib/pulp_npm_client/models/patchednpm_npm_remote.rb +34 -34
  23. data/lib/pulp_npm_client/models/patchednpm_npm_repository.rb +1 -1
  24. data/lib/pulp_npm_client/models/remote_network_config.rb +573 -0
  25. data/lib/pulp_npm_client/models/remote_network_config_response.rb +398 -0
  26. data/lib/pulp_npm_client/version.rb +1 -1
  27. data/lib/pulp_npm_client.rb +2 -0
  28. data/spec/api/content_packages_api_spec.rb +32 -10
  29. data/spec/api/distributions_npm_api_spec.rb +2 -2
  30. data/spec/api/remotes_npm_api_spec.rb +3 -3
  31. data/spec/api/repositories_npm_api_spec.rb +4 -4
  32. data/spec/models/npm_npm_remote_response_spec.rb +10 -10
  33. data/spec/models/npm_npm_remote_spec.rb +17 -17
  34. data/spec/models/patchednpm_npm_remote_spec.rb +17 -17
  35. data/spec/models/remote_network_config_response_spec.rb +102 -0
  36. data/spec/models/remote_network_config_spec.rb +132 -0
  37. metadata +30 -22
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3d73e447b030cd0f001d703f993c437559bf98b5e6bc025b369eea87fc81fd9c
4
- data.tar.gz: 24d258585c56fb67b13aa1045952bc97a3f19e8aed7aad87e14b345931eb79c7
3
+ metadata.gz: 2c5985530564d0e4feb61307fecf9fe50b62013f65556ddd5dff53f28053aaf6
4
+ data.tar.gz: 7e662c5601b1833130166e262d3d95a6528fb08e6e29157055ea4f859c07af3d
5
5
  SHA512:
6
- metadata.gz: 34f1c22748ff0f3f3953e4d7b4b3c821d173ab994d795f1512f63e31b6a79635a546563da7533a82141e8f79075f519adc433dcbad12cc9fa79dadee08abf72f
7
- data.tar.gz: c3a2819eafdb66bc8eefbb199cfe09dd43c4e7964774c7dc1491f743f6bbb5db66c37adea402a9e31b4a552c43243a90d38615fcde99b7d6225731e0b2d5e1bf
6
+ metadata.gz: aac2c17c1fdc990adf7fb4046e2ebdb17f62f410676b341dbfbd00e0441359650c473e22f4239532d97c71b8ccf0302a12832cab33b6206cffc3ee3d054d2a2c
7
+ data.tar.gz: ece3308da6d95ce20752a5dd60d5d0f91dd93f8040a15b7e35fd72f73d7cdcd297ec39115dbc438bf2da579febf07da0501709f0df06a327d3d98a91ad5a1ff0
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.5.0
10
+ - Package version: 0.6.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_npm_client.gemspec
25
25
  Then either install the gem locally:
26
26
 
27
27
  ```shell
28
- gem install ./pulp_npm_client-0.5.0.gem
28
+ gem install ./pulp_npm_client-0.6.0.gem
29
29
  ```
30
30
 
31
- (for development, run `gem install --dev ./pulp_npm_client-0.5.0.gem` to install the development dependencies)
31
+ (for development, run `gem install --dev ./pulp_npm_client-0.6.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_npm_client', '~> 0.5.0'
37
+ gem 'pulp_npm_client', '~> 0.6.0'
38
38
 
39
39
  ### Install from Git
40
40
 
@@ -68,22 +68,23 @@ PulpNpmClient.configure do |config|
68
68
  end
69
69
 
70
70
  api_instance = PulpNpmClient::ContentPackagesApi.new
71
- relative_path = 'relative_path_example' # String |
72
- name = 'name_example' # String |
73
- version = 'version_example' # String |
74
71
  opts = {
75
72
  x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
76
73
  repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
77
74
  pulp_labels: { key: 'inner_example'}, # Hash<String, String> | A dictionary of arbitrary key/value pairs used to describe a specific Content instance.
78
75
  artifact: 'artifact_example', # String | Artifact file representing the physical content
76
+ relative_path: 'relative_path_example', # String | Path where the artifact is located relative to distributions base_path. If not provided, it will be computed from name and version.
79
77
  file: File.new('/path/to/some/file'), # File | An uploaded file that may be turned into the content unit.
80
78
  upload: 'upload_example', # String | An uncommitted upload that may be turned into the content unit.
81
- file_url: 'file_url_example' # String | A url that Pulp can download and turn into the content unit.
79
+ file_url: 'file_url_example', # String | A url that Pulp can download and turn into the content unit.
80
+ downloader_config: PulpNpmClient::RemoteNetworkConfig.new, # RemoteNetworkConfig | Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a 'file_url.
81
+ name: 'name_example', # String | The name of the npm package.
82
+ version: 'version_example' # String | The version of the npm package.
82
83
  }
83
84
 
84
85
  begin
85
86
  #Create a package
86
- result = api_instance.create(relative_path, name, version, opts)
87
+ result = api_instance.create(opts)
87
88
  p result
88
89
  rescue PulpNpmClient::ApiError => e
89
90
  puts "Exception when calling ContentPackagesApi->create: #{e}"
@@ -102,6 +103,7 @@ Class | Method | HTTP request | Description
102
103
  *PulpNpmClient::ContentPackagesApi* | [**read**](docs/ContentPackagesApi.md#read) | **GET** {npm_package_href} | Inspect a package
103
104
  *PulpNpmClient::ContentPackagesApi* | [**set_label**](docs/ContentPackagesApi.md#set_label) | **POST** {npm_package_href}set_label/ | Set a label
104
105
  *PulpNpmClient::ContentPackagesApi* | [**unset_label**](docs/ContentPackagesApi.md#unset_label) | **POST** {npm_package_href}unset_label/ | Unset a label
106
+ *PulpNpmClient::ContentPackagesApi* | [**upload**](docs/ContentPackagesApi.md#upload) | **POST** /pulp/api/v3/content/npm/packages/upload/ | Synchronous npm package upload
105
107
  *PulpNpmClient::DistributionsNpmApi* | [**create**](docs/DistributionsNpmApi.md#create) | **POST** /pulp/api/v3/distributions/npm/npm/ | Create a npm distribution
106
108
  *PulpNpmClient::DistributionsNpmApi* | [**delete**](docs/DistributionsNpmApi.md#delete) | **DELETE** {npm_npm_distribution_href} | Delete a npm distribution
107
109
  *PulpNpmClient::DistributionsNpmApi* | [**list**](docs/DistributionsNpmApi.md#list) | **GET** /pulp/api/v3/distributions/npm/npm/ | List npm distributions
@@ -155,6 +157,8 @@ Class | Method | HTTP request | Description
155
157
  - [PulpNpmClient::PatchednpmNpmRemote](docs/PatchednpmNpmRemote.md)
156
158
  - [PulpNpmClient::PatchednpmNpmRepository](docs/PatchednpmNpmRepository.md)
157
159
  - [PulpNpmClient::PolicyEnum](docs/PolicyEnum.md)
160
+ - [PulpNpmClient::RemoteNetworkConfig](docs/RemoteNetworkConfig.md)
161
+ - [PulpNpmClient::RemoteNetworkConfigResponse](docs/RemoteNetworkConfigResponse.md)
158
162
  - [PulpNpmClient::Repair](docs/Repair.md)
159
163
  - [PulpNpmClient::RepositoryAddRemoveContent](docs/RepositoryAddRemoveContent.md)
160
164
  - [PulpNpmClient::RepositorySyncURL](docs/RepositorySyncURL.md)
@@ -9,15 +9,16 @@ All URIs are relative to *http://localhost:24817*
9
9
  | [**read**](ContentPackagesApi.md#read) | **GET** {npm_package_href} | Inspect a package |
10
10
  | [**set_label**](ContentPackagesApi.md#set_label) | **POST** {npm_package_href}set_label/ | Set a label |
11
11
  | [**unset_label**](ContentPackagesApi.md#unset_label) | **POST** {npm_package_href}unset_label/ | Unset a label |
12
+ | [**upload**](ContentPackagesApi.md#upload) | **POST** /pulp/api/v3/content/npm/packages/upload/ | Synchronous npm package upload |
12
13
 
13
14
 
14
15
  ## create
15
16
 
16
- > <NpmPackageResponse> create(relative_path, name, version, opts)
17
+ > <AsyncOperationResponse> create(opts)
17
18
 
18
19
  Create a package
19
20
 
20
- Perform bookkeeping when saving Content. \"Artifacts\" need to be popped off and saved independently, as they are not actually part of the Content model.
21
+ Trigger an asynchronous task to create content,optionally create new repository version.
21
22
 
22
23
  ### Examples
23
24
 
@@ -32,22 +33,23 @@ PulpNpmClient.configure do |config|
32
33
  end
33
34
 
34
35
  api_instance = PulpNpmClient::ContentPackagesApi.new
35
- relative_path = 'relative_path_example' # String |
36
- name = 'name_example' # String |
37
- version = 'version_example' # String |
38
36
  opts = {
39
37
  x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
40
38
  repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
41
39
  pulp_labels: { key: 'inner_example'}, # Hash<String, String> | A dictionary of arbitrary key/value pairs used to describe a specific Content instance.
42
40
  artifact: 'artifact_example', # String | Artifact file representing the physical content
41
+ relative_path: 'relative_path_example', # String | Path where the artifact is located relative to distributions base_path. If not provided, it will be computed from name and version.
43
42
  file: File.new('/path/to/some/file'), # File | An uploaded file that may be turned into the content unit.
44
43
  upload: 'upload_example', # String | An uncommitted upload that may be turned into the content unit.
45
- file_url: 'file_url_example' # String | A url that Pulp can download and turn into the content unit.
44
+ file_url: 'file_url_example', # String | A url that Pulp can download and turn into the content unit.
45
+ downloader_config: PulpNpmClient::RemoteNetworkConfig.new, # RemoteNetworkConfig | Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a 'file_url.
46
+ name: 'name_example', # String | The name of the npm package.
47
+ version: 'version_example' # String | The version of the npm package.
46
48
  }
47
49
 
48
50
  begin
49
51
  # Create a package
50
- result = api_instance.create(relative_path, name, version, opts)
52
+ result = api_instance.create(opts)
51
53
  p result
52
54
  rescue PulpNpmClient::ApiError => e
53
55
  puts "Error when calling ContentPackagesApi->create: #{e}"
@@ -58,15 +60,15 @@ end
58
60
 
59
61
  This returns an Array which contains the response data, status code and headers.
60
62
 
61
- > <Array(<NpmPackageResponse>, Integer, Hash)> create_with_http_info(relative_path, name, version, opts)
63
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> create_with_http_info(opts)
62
64
 
63
65
  ```ruby
64
66
  begin
65
67
  # Create a package
66
- data, status_code, headers = api_instance.create_with_http_info(relative_path, name, version, opts)
68
+ data, status_code, headers = api_instance.create_with_http_info(opts)
67
69
  p status_code # => 2xx
68
70
  p headers # => { ... }
69
- p data # => <NpmPackageResponse>
71
+ p data # => <AsyncOperationResponse>
70
72
  rescue PulpNpmClient::ApiError => e
71
73
  puts "Error when calling ContentPackagesApi->create_with_http_info: #{e}"
72
74
  end
@@ -76,20 +78,21 @@ end
76
78
 
77
79
  | Name | Type | Description | Notes |
78
80
  | ---- | ---- | ----------- | ----- |
79
- | **relative_path** | **String** | | |
80
- | **name** | **String** | | |
81
- | **version** | **String** | | |
82
81
  | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
83
82
  | **repository** | **String** | A URI of a repository the new content unit should be associated with. | [optional] |
84
83
  | **pulp_labels** | [**Hash&lt;String, String&gt;**](Hash.md) | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. | [optional] |
85
84
  | **artifact** | **String** | Artifact file representing the physical content | [optional] |
85
+ | **relative_path** | **String** | Path where the artifact is located relative to distributions base_path. If not provided, it will be computed from name and version. | [optional] |
86
86
  | **file** | **File** | An uploaded file that may be turned into the content unit. | [optional] |
87
87
  | **upload** | **String** | An uncommitted upload that may be turned into the content unit. | [optional] |
88
88
  | **file_url** | **String** | A url that Pulp can download and turn into the content unit. | [optional] |
89
+ | **downloader_config** | [**RemoteNetworkConfig**](RemoteNetworkConfig.md) | Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a &#39;file_url. | [optional] |
90
+ | **name** | **String** | The name of the npm package. | [optional] |
91
+ | **version** | **String** | The version of the npm package. | [optional] |
89
92
 
90
93
  ### Return type
91
94
 
92
- [**NpmPackageResponse**](NpmPackageResponse.md)
95
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
93
96
 
94
97
  ### Authorization
95
98
 
@@ -107,7 +110,7 @@ end
107
110
 
108
111
  List packages
109
112
 
110
- A ViewSet for Package. Define endpoint name which will appear in the API endpoint for this content type. For example:: http://pulp.example.com/pulp/api/v3/content/npm/units/ Also specify queryset and serializer for Package.
113
+ A ViewSet for NpmPackage. Define endpoint name which will appear in the API endpoint for this content type. For example:: http://pulp.example.com/pulp/api/v3/content/npm/packages/ Also specify queryset and serializer for NpmPackage.
111
114
 
112
115
  ### Examples
113
116
 
@@ -135,9 +138,9 @@ opts = {
135
138
  pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
136
139
  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
137
140
  q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
138
- repository_version: 'repository_version_example', # String | Repository Version referenced by HREF/PRN
139
- repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF/PRN
140
- repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF/PRN
141
+ repository_version: 'repository_version_example', # String |
142
+ repository_version_added: 'repository_version_added_example', # String |
143
+ repository_version_removed: 'repository_version_removed_example', # String |
141
144
  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
142
145
  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
143
146
  }
@@ -185,9 +188,9 @@ end
185
188
  | **pulp_id__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
186
189
  | **pulp_label_select** | **String** | Filter labels by search string | [optional] |
187
190
  | **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
188
- | **repository_version** | **String** | Repository Version referenced by HREF/PRN | [optional] |
189
- | **repository_version_added** | **String** | Repository Version referenced by HREF/PRN | [optional] |
190
- | **repository_version_removed** | **String** | Repository Version referenced by HREF/PRN | [optional] |
191
+ | **repository_version** | **String** | | [optional] |
192
+ | **repository_version_added** | **String** | | [optional] |
193
+ | **repository_version_removed** | **String** | | [optional] |
191
194
  | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
192
195
  | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
193
196
 
@@ -211,7 +214,7 @@ end
211
214
 
212
215
  Inspect a package
213
216
 
214
- A ViewSet for Package. Define endpoint name which will appear in the API endpoint for this content type. For example:: http://pulp.example.com/pulp/api/v3/content/npm/units/ Also specify queryset and serializer for Package.
217
+ A ViewSet for NpmPackage. Define endpoint name which will appear in the API endpoint for this content type. For example:: http://pulp.example.com/pulp/api/v3/content/npm/packages/ Also specify queryset and serializer for NpmPackage.
215
218
 
216
219
  ### Examples
217
220
 
@@ -434,3 +437,93 @@ end
434
437
  - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
435
438
  - **Accept**: application/json
436
439
 
440
+
441
+ ## upload
442
+
443
+ > <NpmPackageResponse> upload(opts)
444
+
445
+ Synchronous npm package upload
446
+
447
+ Create an npm package content unit synchronously.
448
+
449
+ ### Examples
450
+
451
+ ```ruby
452
+ require 'time'
453
+ require 'pulp_npm_client'
454
+ # setup authorization
455
+ PulpNpmClient.configure do |config|
456
+ # Configure HTTP basic authorization: basicAuth
457
+ config.username = 'YOUR USERNAME'
458
+ config.password = 'YOUR PASSWORD'
459
+ end
460
+
461
+ api_instance = PulpNpmClient::ContentPackagesApi.new
462
+ opts = {
463
+ x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
464
+ pulp_labels: { key: 'inner_example'}, # Hash<String, String> | A dictionary of arbitrary key/value pairs used to describe a specific Content instance.
465
+ artifact: 'artifact_example', # String | Artifact file representing the physical content
466
+ relative_path: 'relative_path_example', # String | Path where the artifact is located relative to distributions base_path. If not provided, it will be computed from name and version.
467
+ file: File.new('/path/to/some/file'), # File | An uploaded file that may be turned into the content unit.
468
+ upload: 'upload_example', # String | An uncommitted upload that may be turned into the content unit.
469
+ file_url: 'file_url_example', # String | A url that Pulp can download and turn into the content unit.
470
+ downloader_config: PulpNpmClient::RemoteNetworkConfig.new, # RemoteNetworkConfig | Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a 'file_url.
471
+ name: 'name_example', # String | The name of the npm package.
472
+ version: 'version_example' # String | The version of the npm package.
473
+ }
474
+
475
+ begin
476
+ # Synchronous npm package upload
477
+ result = api_instance.upload(opts)
478
+ p result
479
+ rescue PulpNpmClient::ApiError => e
480
+ puts "Error when calling ContentPackagesApi->upload: #{e}"
481
+ end
482
+ ```
483
+
484
+ #### Using the upload_with_http_info variant
485
+
486
+ This returns an Array which contains the response data, status code and headers.
487
+
488
+ > <Array(<NpmPackageResponse>, Integer, Hash)> upload_with_http_info(opts)
489
+
490
+ ```ruby
491
+ begin
492
+ # Synchronous npm package upload
493
+ data, status_code, headers = api_instance.upload_with_http_info(opts)
494
+ p status_code # => 2xx
495
+ p headers # => { ... }
496
+ p data # => <NpmPackageResponse>
497
+ rescue PulpNpmClient::ApiError => e
498
+ puts "Error when calling ContentPackagesApi->upload_with_http_info: #{e}"
499
+ end
500
+ ```
501
+
502
+ ### Parameters
503
+
504
+ | Name | Type | Description | Notes |
505
+ | ---- | ---- | ----------- | ----- |
506
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
507
+ | **pulp_labels** | [**Hash&lt;String, String&gt;**](Hash.md) | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. | [optional] |
508
+ | **artifact** | **String** | Artifact file representing the physical content | [optional] |
509
+ | **relative_path** | **String** | Path where the artifact is located relative to distributions base_path. If not provided, it will be computed from name and version. | [optional] |
510
+ | **file** | **File** | An uploaded file that may be turned into the content unit. | [optional] |
511
+ | **upload** | **String** | An uncommitted upload that may be turned into the content unit. | [optional] |
512
+ | **file_url** | **String** | A url that Pulp can download and turn into the content unit. | [optional] |
513
+ | **downloader_config** | [**RemoteNetworkConfig**](RemoteNetworkConfig.md) | Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a &#39;file_url. | [optional] |
514
+ | **name** | **String** | The name of the npm package. | [optional] |
515
+ | **version** | **String** | The version of the npm package. | [optional] |
516
+
517
+ ### Return type
518
+
519
+ [**NpmPackageResponse**](NpmPackageResponse.md)
520
+
521
+ ### Authorization
522
+
523
+ [basicAuth](../README.md#basicAuth)
524
+
525
+ ### HTTP request headers
526
+
527
+ - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
528
+ - **Accept**: application/json
529
+
@@ -207,8 +207,8 @@ opts = {
207
207
  pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
208
208
  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
209
209
  q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
210
- repository: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Filter results where repository matches value
211
- repository__in: ['inner_example'], # Array<String> | Filter results where repository is in a comma-separated list of values
210
+ repository: 'repository_example', # String |
211
+ repository__in: ['inner_example'], # Array<String> |
212
212
  with_content: 'with_content_example', # String | Filter distributions based on the content served by them
213
213
  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
214
214
  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
@@ -268,8 +268,8 @@ end
268
268
  | **pulp_id__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
269
269
  | **pulp_label_select** | **String** | Filter labels by search string | [optional] |
270
270
  | **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
271
- | **repository** | **String** | Filter results where repository matches value | [optional] |
272
- | **repository__in** | [**Array&lt;String&gt;**](String.md) | Filter results where repository is in a comma-separated list of values | [optional] |
271
+ | **repository** | **String** | | [optional] |
272
+ | **repository__in** | [**Array&lt;String&gt;**](String.md) | | [optional] |
273
273
  | **with_content** | **String** | Filter distributions based on the content served by them | [optional] |
274
274
  | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
275
275
  | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
data/docs/NpmNpmRemote.md CHANGED
@@ -6,6 +6,8 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **name** | **String** | A unique name for this remote. | |
8
8
  | **url** | **String** | The URL of an external content source. | |
9
+ | **pulp_labels** | **Hash&lt;String, String&gt;** | | [optional] |
10
+ | **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: &#39;immediate&#39;, &#39;on_demand&#39;, and &#39;streamed&#39;. &#39;immediate&#39; is the default. * &#x60;immediate&#x60; - When syncing, download all metadata and content now. * &#x60;on_demand&#x60; - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * &#x60;streamed&#x60; - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional] |
9
11
  | **ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] |
10
12
  | **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional] |
11
13
  | **client_key** | **String** | A PEM encoded private key used for authentication. | [optional] |
@@ -15,15 +17,13 @@
15
17
  | **proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional] |
16
18
  | **username** | **String** | The username to be used for authentication when syncing. | [optional] |
17
19
  | **password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional] |
18
- | **pulp_labels** | **Hash&lt;String, String&gt;** | | [optional] |
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
- | **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: &#39;immediate&#39;, &#39;on_demand&#39;, and &#39;streamed&#39;. &#39;immediate&#39; is the default. * &#x60;immediate&#x60; - When syncing, download all metadata and content now. * &#x60;on_demand&#x60; - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * &#x60;streamed&#x60; - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional] |
22
21
  | **total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
23
22
  | **connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
24
23
  | **sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
25
24
  | **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] |
26
25
  | **headers** | **Array&lt;Object&gt;** | Headers for aiohttp.Clientsession | [optional] |
26
+ | **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] |
27
27
  | **rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] |
28
28
 
29
29
  ## Example
@@ -34,6 +34,8 @@ require 'pulp_npm_client'
34
34
  instance = PulpNpmClient::NpmNpmRemote.new(
35
35
  name: null,
36
36
  url: null,
37
+ pulp_labels: null,
38
+ policy: null,
37
39
  ca_cert: null,
38
40
  client_cert: null,
39
41
  client_key: null,
@@ -43,15 +45,13 @@ instance = PulpNpmClient::NpmNpmRemote.new(
43
45
  proxy_password: null,
44
46
  username: null,
45
47
  password: null,
46
- pulp_labels: null,
47
- download_concurrency: null,
48
48
  max_retries: null,
49
- policy: null,
50
49
  total_timeout: null,
51
50
  connect_timeout: null,
52
51
  sock_connect_timeout: null,
53
52
  sock_read_timeout: null,
54
53
  headers: null,
54
+ download_concurrency: null,
55
55
  rate_limit: null
56
56
  )
57
57
  ```
@@ -10,21 +10,21 @@
10
10
  | **pulp_last_updated** | **Time** | Timestamp of the most recent update of the remote. | [optional][readonly] |
11
11
  | **name** | **String** | A unique name for this remote. | |
12
12
  | **url** | **String** | The URL of an external content source. | |
13
+ | **pulp_labels** | **Hash&lt;String, String&gt;** | | [optional] |
14
+ | **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: &#39;immediate&#39;, &#39;on_demand&#39;, and &#39;streamed&#39;. &#39;immediate&#39; is the default. * &#x60;immediate&#x60; - When syncing, download all metadata and content now. * &#x60;on_demand&#x60; - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * &#x60;streamed&#x60; - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional] |
15
+ | **hidden_fields** | [**Array&lt;NpmNpmRemoteResponseHiddenFieldsInner&gt;**](NpmNpmRemoteResponseHiddenFieldsInner.md) | List of hidden (write only) fields | [optional] |
13
16
  | **ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] |
14
17
  | **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional] |
15
18
  | **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] |
16
19
  | **proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional] |
17
- | **pulp_labels** | **Hash&lt;String, String&gt;** | | [optional] |
18
- | **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] |
19
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] |
20
- | **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: &#39;immediate&#39;, &#39;on_demand&#39;, and &#39;streamed&#39;. &#39;immediate&#39; is the default. * &#x60;immediate&#x60; - When syncing, download all metadata and content now. * &#x60;on_demand&#x60; - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * &#x60;streamed&#x60; - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional] |
21
21
  | **total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
22
22
  | **connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
23
23
  | **sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
24
24
  | **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] |
25
25
  | **headers** | **Array&lt;Object&gt;** | Headers for aiohttp.Clientsession | [optional] |
26
+ | **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] |
26
27
  | **rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] |
27
- | **hidden_fields** | [**Array&lt;NpmNpmRemoteResponseHiddenFieldsInner&gt;**](NpmNpmRemoteResponseHiddenFieldsInner.md) | List of hidden (write only) fields | [optional] |
28
28
 
29
29
  ## Example
30
30
 
@@ -38,21 +38,21 @@ instance = PulpNpmClient::NpmNpmRemoteResponse.new(
38
38
  pulp_last_updated: null,
39
39
  name: null,
40
40
  url: null,
41
+ pulp_labels: null,
42
+ policy: null,
43
+ hidden_fields: null,
41
44
  ca_cert: null,
42
45
  client_cert: null,
43
46
  tls_validation: null,
44
47
  proxy_url: null,
45
- pulp_labels: null,
46
- download_concurrency: null,
47
48
  max_retries: null,
48
- policy: null,
49
49
  total_timeout: null,
50
50
  connect_timeout: null,
51
51
  sock_connect_timeout: null,
52
52
  sock_read_timeout: null,
53
53
  headers: null,
54
- rate_limit: null,
55
- hidden_fields: null
54
+ download_concurrency: null,
55
+ rate_limit: null
56
56
  )
57
57
  ```
58
58
 
@@ -11,9 +11,9 @@
11
11
  | **pulp_labels** | **Hash&lt;String, String&gt;** | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. | [optional] |
12
12
  | **vuln_report** | **String** | | [optional][readonly] |
13
13
  | **artifact** | **String** | Artifact file representing the physical content | [optional] |
14
- | **relative_path** | **String** | | |
15
- | **name** | **String** | | |
16
- | **version** | **String** | | |
14
+ | **relative_path** | **String** | Path where the artifact is located relative to distributions base_path. If not provided, it will be computed from name and version. | [optional] |
15
+ | **name** | **String** | The name of the npm package. | [optional] |
16
+ | **version** | **String** | The version of the npm package. | [optional] |
17
17
 
18
18
  ## Example
19
19
 
@@ -6,6 +6,8 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **name** | **String** | A unique name for this remote. | [optional] |
8
8
  | **url** | **String** | The URL of an external content source. | [optional] |
9
+ | **pulp_labels** | **Hash&lt;String, String&gt;** | | [optional] |
10
+ | **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: &#39;immediate&#39;, &#39;on_demand&#39;, and &#39;streamed&#39;. &#39;immediate&#39; is the default. * &#x60;immediate&#x60; - When syncing, download all metadata and content now. * &#x60;on_demand&#x60; - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * &#x60;streamed&#x60; - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional] |
9
11
  | **ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] |
10
12
  | **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional] |
11
13
  | **client_key** | **String** | A PEM encoded private key used for authentication. | [optional] |
@@ -15,15 +17,13 @@
15
17
  | **proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional] |
16
18
  | **username** | **String** | The username to be used for authentication when syncing. | [optional] |
17
19
  | **password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional] |
18
- | **pulp_labels** | **Hash&lt;String, String&gt;** | | [optional] |
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
- | **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: &#39;immediate&#39;, &#39;on_demand&#39;, and &#39;streamed&#39;. &#39;immediate&#39; is the default. * &#x60;immediate&#x60; - When syncing, download all metadata and content now. * &#x60;on_demand&#x60; - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * &#x60;streamed&#x60; - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional] |
22
21
  | **total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
23
22
  | **connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
24
23
  | **sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
25
24
  | **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] |
26
25
  | **headers** | **Array&lt;Object&gt;** | Headers for aiohttp.Clientsession | [optional] |
26
+ | **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] |
27
27
  | **rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] |
28
28
 
29
29
  ## Example
@@ -34,6 +34,8 @@ require 'pulp_npm_client'
34
34
  instance = PulpNpmClient::PatchednpmNpmRemote.new(
35
35
  name: null,
36
36
  url: null,
37
+ pulp_labels: null,
38
+ policy: null,
37
39
  ca_cert: null,
38
40
  client_cert: null,
39
41
  client_key: null,
@@ -43,15 +45,13 @@ instance = PulpNpmClient::PatchednpmNpmRemote.new(
43
45
  proxy_password: null,
44
46
  username: null,
45
47
  password: null,
46
- pulp_labels: null,
47
- download_concurrency: null,
48
48
  max_retries: null,
49
- policy: null,
50
49
  total_timeout: null,
51
50
  connect_timeout: null,
52
51
  sock_connect_timeout: null,
53
52
  sock_read_timeout: null,
54
53
  headers: null,
54
+ download_concurrency: null,
55
55
  rate_limit: null
56
56
  )
57
57
  ```
@@ -0,0 +1,50 @@
1
+ # PulpNpmClient::RemoteNetworkConfig
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] |
8
+ | **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional] |
9
+ | **client_key** | **String** | A PEM encoded private key used for authentication. | [optional] |
10
+ | **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] |
11
+ | **proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional] |
12
+ | **proxy_username** | **String** | The username to authenticte to the proxy. | [optional] |
13
+ | **proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional] |
14
+ | **username** | **String** | The username to be used for authentication when syncing. | [optional] |
15
+ | **password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional] |
16
+ | **max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional] |
17
+ | **total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
18
+ | **connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
19
+ | **sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
20
+ | **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] |
21
+ | **headers** | **Array&lt;Object&gt;** | Headers for aiohttp.Clientsession | [optional] |
22
+ | **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] |
23
+ | **rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] |
24
+
25
+ ## Example
26
+
27
+ ```ruby
28
+ require 'pulp_npm_client'
29
+
30
+ instance = PulpNpmClient::RemoteNetworkConfig.new(
31
+ ca_cert: null,
32
+ client_cert: null,
33
+ client_key: null,
34
+ tls_validation: null,
35
+ proxy_url: null,
36
+ proxy_username: null,
37
+ proxy_password: null,
38
+ username: null,
39
+ password: null,
40
+ max_retries: null,
41
+ total_timeout: null,
42
+ connect_timeout: null,
43
+ sock_connect_timeout: null,
44
+ sock_read_timeout: null,
45
+ headers: null,
46
+ download_concurrency: null,
47
+ rate_limit: null
48
+ )
49
+ ```
50
+
@@ -0,0 +1,40 @@
1
+ # PulpNpmClient::RemoteNetworkConfigResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] |
8
+ | **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional] |
9
+ | **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] |
10
+ | **proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional] |
11
+ | **max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional] |
12
+ | **total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
13
+ | **connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
14
+ | **sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
15
+ | **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] |
16
+ | **headers** | **Array&lt;Object&gt;** | Headers for aiohttp.Clientsession | [optional] |
17
+ | **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] |
18
+ | **rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'pulp_npm_client'
24
+
25
+ instance = PulpNpmClient::RemoteNetworkConfigResponse.new(
26
+ ca_cert: null,
27
+ client_cert: null,
28
+ tls_validation: null,
29
+ proxy_url: null,
30
+ max_retries: null,
31
+ total_timeout: null,
32
+ connect_timeout: null,
33
+ sock_connect_timeout: null,
34
+ sock_read_timeout: null,
35
+ headers: null,
36
+ download_concurrency: null,
37
+ rate_limit: null
38
+ )
39
+ ```
40
+
@@ -20,7 +20,7 @@ All URIs are relative to *http://localhost:24817*
20
20
 
21
21
  Create a npm remote
22
22
 
23
- A ViewSet for NpmRemote. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
23
+ A ViewSet for NpmRemote. Similar to the NpmPackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
24
24
 
25
25
  ### Examples
26
26
 
@@ -168,7 +168,7 @@ end
168
168
 
169
169
  List npm remotes
170
170
 
171
- A ViewSet for NpmRemote. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
171
+ A ViewSet for NpmRemote. Similar to the NpmPackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
172
172
 
173
173
  ### Examples
174
174
 
@@ -368,7 +368,7 @@ end
368
368
 
369
369
  Inspect a npm remote
370
370
 
371
- A ViewSet for NpmRemote. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
371
+ A ViewSet for NpmRemote. Similar to the NpmPackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
372
372
 
373
373
  ### Examples
374
374