pulp_npm_client 0.1.0a4 → 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (115) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +24 -10
  3. data/docs/AsyncOperationResponse.md +8 -7
  4. data/docs/ContentPackagesApi.md +126 -64
  5. data/docs/ContentSummaryResponse.md +12 -11
  6. data/docs/DistributionsNpmApi.md +362 -93
  7. data/docs/NpmNpmDistribution.md +18 -15
  8. data/docs/NpmNpmDistributionResponse.md +30 -21
  9. data/docs/NpmNpmRemote.md +48 -47
  10. data/docs/NpmNpmRemoteResponse.md +48 -43
  11. data/docs/NpmNpmRemoteResponseHiddenFieldsInner.md +20 -0
  12. data/docs/NpmNpmRepository.md +16 -15
  13. data/docs/NpmNpmRepositoryResponse.md +28 -23
  14. data/docs/NpmPackageResponse.md +22 -17
  15. data/docs/PaginatedRepositoryVersionResponseList.md +14 -13
  16. data/docs/PaginatednpmNpmDistributionResponseList.md +14 -13
  17. data/docs/PaginatednpmNpmRemoteResponseList.md +14 -13
  18. data/docs/PaginatednpmNpmRepositoryResponseList.md +14 -13
  19. data/docs/PaginatednpmPackageResponseList.md +14 -13
  20. data/docs/PatchednpmNpmDistribution.md +18 -15
  21. data/docs/PatchednpmNpmRemote.md +48 -47
  22. data/docs/PatchednpmNpmRepository.md +16 -15
  23. data/docs/PolicyEnum.md +4 -5
  24. data/docs/RemotesNpmApi.md +364 -99
  25. data/docs/Repair.md +8 -7
  26. data/docs/RepositoriesNpmApi.md +429 -110
  27. data/docs/RepositoriesNpmVersionsApi.md +156 -80
  28. data/docs/RepositoryAddRemoveContent.md +12 -11
  29. data/docs/RepositorySyncURL.md +10 -9
  30. data/docs/RepositoryVersionResponse.md +22 -17
  31. data/docs/SetLabel.md +20 -0
  32. data/docs/SetLabelResponse.md +20 -0
  33. data/docs/UnsetLabel.md +18 -0
  34. data/docs/UnsetLabelResponse.md +20 -0
  35. data/lib/pulp_npm_client/api/content_packages_api.rb +72 -44
  36. data/lib/pulp_npm_client/api/distributions_npm_api.rb +243 -47
  37. data/lib/pulp_npm_client/api/remotes_npm_api.rb +247 -57
  38. data/lib/pulp_npm_client/api/repositories_npm_api.rb +283 -55
  39. data/lib/pulp_npm_client/api/repositories_npm_versions_api.rb +71 -52
  40. data/lib/pulp_npm_client/api_client.rb +137 -102
  41. data/lib/pulp_npm_client/api_error.rb +2 -1
  42. data/lib/pulp_npm_client/configuration.rb +163 -22
  43. data/lib/pulp_npm_client/models/async_operation_response.rb +32 -22
  44. data/lib/pulp_npm_client/models/content_summary_response.rb +36 -22
  45. data/lib/pulp_npm_client/models/npm_npm_distribution.rb +51 -25
  46. data/lib/pulp_npm_client/models/npm_npm_distribution_response.rb +83 -27
  47. data/lib/pulp_npm_client/models/npm_npm_remote.rb +61 -25
  48. data/lib/pulp_npm_client/models/npm_npm_remote_response.rb +99 -41
  49. data/lib/pulp_npm_client/models/npm_npm_remote_response_hidden_fields_inner.rb +237 -0
  50. data/lib/pulp_npm_client/models/npm_npm_repository.rb +37 -25
  51. data/lib/pulp_npm_client/models/npm_npm_repository_response.rb +59 -27
  52. data/lib/pulp_npm_client/models/npm_package_response.rb +58 -24
  53. data/lib/pulp_npm_client/models/paginated_repository_version_response_list.rb +44 -22
  54. data/lib/pulp_npm_client/models/paginatednpm_npm_distribution_response_list.rb +44 -22
  55. data/lib/pulp_npm_client/models/paginatednpm_npm_remote_response_list.rb +44 -22
  56. data/lib/pulp_npm_client/models/paginatednpm_npm_repository_response_list.rb +44 -22
  57. data/lib/pulp_npm_client/models/paginatednpm_package_response_list.rb +44 -22
  58. data/lib/pulp_npm_client/models/patchednpm_npm_distribution.rb +57 -27
  59. data/lib/pulp_npm_client/models/patchednpm_npm_remote.rb +67 -27
  60. data/lib/pulp_npm_client/models/patchednpm_npm_repository.rb +40 -26
  61. data/lib/pulp_npm_client/models/policy_enum.rb +8 -4
  62. data/lib/pulp_npm_client/models/repair.rb +30 -22
  63. data/lib/pulp_npm_client/models/repository_add_remove_content.rb +33 -25
  64. data/lib/pulp_npm_client/models/repository_sync_url.rb +30 -22
  65. data/lib/pulp_npm_client/models/repository_version_response.rb +53 -25
  66. data/lib/pulp_npm_client/models/set_label.rb +264 -0
  67. data/lib/pulp_npm_client/models/set_label_response.rb +255 -0
  68. data/lib/pulp_npm_client/models/unset_label.rb +252 -0
  69. data/lib/pulp_npm_client/models/unset_label_response.rb +252 -0
  70. data/lib/pulp_npm_client/version.rb +2 -2
  71. data/lib/pulp_npm_client.rb +6 -3
  72. data/pulp_npm_client.gemspec +10 -7
  73. data/spec/api/content_packages_api_spec.rb +22 -16
  74. data/spec/api/distributions_npm_api_spec.rb +51 -14
  75. data/spec/api/remotes_npm_api_spec.rb +54 -19
  76. data/spec/api/repositories_npm_api_spec.rb +60 -15
  77. data/spec/api/repositories_npm_versions_api_spec.rb +23 -19
  78. data/spec/models/async_operation_response_spec.rb +7 -12
  79. data/spec/models/content_summary_response_spec.rb +9 -14
  80. data/spec/models/npm_npm_distribution_response_spec.rb +38 -19
  81. data/spec/models/npm_npm_distribution_spec.rb +17 -16
  82. data/spec/models/npm_npm_remote_response_hidden_fields_inner_spec.rb +42 -0
  83. data/spec/models/npm_npm_remote_response_spec.rb +42 -35
  84. data/spec/models/npm_npm_remote_spec.rb +27 -32
  85. data/spec/models/npm_npm_repository_response_spec.rb +27 -20
  86. data/spec/models/npm_npm_repository_spec.rb +11 -16
  87. data/spec/models/npm_package_response_spec.rb +24 -17
  88. data/spec/models/paginated_repository_version_response_list_spec.rb +10 -15
  89. data/spec/models/paginatednpm_npm_distribution_response_list_spec.rb +10 -15
  90. data/spec/models/paginatednpm_npm_remote_response_list_spec.rb +10 -15
  91. data/spec/models/paginatednpm_npm_repository_response_list_spec.rb +10 -15
  92. data/spec/models/paginatednpm_package_response_list_spec.rb +10 -15
  93. data/spec/models/patchednpm_npm_distribution_spec.rb +17 -16
  94. data/spec/models/patchednpm_npm_remote_spec.rb +27 -32
  95. data/spec/models/patchednpm_npm_repository_spec.rb +11 -16
  96. data/spec/models/policy_enum_spec.rb +6 -11
  97. data/spec/models/repair_spec.rb +7 -12
  98. data/spec/models/repository_add_remove_content_spec.rb +9 -14
  99. data/spec/models/repository_sync_url_spec.rb +8 -13
  100. data/spec/models/repository_version_response_spec.rb +24 -17
  101. data/spec/models/set_label_response_spec.rb +42 -0
  102. data/spec/models/set_label_spec.rb +42 -0
  103. data/spec/models/unset_label_response_spec.rb +42 -0
  104. data/spec/models/unset_label_spec.rb +36 -0
  105. data/spec/spec_helper.rb +1 -1
  106. metadata +94 -59
  107. data/docs/NpmPackage.md +0 -29
  108. data/docs/PulpNpmPackagesApi.md +0 -60
  109. data/git_push.sh +0 -58
  110. data/lib/pulp_npm_client/api/pulp_npm_packages_api.rb +0 -86
  111. data/lib/pulp_npm_client/models/npm_package.rb +0 -337
  112. data/spec/api/pulp_npm_packages_api_spec.rb +0 -48
  113. data/spec/api_client_spec.rb +0 -188
  114. data/spec/configuration_spec.rb +0 -42
  115. data/spec/models/npm_package_spec.rb +0 -77
data/docs/NpmNpmDistribution.md CHANGED
@@ -2,24 +2,27 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") |
8
- **content_guard** | **String** | An optional content-guard. | [optional]
9
- **pulp_labels** | [**Object**](.md) | | [optional]
10
- **name** | **String** | A unique name. Ex, `rawhide` and `stable`. |
11
- **repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") | |
8
+ | **content_guard** | **String** | An optional content-guard. | [optional] |
9
+ | **hidden** | **Boolean** | Whether this distribution should be shown in the content app. | [optional][default to false] |
10
+ | **pulp_labels** | **Hash<String, String>** | | [optional] |
11
+ | **name** | **String** | A unique name. Ex, `rawhide` and `stable`. | |
12
+ | **repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional] |
12
13
 
13
- ## Code Sample
14
+ ## Example
14
15
 
15
16
  ```ruby
16
- require 'PulpNpmClient'
17
+ require 'pulp_npm_client'
17
18
 
18
- instance = PulpNpmClient::NpmNpmDistribution.new(base_path: null,
19
- content_guard: null,
20
- pulp_labels: null,
21
- name: null,
22
- repository: null)
19
+ instance = PulpNpmClient::NpmNpmDistribution.new(
20
+ base_path: null,
21
+ content_guard: null,
22
+ hidden: null,
23
+ pulp_labels: null,
24
+ name: null,
25
+ repository: null
26
+ )
23
27
  ```
24
28
 
25
-
data/docs/NpmNpmDistributionResponse.md CHANGED
@@ -2,30 +2,39 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **pulp_href** | **String** | | [optional] [readonly]
8
- **pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
9
- **base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") |
10
- **base_url** | **String** | The URL for accessing the universe API as defined by this distribution. | [optional] [readonly]
11
- **content_guard** | **String** | An optional content-guard. | [optional]
12
- **pulp_labels** | [**Object**](.md) | | [optional]
13
- **name** | **String** | A unique name. Ex, `rawhide` and `stable`. |
14
- **repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **pulp_href** | **String** | | [optional][readonly] |
8
+ | **prn** | **String** | The Pulp Resource Name (PRN). | [optional][readonly] |
9
+ | **pulp_created** | **Time** | Timestamp of creation. | [optional][readonly] |
10
+ | **pulp_last_updated** | **Time** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional][readonly] |
11
+ | **base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") | |
12
+ | **base_url** | **String** | The URL for accessing the publication as defined by this distribution. | [optional][readonly] |
13
+ | **content_guard** | **String** | An optional content-guard. | [optional] |
14
+ | **no_content_change_since** | **String** | Timestamp since when the distributed content served by this distribution has not changed. If equals to `null`, no guarantee is provided about content changes. | [optional][readonly] |
15
+ | **hidden** | **Boolean** | Whether this distribution should be shown in the content app. | [optional][default to false] |
16
+ | **pulp_labels** | **Hash<String, String>** | | [optional] |
17
+ | **name** | **String** | A unique name. Ex, `rawhide` and `stable`. | |
18
+ | **repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional] |
15
19
 
16
- ## Code Sample
20
+ ## Example
17
21
 
18
22
  ```ruby
19
- require 'PulpNpmClient'
23
+ require 'pulp_npm_client'
20
24
 
21
- instance = PulpNpmClient::NpmNpmDistributionResponse.new(pulp_href: null,
22
- pulp_created: null,
23
- base_path: null,
24
- base_url: null,
25
- content_guard: null,
26
- pulp_labels: null,
27
- name: null,
28
- repository: null)
25
+ instance = PulpNpmClient::NpmNpmDistributionResponse.new(
26
+ pulp_href: null,
27
+ prn: null,
28
+ pulp_created: null,
29
+ pulp_last_updated: null,
30
+ base_path: null,
31
+ base_url: null,
32
+ content_guard: null,
33
+ no_content_change_since: null,
34
+ hidden: null,
35
+ pulp_labels: null,
36
+ name: null,
37
+ repository: null
38
+ )
29
39
  ```
30
40
 
31
-
data/docs/NpmNpmRemote.md CHANGED
@@ -2,56 +2,57 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **name** | **String** | A unique name for this remote. |
8
- **url** | **String** | The URL of an external content source. |
9
- **ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional]
10
- **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional]
11
- **client_key** | **String** | A PEM encoded private key used for authentication. | [optional]
12
- **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional]
13
- **proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional]
14
- **proxy_username** | **String** | The username to authenticte to the proxy. | [optional]
15
- **proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional]
16
- **username** | **String** | The username to be used for authentication when syncing. | [optional]
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]
19
- **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional]
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: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. | [optional]
22
- **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
- **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
- **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
- **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
- **headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional]
27
- **rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | A unique name for this remote. | |
8
+ | **url** | **String** | The URL of an external content source. | |
9
+ | **ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] |
10
+ | **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional] |
11
+ | **client_key** | **String** | A PEM encoded private key used for authentication. | [optional] |
12
+ | **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] |
13
+ | **proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional] |
14
+ | **proxy_username** | **String** | The username to authenticte to the proxy. | [optional] |
15
+ | **proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional] |
16
+ | **username** | **String** | The username to be used for authentication when syncing. | [optional] |
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** | **Hash<String, String>** | | [optional] |
19
+ | **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] |
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: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - 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. * `streamed` - 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
+ | **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
+ | **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
+ | **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
+ | **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
+ | **headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional] |
27
+ | **rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] |
28
28
 
29
- ## Code Sample
29
+ ## Example
30
30
 
31
31
  ```ruby
32
- require 'PulpNpmClient'
32
+ require 'pulp_npm_client'
33
33
 
34
- instance = PulpNpmClient::NpmNpmRemote.new(name: null,
35
- url: null,
36
- ca_cert: null,
37
- client_cert: null,
38
- client_key: null,
39
- tls_validation: null,
40
- proxy_url: null,
41
- proxy_username: null,
42
- proxy_password: null,
43
- username: null,
44
- password: null,
45
- pulp_labels: null,
46
- download_concurrency: null,
47
- max_retries: null,
48
- policy: null,
49
- total_timeout: null,
50
- connect_timeout: null,
51
- sock_connect_timeout: null,
52
- sock_read_timeout: null,
53
- headers: null,
54
- rate_limit: null)
34
+ instance = PulpNpmClient::NpmNpmRemote.new(
35
+ name: null,
36
+ url: null,
37
+ ca_cert: null,
38
+ client_cert: null,
39
+ client_key: null,
40
+ tls_validation: null,
41
+ proxy_url: null,
42
+ proxy_username: null,
43
+ proxy_password: null,
44
+ username: null,
45
+ password: null,
46
+ pulp_labels: null,
47
+ download_concurrency: null,
48
+ max_retries: null,
49
+ policy: null,
50
+ total_timeout: null,
51
+ connect_timeout: null,
52
+ sock_connect_timeout: null,
53
+ sock_read_timeout: null,
54
+ headers: null,
55
+ rate_limit: null
56
+ )
55
57
  ```
56
58
 
57
-
data/docs/NpmNpmRemoteResponse.md CHANGED
@@ -2,52 +2,57 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **pulp_href** | **String** | | [optional] [readonly]
8
- **pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
9
- **name** | **String** | A unique name for this remote. |
10
- **url** | **String** | The URL of an external content source. |
11
- **ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional]
12
- **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional]
13
- **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional]
14
- **proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional]
15
- **pulp_labels** | [**Object**](.md) | | [optional]
16
- **pulp_last_updated** | **DateTime** | Timestamp of the most recent update of the remote. | [optional] [readonly]
17
- **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional]
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]
19
- **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. | [optional]
20
- **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]
21
- **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]
22
- **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]
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
- **headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional]
25
- **rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **pulp_href** | **String** | | [optional][readonly] |
8
+ | **prn** | **String** | The Pulp Resource Name (PRN). | [optional][readonly] |
9
+ | **pulp_created** | **Time** | Timestamp of creation. | [optional][readonly] |
10
+ | **pulp_last_updated** | **Time** | Timestamp of the most recent update of the remote. | [optional][readonly] |
11
+ | **name** | **String** | A unique name for this remote. | |
12
+ | **url** | **String** | The URL of an external content source. | |
13
+ | **ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] |
14
+ | **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional] |
15
+ | **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] |
16
+ | **proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional] |
17
+ | **pulp_labels** | **Hash<String, String>** | | [optional] |
18
+ | **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] |
19
+ | **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: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - 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. * `streamed` - 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
+ | **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
+ | **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
+ | **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
+ | **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
+ | **headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional] |
26
+ | **rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] |
27
+ | **hidden_fields** | [**Array<NpmNpmRemoteResponseHiddenFieldsInner>**](NpmNpmRemoteResponseHiddenFieldsInner.md) | List of hidden (write only) fields | [optional][readonly] |
26
28
 
27
- ## Code Sample
29
+ ## Example
28
30
 
29
31
  ```ruby
30
- require 'PulpNpmClient'
32
+ require 'pulp_npm_client'
31
33
 
32
- instance = PulpNpmClient::NpmNpmRemoteResponse.new(pulp_href: null,
33
- pulp_created: null,
34
- name: null,
35
- url: null,
36
- ca_cert: null,
37
- client_cert: null,
38
- tls_validation: null,
39
- proxy_url: null,
40
- pulp_labels: null,
41
- pulp_last_updated: null,
42
- download_concurrency: null,
43
- max_retries: null,
44
- policy: null,
45
- total_timeout: null,
46
- connect_timeout: null,
47
- sock_connect_timeout: null,
48
- sock_read_timeout: null,
49
- headers: null,
50
- rate_limit: null)
34
+ instance = PulpNpmClient::NpmNpmRemoteResponse.new(
35
+ pulp_href: null,
36
+ prn: null,
37
+ pulp_created: null,
38
+ pulp_last_updated: null,
39
+ name: null,
40
+ url: null,
41
+ ca_cert: null,
42
+ client_cert: null,
43
+ tls_validation: null,
44
+ proxy_url: null,
45
+ pulp_labels: null,
46
+ download_concurrency: null,
47
+ max_retries: null,
48
+ policy: null,
49
+ total_timeout: null,
50
+ connect_timeout: null,
51
+ sock_connect_timeout: null,
52
+ sock_read_timeout: null,
53
+ headers: null,
54
+ rate_limit: null,
55
+ hidden_fields: null
56
+ )
51
57
  ```
52
58
 
53
-
data/docs/NpmNpmRemoteResponseHiddenFieldsInner.md ADDED
@@ -0,0 +1,20 @@
1
+ # PulpNpmClient::NpmNpmRemoteResponseHiddenFieldsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | | |
8
+ | **is_set** | **Boolean** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'pulp_npm_client'
14
+
15
+ instance = PulpNpmClient::NpmNpmRemoteResponseHiddenFieldsInner.new(
16
+ name: null,
17
+ is_set: null
18
+ )
19
+ ```
20
+
data/docs/NpmNpmRepository.md CHANGED
@@ -2,24 +2,25 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **pulp_labels** | [**Object**](.md) | | [optional]
8
- **name** | **String** | A unique name for this repository. |
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]
11
- **remote** | **String** | An optional remote to use by default when syncing. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **pulp_labels** | **Hash<String, String>** | | [optional] |
8
+ | **name** | **String** | A unique name for this repository. | |
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. | [optional] |
11
+ | **remote** | **String** | An optional remote to use by default when syncing. | [optional] |
12
12
 
13
- ## Code Sample
13
+ ## Example
14
14
 
15
15
  ```ruby
16
- require 'PulpNpmClient'
16
+ require 'pulp_npm_client'
17
17
 
18
- instance = PulpNpmClient::NpmNpmRepository.new(pulp_labels: null,
19
- name: null,
20
- description: null,
21
- retain_repo_versions: null,
22
- remote: null)
18
+ instance = PulpNpmClient::NpmNpmRepository.new(
19
+ pulp_labels: null,
20
+ name: null,
21
+ description: null,
22
+ retain_repo_versions: null,
23
+ remote: null
24
+ )
23
25
  ```
24
26
 
25
-
data/docs/NpmNpmRepositoryResponse.md CHANGED
@@ -2,32 +2,37 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **pulp_href** | **String** | | [optional] [readonly]
8
- **pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
9
- **versions_href** | **String** | | [optional] [readonly]
10
- **pulp_labels** | [**Object**](.md) | | [optional]
11
- **latest_version_href** | **String** | | [optional] [readonly]
12
- **name** | **String** | A unique name for this repository. |
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]
15
- **remote** | **String** | An optional remote to use by default when syncing. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **pulp_href** | **String** | | [optional][readonly] |
8
+ | **prn** | **String** | The Pulp Resource Name (PRN). | [optional][readonly] |
9
+ | **pulp_created** | **Time** | Timestamp of creation. | [optional][readonly] |
10
+ | **pulp_last_updated** | **Time** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional][readonly] |
11
+ | **versions_href** | **String** | | [optional][readonly] |
12
+ | **pulp_labels** | **Hash<String, String>** | | [optional] |
13
+ | **latest_version_href** | **String** | | [optional][readonly] |
14
+ | **name** | **String** | A unique name for this repository. | |
15
+ | **description** | **String** | An optional description. | [optional] |
16
+ | **retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. | [optional] |
17
+ | **remote** | **String** | An optional remote to use by default when syncing. | [optional] |
16
18
 
17
- ## Code Sample
19
+ ## Example
18
20
 
19
21
  ```ruby
20
- require 'PulpNpmClient'
22
+ require 'pulp_npm_client'
21
23
 
22
- instance = PulpNpmClient::NpmNpmRepositoryResponse.new(pulp_href: null,
23
- pulp_created: null,
24
- versions_href: null,
25
- pulp_labels: null,
26
- latest_version_href: null,
27
- name: null,
28
- description: null,
29
- retain_repo_versions: null,
30
- remote: null)
24
+ instance = PulpNpmClient::NpmNpmRepositoryResponse.new(
25
+ pulp_href: null,
26
+ prn: null,
27
+ pulp_created: null,
28
+ pulp_last_updated: null,
29
+ versions_href: null,
30
+ pulp_labels: null,
31
+ latest_version_href: null,
32
+ name: null,
33
+ description: null,
34
+ retain_repo_versions: null,
35
+ remote: null
36
+ )
31
37
  ```
32
38
 
33
-
data/docs/NpmPackageResponse.md CHANGED
@@ -2,26 +2,31 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **pulp_href** | **String** | | [optional] [readonly]
8
- **pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
9
- **artifact** | **String** | Artifact file representing the physical content | [optional]
10
- **relative_path** | **String** | |
11
- **name** | **String** | |
12
- **version** | **String** | |
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
+ | **artifact** | **String** | Artifact file representing the physical content | [optional] |
12
+ | **relative_path** | **String** | | |
13
+ | **name** | **String** | | |
14
+ | **version** | **String** | | |
13
15
 
14
- ## Code Sample
16
+ ## Example
15
17
 
16
18
  ```ruby
17
- require 'PulpNpmClient'
19
+ require 'pulp_npm_client'
18
20
 
19
- instance = PulpNpmClient::NpmPackageResponse.new(pulp_href: null,
20
- pulp_created: null,
21
- artifact: null,
22
- relative_path: null,
23
- name: null,
24
- version: null)
21
+ instance = PulpNpmClient::NpmPackageResponse.new(
22
+ pulp_href: null,
23
+ prn: null,
24
+ pulp_created: null,
25
+ pulp_last_updated: null,
26
+ artifact: null,
27
+ relative_path: null,
28
+ name: null,
29
+ version: null
30
+ )
25
31
  ```
26
32
 
27
-
data/docs/PaginatedRepositoryVersionResponseList.md CHANGED
@@ -2,22 +2,23 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **count** | **Integer** | | [optional]
8
- **_next** | **String** | | [optional]
9
- **previous** | **String** | | [optional]
10
- **results** | [**Array<RepositoryVersionResponse>**](RepositoryVersionResponse.md) | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **count** | **Integer** | | |
8
+ | **_next** | **String** | | [optional] |
9
+ | **previous** | **String** | | [optional] |
10
+ | **results** | [**Array<RepositoryVersionResponse>**](RepositoryVersionResponse.md) | | |
11
11
 
12
- ## Code Sample
12
+ ## Example
13
13
 
14
14
  ```ruby
15
- require 'PulpNpmClient'
15
+ require 'pulp_npm_client'
16
16
 
17
- instance = PulpNpmClient::PaginatedRepositoryVersionResponseList.new(count: 123,
18
- _next: http://api.example.org/accounts/?offset=400&limit=100,
19
- previous: http://api.example.org/accounts/?offset=200&limit=100,
20
- results: null)
17
+ instance = PulpNpmClient::PaginatedRepositoryVersionResponseList.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
+ )
21
23
  ```
22
24
 
23
-
data/docs/PaginatednpmNpmDistributionResponseList.md CHANGED
@@ -2,22 +2,23 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **count** | **Integer** | | [optional]
8
- **_next** | **String** | | [optional]
9
- **previous** | **String** | | [optional]
10
- **results** | [**Array<NpmNpmDistributionResponse>**](NpmNpmDistributionResponse.md) | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **count** | **Integer** | | |
8
+ | **_next** | **String** | | [optional] |
9
+ | **previous** | **String** | | [optional] |
10
+ | **results** | [**Array<NpmNpmDistributionResponse>**](NpmNpmDistributionResponse.md) | | |
11
11
 
12
- ## Code Sample
12
+ ## Example
13
13
 
14
14
  ```ruby
15
- require 'PulpNpmClient'
15
+ require 'pulp_npm_client'
16
16
 
17
- instance = PulpNpmClient::PaginatednpmNpmDistributionResponseList.new(count: 123,
18
- _next: http://api.example.org/accounts/?offset=400&limit=100,
19
- previous: http://api.example.org/accounts/?offset=200&limit=100,
20
- results: null)
17
+ instance = PulpNpmClient::PaginatednpmNpmDistributionResponseList.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
+ )
21
23
  ```
22
24
 
23
-
data/docs/PaginatednpmNpmRemoteResponseList.md CHANGED
@@ -2,22 +2,23 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **count** | **Integer** | | [optional]
8
- **_next** | **String** | | [optional]
9
- **previous** | **String** | | [optional]
10
- **results** | [**Array<NpmNpmRemoteResponse>**](NpmNpmRemoteResponse.md) | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **count** | **Integer** | | |
8
+ | **_next** | **String** | | [optional] |
9
+ | **previous** | **String** | | [optional] |
10
+ | **results** | [**Array<NpmNpmRemoteResponse>**](NpmNpmRemoteResponse.md) | | |
11
11
 
12
- ## Code Sample
12
+ ## Example
13
13
 
14
14
  ```ruby
15
- require 'PulpNpmClient'
15
+ require 'pulp_npm_client'
16
16
 
17
- instance = PulpNpmClient::PaginatednpmNpmRemoteResponseList.new(count: 123,
18
- _next: http://api.example.org/accounts/?offset=400&limit=100,
19
- previous: http://api.example.org/accounts/?offset=200&limit=100,
20
- results: null)
17
+ instance = PulpNpmClient::PaginatednpmNpmRemoteResponseList.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
+ )
21
23
  ```
22
24
 
23
-