pulp_npm_client 0.1.0a4 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +24 -10
- data/docs/AsyncOperationResponse.md +8 -7
- data/docs/ContentPackagesApi.md +126 -64
- data/docs/ContentSummaryResponse.md +12 -11
- data/docs/DistributionsNpmApi.md +362 -93
- data/docs/NpmNpmDistribution.md +18 -15
- data/docs/NpmNpmDistributionResponse.md +30 -21
- data/docs/NpmNpmRemote.md +48 -47
- data/docs/NpmNpmRemoteResponse.md +48 -43
- data/docs/NpmNpmRemoteResponseHiddenFieldsInner.md +20 -0
- data/docs/NpmNpmRepository.md +16 -15
- data/docs/NpmNpmRepositoryResponse.md +28 -23
- data/docs/NpmPackageResponse.md +22 -17
- data/docs/PaginatedRepositoryVersionResponseList.md +14 -13
- data/docs/PaginatednpmNpmDistributionResponseList.md +14 -13
- data/docs/PaginatednpmNpmRemoteResponseList.md +14 -13
- data/docs/PaginatednpmNpmRepositoryResponseList.md +14 -13
- data/docs/PaginatednpmPackageResponseList.md +14 -13
- data/docs/PatchednpmNpmDistribution.md +18 -15
- data/docs/PatchednpmNpmRemote.md +48 -47
- data/docs/PatchednpmNpmRepository.md +16 -15
- data/docs/PolicyEnum.md +4 -5
- data/docs/RemotesNpmApi.md +364 -99
- data/docs/Repair.md +8 -7
- data/docs/RepositoriesNpmApi.md +429 -110
- data/docs/RepositoriesNpmVersionsApi.md +156 -80
- data/docs/RepositoryAddRemoveContent.md +12 -11
- data/docs/RepositorySyncURL.md +10 -9
- data/docs/RepositoryVersionResponse.md +22 -17
- data/docs/SetLabel.md +20 -0
- data/docs/SetLabelResponse.md +20 -0
- data/docs/UnsetLabel.md +18 -0
- data/docs/UnsetLabelResponse.md +20 -0
- data/lib/pulp_npm_client/api/content_packages_api.rb +72 -44
- data/lib/pulp_npm_client/api/distributions_npm_api.rb +243 -47
- data/lib/pulp_npm_client/api/remotes_npm_api.rb +247 -57
- data/lib/pulp_npm_client/api/repositories_npm_api.rb +283 -55
- data/lib/pulp_npm_client/api/repositories_npm_versions_api.rb +71 -52
- data/lib/pulp_npm_client/api_client.rb +137 -102
- data/lib/pulp_npm_client/api_error.rb +2 -1
- data/lib/pulp_npm_client/configuration.rb +163 -22
- data/lib/pulp_npm_client/models/async_operation_response.rb +32 -22
- data/lib/pulp_npm_client/models/content_summary_response.rb +36 -22
- data/lib/pulp_npm_client/models/npm_npm_distribution.rb +51 -25
- data/lib/pulp_npm_client/models/npm_npm_distribution_response.rb +83 -27
- data/lib/pulp_npm_client/models/npm_npm_remote.rb +61 -25
- data/lib/pulp_npm_client/models/npm_npm_remote_response.rb +99 -41
- data/lib/pulp_npm_client/models/npm_npm_remote_response_hidden_fields_inner.rb +237 -0
- data/lib/pulp_npm_client/models/npm_npm_repository.rb +37 -25
- data/lib/pulp_npm_client/models/npm_npm_repository_response.rb +59 -27
- data/lib/pulp_npm_client/models/npm_package_response.rb +58 -24
- data/lib/pulp_npm_client/models/paginated_repository_version_response_list.rb +44 -22
- data/lib/pulp_npm_client/models/paginatednpm_npm_distribution_response_list.rb +44 -22
- data/lib/pulp_npm_client/models/paginatednpm_npm_remote_response_list.rb +44 -22
- data/lib/pulp_npm_client/models/paginatednpm_npm_repository_response_list.rb +44 -22
- data/lib/pulp_npm_client/models/paginatednpm_package_response_list.rb +44 -22
- data/lib/pulp_npm_client/models/patchednpm_npm_distribution.rb +57 -27
- data/lib/pulp_npm_client/models/patchednpm_npm_remote.rb +67 -27
- data/lib/pulp_npm_client/models/patchednpm_npm_repository.rb +40 -26
- data/lib/pulp_npm_client/models/policy_enum.rb +8 -4
- data/lib/pulp_npm_client/models/repair.rb +30 -22
- data/lib/pulp_npm_client/models/repository_add_remove_content.rb +33 -25
- data/lib/pulp_npm_client/models/repository_sync_url.rb +30 -22
- data/lib/pulp_npm_client/models/repository_version_response.rb +53 -25
- data/lib/pulp_npm_client/models/set_label.rb +264 -0
- data/lib/pulp_npm_client/models/set_label_response.rb +255 -0
- data/lib/pulp_npm_client/models/unset_label.rb +252 -0
- data/lib/pulp_npm_client/models/unset_label_response.rb +252 -0
- data/lib/pulp_npm_client/version.rb +2 -2
- data/lib/pulp_npm_client.rb +6 -3
- data/pulp_npm_client.gemspec +10 -7
- data/spec/api/content_packages_api_spec.rb +22 -16
- data/spec/api/distributions_npm_api_spec.rb +51 -14
- data/spec/api/remotes_npm_api_spec.rb +54 -19
- data/spec/api/repositories_npm_api_spec.rb +60 -15
- data/spec/api/repositories_npm_versions_api_spec.rb +23 -19
- data/spec/models/async_operation_response_spec.rb +7 -12
- data/spec/models/content_summary_response_spec.rb +9 -14
- data/spec/models/npm_npm_distribution_response_spec.rb +38 -19
- data/spec/models/npm_npm_distribution_spec.rb +17 -16
- data/spec/models/npm_npm_remote_response_hidden_fields_inner_spec.rb +42 -0
- data/spec/models/npm_npm_remote_response_spec.rb +42 -35
- data/spec/models/npm_npm_remote_spec.rb +27 -32
- data/spec/models/npm_npm_repository_response_spec.rb +27 -20
- data/spec/models/npm_npm_repository_spec.rb +11 -16
- data/spec/models/npm_package_response_spec.rb +24 -17
- data/spec/models/paginated_repository_version_response_list_spec.rb +10 -15
- data/spec/models/paginatednpm_npm_distribution_response_list_spec.rb +10 -15
- data/spec/models/paginatednpm_npm_remote_response_list_spec.rb +10 -15
- data/spec/models/paginatednpm_npm_repository_response_list_spec.rb +10 -15
- data/spec/models/paginatednpm_package_response_list_spec.rb +10 -15
- data/spec/models/patchednpm_npm_distribution_spec.rb +17 -16
- data/spec/models/patchednpm_npm_remote_spec.rb +27 -32
- data/spec/models/patchednpm_npm_repository_spec.rb +11 -16
- data/spec/models/policy_enum_spec.rb +6 -11
- data/spec/models/repair_spec.rb +7 -12
- data/spec/models/repository_add_remove_content_spec.rb +9 -14
- data/spec/models/repository_sync_url_spec.rb +8 -13
- data/spec/models/repository_version_response_spec.rb +24 -17
- data/spec/models/set_label_response_spec.rb +42 -0
- data/spec/models/set_label_spec.rb +42 -0
- data/spec/models/unset_label_response_spec.rb +42 -0
- data/spec/models/unset_label_spec.rb +36 -0
- data/spec/spec_helper.rb +1 -1
- metadata +94 -59
- data/docs/NpmPackage.md +0 -29
- data/docs/PulpNpmPackagesApi.md +0 -60
- data/git_push.sh +0 -58
- data/lib/pulp_npm_client/api/pulp_npm_packages_api.rb +0 -86
- data/lib/pulp_npm_client/models/npm_package.rb +0 -337
- data/spec/api/pulp_npm_packages_api_spec.rb +0 -48
- data/spec/api_client_spec.rb +0 -188
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/npm_package_spec.rb +0 -77
|
@@ -1,28 +1,27 @@
|
|
|
1
1
|
# PulpNpmClient::RepositoriesNpmVersionsApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *
|
|
4
|
-
|
|
5
|
-
Method | HTTP request | Description
|
|
6
|
-
------------- | ------------- | -------------
|
|
7
|
-
[**delete**](RepositoriesNpmVersionsApi.md#delete) | **DELETE** {npm_npm_repository_version_href} | Delete a repository version
|
|
8
|
-
[**list**](RepositoriesNpmVersionsApi.md#list) | **GET** {npm_npm_repository_href}versions/ | List repository versions
|
|
9
|
-
[**read**](RepositoriesNpmVersionsApi.md#read) | **GET** {npm_npm_repository_version_href} | Inspect a repository version
|
|
10
|
-
[**repair**](RepositoriesNpmVersionsApi.md#repair) | **POST** {npm_npm_repository_version_href}repair/ |
|
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
|
11
4
|
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**delete**](RepositoriesNpmVersionsApi.md#delete) | **DELETE** {npm_npm_repository_version_href} | Delete a repository version |
|
|
8
|
+
| [**list**](RepositoriesNpmVersionsApi.md#list) | **GET** {npm_npm_repository_href}versions/ | List repository versions |
|
|
9
|
+
| [**read**](RepositoriesNpmVersionsApi.md#read) | **GET** {npm_npm_repository_version_href} | Inspect a repository version |
|
|
10
|
+
| [**repair**](RepositoriesNpmVersionsApi.md#repair) | **POST** {npm_npm_repository_version_href}repair/ | |
|
|
12
11
|
|
|
13
12
|
|
|
14
13
|
## delete
|
|
15
14
|
|
|
16
|
-
> AsyncOperationResponse delete(npm_npm_repository_version_href)
|
|
15
|
+
> <AsyncOperationResponse> delete(npm_npm_repository_version_href)
|
|
17
16
|
|
|
18
17
|
Delete a repository version
|
|
19
18
|
|
|
20
19
|
Trigger an asynchronous task to delete a repository version.
|
|
21
20
|
|
|
22
|
-
###
|
|
21
|
+
### Examples
|
|
23
22
|
|
|
24
23
|
```ruby
|
|
25
|
-
|
|
24
|
+
require 'time'
|
|
26
25
|
require 'pulp_npm_client'
|
|
27
26
|
# setup authorization
|
|
28
27
|
PulpNpmClient.configure do |config|
|
|
@@ -35,20 +34,37 @@ api_instance = PulpNpmClient::RepositoriesNpmVersionsApi.new
|
|
|
35
34
|
npm_npm_repository_version_href = 'npm_npm_repository_version_href_example' # String |
|
|
36
35
|
|
|
37
36
|
begin
|
|
38
|
-
#Delete a repository version
|
|
37
|
+
# Delete a repository version
|
|
39
38
|
result = api_instance.delete(npm_npm_repository_version_href)
|
|
40
39
|
p result
|
|
41
40
|
rescue PulpNpmClient::ApiError => e
|
|
42
|
-
puts "
|
|
41
|
+
puts "Error when calling RepositoriesNpmVersionsApi->delete: #{e}"
|
|
43
42
|
end
|
|
44
43
|
```
|
|
45
44
|
|
|
46
|
-
|
|
45
|
+
#### Using the delete_with_http_info variant
|
|
46
|
+
|
|
47
|
+
This returns an Array which contains the response data, status code and headers.
|
|
47
48
|
|
|
49
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> delete_with_http_info(npm_npm_repository_version_href)
|
|
50
|
+
|
|
51
|
+
```ruby
|
|
52
|
+
begin
|
|
53
|
+
# Delete a repository version
|
|
54
|
+
data, status_code, headers = api_instance.delete_with_http_info(npm_npm_repository_version_href)
|
|
55
|
+
p status_code # => 2xx
|
|
56
|
+
p headers # => { ... }
|
|
57
|
+
p data # => <AsyncOperationResponse>
|
|
58
|
+
rescue PulpNpmClient::ApiError => e
|
|
59
|
+
puts "Error when calling RepositoriesNpmVersionsApi->delete_with_http_info: #{e}"
|
|
60
|
+
end
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Parameters
|
|
48
64
|
|
|
49
|
-
Name | Type | Description
|
|
50
|
-
|
|
51
|
-
**npm_npm_repository_version_href** | **String
|
|
65
|
+
| Name | Type | Description | Notes |
|
|
66
|
+
| ---- | ---- | ----------- | ----- |
|
|
67
|
+
| **npm_npm_repository_version_href** | **String** | | |
|
|
52
68
|
|
|
53
69
|
### Return type
|
|
54
70
|
|
|
@@ -66,16 +82,16 @@ Name | Type | Description | Notes
|
|
|
66
82
|
|
|
67
83
|
## list
|
|
68
84
|
|
|
69
|
-
> PaginatedRepositoryVersionResponseList list(npm_npm_repository_href, opts)
|
|
85
|
+
> <PaginatedRepositoryVersionResponseList> list(npm_npm_repository_href, opts)
|
|
70
86
|
|
|
71
87
|
List repository versions
|
|
72
88
|
|
|
73
89
|
A ViewSet for a NpmRepositoryVersion represents a single Npm repository version.
|
|
74
90
|
|
|
75
|
-
###
|
|
91
|
+
### Examples
|
|
76
92
|
|
|
77
93
|
```ruby
|
|
78
|
-
|
|
94
|
+
require 'time'
|
|
79
95
|
require 'pulp_npm_client'
|
|
80
96
|
# setup authorization
|
|
81
97
|
PulpNpmClient.configure do |config|
|
|
@@ -87,61 +103,86 @@ end
|
|
|
87
103
|
api_instance = PulpNpmClient::RepositoriesNpmVersionsApi.new
|
|
88
104
|
npm_npm_repository_href = 'npm_npm_repository_href_example' # String |
|
|
89
105
|
opts = {
|
|
90
|
-
content: 'content_example', # String | Content Unit referenced by HREF
|
|
91
|
-
content__in: '
|
|
106
|
+
content: 'content_example', # String | Content Unit referenced by HREF/PRN
|
|
107
|
+
content__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
|
92
108
|
limit: 56, # Integer | Number of results to return per page.
|
|
93
|
-
number: 56, # Integer |
|
|
109
|
+
number: 56, # Integer | Filter results where number matches value
|
|
94
110
|
number__gt: 56, # Integer | Filter results where number is greater than value
|
|
95
111
|
number__gte: 56, # Integer | Filter results where number is greater than or equal to value
|
|
96
112
|
number__lt: 56, # Integer | Filter results where number is less than value
|
|
97
113
|
number__lte: 56, # Integer | Filter results where number is less than or equal to value
|
|
98
|
-
number__range: [
|
|
114
|
+
number__range: [37], # Array<Integer> | Filter results where number is between two comma separated values
|
|
99
115
|
offset: 56, # Integer | The initial index from which to return the results.
|
|
100
|
-
ordering: ['
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
116
|
+
ordering: ['-complete'], # Array<String> | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `number` - Number * `-number` - Number (descending) * `complete` - Complete * `-complete` - Complete (descending) * `info` - Info * `-info` - Info (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
|
117
|
+
prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
|
118
|
+
pulp_created: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_created matches value
|
|
119
|
+
pulp_created__gt: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_created is greater than value
|
|
120
|
+
pulp_created__gte: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_created is greater than or equal to value
|
|
121
|
+
pulp_created__isnull: true, # Boolean | Filter results where pulp_created has a null value
|
|
122
|
+
pulp_created__lt: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_created is less than value
|
|
123
|
+
pulp_created__lte: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_created is less than or equal to value
|
|
124
|
+
pulp_created__range: [Time.now], # Array<Time> | Filter results where pulp_created is between two comma separated values
|
|
125
|
+
pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
|
126
|
+
q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
|
|
127
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
|
128
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
|
109
129
|
}
|
|
110
130
|
|
|
111
131
|
begin
|
|
112
|
-
#List repository versions
|
|
132
|
+
# List repository versions
|
|
113
133
|
result = api_instance.list(npm_npm_repository_href, opts)
|
|
114
134
|
p result
|
|
115
135
|
rescue PulpNpmClient::ApiError => e
|
|
116
|
-
puts "
|
|
136
|
+
puts "Error when calling RepositoriesNpmVersionsApi->list: #{e}"
|
|
117
137
|
end
|
|
118
138
|
```
|
|
119
139
|
|
|
120
|
-
|
|
140
|
+
#### Using the list_with_http_info variant
|
|
141
|
+
|
|
142
|
+
This returns an Array which contains the response data, status code and headers.
|
|
143
|
+
|
|
144
|
+
> <Array(<PaginatedRepositoryVersionResponseList>, Integer, Hash)> list_with_http_info(npm_npm_repository_href, opts)
|
|
145
|
+
|
|
146
|
+
```ruby
|
|
147
|
+
begin
|
|
148
|
+
# List repository versions
|
|
149
|
+
data, status_code, headers = api_instance.list_with_http_info(npm_npm_repository_href, opts)
|
|
150
|
+
p status_code # => 2xx
|
|
151
|
+
p headers # => { ... }
|
|
152
|
+
p data # => <PaginatedRepositoryVersionResponseList>
|
|
153
|
+
rescue PulpNpmClient::ApiError => e
|
|
154
|
+
puts "Error when calling RepositoriesNpmVersionsApi->list_with_http_info: #{e}"
|
|
155
|
+
end
|
|
156
|
+
```
|
|
121
157
|
|
|
158
|
+
### Parameters
|
|
122
159
|
|
|
123
|
-
Name | Type | Description
|
|
124
|
-
|
|
125
|
-
**npm_npm_repository_href** | **String
|
|
126
|
-
**content** | **String
|
|
127
|
-
**content__in** | **String
|
|
128
|
-
**limit** | **Integer
|
|
129
|
-
**number** | **Integer
|
|
130
|
-
**number__gt** | **Integer
|
|
131
|
-
**number__gte** | **Integer
|
|
132
|
-
**number__lt** | **Integer
|
|
133
|
-
**number__lte** | **Integer
|
|
134
|
-
**number__range** | [**Array<Integer>**](Integer.md)| Filter results where number is between two comma separated values | [optional]
|
|
135
|
-
**offset** | **Integer
|
|
136
|
-
**ordering** | [**Array<String>**](String.md)| Ordering | [optional]
|
|
137
|
-
**
|
|
138
|
-
**
|
|
139
|
-
**
|
|
140
|
-
**
|
|
141
|
-
**
|
|
142
|
-
**
|
|
143
|
-
**
|
|
144
|
-
**
|
|
160
|
+
| Name | Type | Description | Notes |
|
|
161
|
+
| ---- | ---- | ----------- | ----- |
|
|
162
|
+
| **npm_npm_repository_href** | **String** | | |
|
|
163
|
+
| **content** | **String** | Content Unit referenced by HREF/PRN | [optional] |
|
|
164
|
+
| **content__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
|
165
|
+
| **limit** | **Integer** | Number of results to return per page. | [optional] |
|
|
166
|
+
| **number** | **Integer** | Filter results where number matches value | [optional] |
|
|
167
|
+
| **number__gt** | **Integer** | Filter results where number is greater than value | [optional] |
|
|
168
|
+
| **number__gte** | **Integer** | Filter results where number is greater than or equal to value | [optional] |
|
|
169
|
+
| **number__lt** | **Integer** | Filter results where number is less than value | [optional] |
|
|
170
|
+
| **number__lte** | **Integer** | Filter results where number is less than or equal to value | [optional] |
|
|
171
|
+
| **number__range** | [**Array<Integer>**](Integer.md) | Filter results where number is between two comma separated values | [optional] |
|
|
172
|
+
| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
|
|
173
|
+
| **ordering** | [**Array<String>**](String.md) | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `number` - Number * `-number` - Number (descending) * `complete` - Complete * `-complete` - Complete (descending) * `info` - Info * `-info` - Info (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] |
|
|
174
|
+
| **prn__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
|
175
|
+
| **pulp_created** | **Time** | Filter results where pulp_created matches value | [optional] |
|
|
176
|
+
| **pulp_created__gt** | **Time** | Filter results where pulp_created is greater than value | [optional] |
|
|
177
|
+
| **pulp_created__gte** | **Time** | Filter results where pulp_created is greater than or equal to value | [optional] |
|
|
178
|
+
| **pulp_created__isnull** | **Boolean** | Filter results where pulp_created has a null value | [optional] |
|
|
179
|
+
| **pulp_created__lt** | **Time** | Filter results where pulp_created is less than value | [optional] |
|
|
180
|
+
| **pulp_created__lte** | **Time** | Filter results where pulp_created is less than or equal to value | [optional] |
|
|
181
|
+
| **pulp_created__range** | [**Array<Time>**](Time.md) | Filter results where pulp_created is between two comma separated values | [optional] |
|
|
182
|
+
| **pulp_href__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
|
183
|
+
| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
|
|
184
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
|
185
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
|
145
186
|
|
|
146
187
|
### Return type
|
|
147
188
|
|
|
@@ -159,16 +200,16 @@ Name | Type | Description | Notes
|
|
|
159
200
|
|
|
160
201
|
## read
|
|
161
202
|
|
|
162
|
-
> RepositoryVersionResponse read(npm_npm_repository_version_href, opts)
|
|
203
|
+
> <RepositoryVersionResponse> read(npm_npm_repository_version_href, opts)
|
|
163
204
|
|
|
164
205
|
Inspect a repository version
|
|
165
206
|
|
|
166
207
|
A ViewSet for a NpmRepositoryVersion represents a single Npm repository version.
|
|
167
208
|
|
|
168
|
-
###
|
|
209
|
+
### Examples
|
|
169
210
|
|
|
170
211
|
```ruby
|
|
171
|
-
|
|
212
|
+
require 'time'
|
|
172
213
|
require 'pulp_npm_client'
|
|
173
214
|
# setup authorization
|
|
174
215
|
PulpNpmClient.configure do |config|
|
|
@@ -180,27 +221,44 @@ end
|
|
|
180
221
|
api_instance = PulpNpmClient::RepositoriesNpmVersionsApi.new
|
|
181
222
|
npm_npm_repository_version_href = 'npm_npm_repository_version_href_example' # String |
|
|
182
223
|
opts = {
|
|
183
|
-
fields: '
|
|
184
|
-
exclude_fields: '
|
|
224
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
|
225
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
|
185
226
|
}
|
|
186
227
|
|
|
187
228
|
begin
|
|
188
|
-
#Inspect a repository version
|
|
229
|
+
# Inspect a repository version
|
|
189
230
|
result = api_instance.read(npm_npm_repository_version_href, opts)
|
|
190
231
|
p result
|
|
191
232
|
rescue PulpNpmClient::ApiError => e
|
|
192
|
-
puts "
|
|
233
|
+
puts "Error when calling RepositoriesNpmVersionsApi->read: #{e}"
|
|
193
234
|
end
|
|
194
235
|
```
|
|
195
236
|
|
|
196
|
-
|
|
237
|
+
#### Using the read_with_http_info variant
|
|
238
|
+
|
|
239
|
+
This returns an Array which contains the response data, status code and headers.
|
|
240
|
+
|
|
241
|
+
> <Array(<RepositoryVersionResponse>, Integer, Hash)> read_with_http_info(npm_npm_repository_version_href, opts)
|
|
242
|
+
|
|
243
|
+
```ruby
|
|
244
|
+
begin
|
|
245
|
+
# Inspect a repository version
|
|
246
|
+
data, status_code, headers = api_instance.read_with_http_info(npm_npm_repository_version_href, opts)
|
|
247
|
+
p status_code # => 2xx
|
|
248
|
+
p headers # => { ... }
|
|
249
|
+
p data # => <RepositoryVersionResponse>
|
|
250
|
+
rescue PulpNpmClient::ApiError => e
|
|
251
|
+
puts "Error when calling RepositoriesNpmVersionsApi->read_with_http_info: #{e}"
|
|
252
|
+
end
|
|
253
|
+
```
|
|
197
254
|
|
|
255
|
+
### Parameters
|
|
198
256
|
|
|
199
|
-
Name | Type | Description
|
|
200
|
-
|
|
201
|
-
**npm_npm_repository_version_href** | **String
|
|
202
|
-
**fields** | **String
|
|
203
|
-
**exclude_fields** | **String
|
|
257
|
+
| Name | Type | Description | Notes |
|
|
258
|
+
| ---- | ---- | ----------- | ----- |
|
|
259
|
+
| **npm_npm_repository_version_href** | **String** | | |
|
|
260
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
|
261
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
|
204
262
|
|
|
205
263
|
### Return type
|
|
206
264
|
|
|
@@ -218,16 +276,16 @@ Name | Type | Description | Notes
|
|
|
218
276
|
|
|
219
277
|
## repair
|
|
220
278
|
|
|
221
|
-
> AsyncOperationResponse repair(npm_npm_repository_version_href, repair)
|
|
279
|
+
> <AsyncOperationResponse> repair(npm_npm_repository_version_href, repair)
|
|
222
280
|
|
|
223
281
|
|
|
224
282
|
|
|
225
283
|
Trigger an asynchronous task to repair a repository version.
|
|
226
284
|
|
|
227
|
-
###
|
|
285
|
+
### Examples
|
|
228
286
|
|
|
229
287
|
```ruby
|
|
230
|
-
|
|
288
|
+
require 'time'
|
|
231
289
|
require 'pulp_npm_client'
|
|
232
290
|
# setup authorization
|
|
233
291
|
PulpNpmClient.configure do |config|
|
|
@@ -241,20 +299,38 @@ npm_npm_repository_version_href = 'npm_npm_repository_version_href_example' # St
|
|
|
241
299
|
repair = PulpNpmClient::Repair.new # Repair |
|
|
242
300
|
|
|
243
301
|
begin
|
|
302
|
+
|
|
244
303
|
result = api_instance.repair(npm_npm_repository_version_href, repair)
|
|
245
304
|
p result
|
|
246
305
|
rescue PulpNpmClient::ApiError => e
|
|
247
|
-
puts "
|
|
306
|
+
puts "Error when calling RepositoriesNpmVersionsApi->repair: #{e}"
|
|
248
307
|
end
|
|
249
308
|
```
|
|
250
309
|
|
|
251
|
-
|
|
310
|
+
#### Using the repair_with_http_info variant
|
|
311
|
+
|
|
312
|
+
This returns an Array which contains the response data, status code and headers.
|
|
313
|
+
|
|
314
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> repair_with_http_info(npm_npm_repository_version_href, repair)
|
|
315
|
+
|
|
316
|
+
```ruby
|
|
317
|
+
begin
|
|
318
|
+
|
|
319
|
+
data, status_code, headers = api_instance.repair_with_http_info(npm_npm_repository_version_href, repair)
|
|
320
|
+
p status_code # => 2xx
|
|
321
|
+
p headers # => { ... }
|
|
322
|
+
p data # => <AsyncOperationResponse>
|
|
323
|
+
rescue PulpNpmClient::ApiError => e
|
|
324
|
+
puts "Error when calling RepositoriesNpmVersionsApi->repair_with_http_info: #{e}"
|
|
325
|
+
end
|
|
326
|
+
```
|
|
252
327
|
|
|
328
|
+
### Parameters
|
|
253
329
|
|
|
254
|
-
Name | Type | Description
|
|
255
|
-
|
|
256
|
-
**npm_npm_repository_version_href** | **String
|
|
257
|
-
**repair** | [**Repair**](Repair.md)| |
|
|
330
|
+
| Name | Type | Description | Notes |
|
|
331
|
+
| ---- | ---- | ----------- | ----- |
|
|
332
|
+
| **npm_npm_repository_version_href** | **String** | | |
|
|
333
|
+
| **repair** | [**Repair**](Repair.md) | | |
|
|
258
334
|
|
|
259
335
|
### Return type
|
|
260
336
|
|
|
@@ -2,20 +2,21 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**add_content_units** |
|
|
8
|
-
**remove_content_units** |
|
|
9
|
-
**base_version** | **String** | A repository version whose content will be used as the initial set of content for the new repository version | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **add_content_units** | **Array<String>** | A list of content units to add to a new repository version. This content is added after remove_content_units are removed. | [optional] |
|
|
8
|
+
| **remove_content_units** | **Array<String>** | A list of content units to remove from the latest repository version. You may also specify '*' as an entry to remove all content. This content is removed before add_content_units are added. | [optional] |
|
|
9
|
+
| **base_version** | **String** | A repository version whose content will be used as the initial set of content for the new repository version | [optional] |
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Example
|
|
12
12
|
|
|
13
13
|
```ruby
|
|
14
|
-
require '
|
|
14
|
+
require 'pulp_npm_client'
|
|
15
15
|
|
|
16
|
-
instance = PulpNpmClient::RepositoryAddRemoveContent.new(
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
instance = PulpNpmClient::RepositoryAddRemoveContent.new(
|
|
17
|
+
add_content_units: null,
|
|
18
|
+
remove_content_units: null,
|
|
19
|
+
base_version: null
|
|
20
|
+
)
|
|
19
21
|
```
|
|
20
22
|
|
|
21
|
-
|
data/docs/RepositorySyncURL.md
CHANGED
|
@@ -2,18 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**remote** | **String** | A remote to sync from. This will override a remote set on repository. | [optional]
|
|
8
|
-
**mirror** | **Boolean** | If ``True``, synchronization will remove all content that is not present in the remote repository. If ``False``, sync will be additive only. | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **remote** | **String** | A remote to sync from. This will override a remote set on repository. | [optional] |
|
|
8
|
+
| **mirror** | **Boolean** | If ``True``, synchronization will remove all content that is not present in the remote repository. If ``False``, sync will be additive only. | [optional][default to false] |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Example
|
|
11
11
|
|
|
12
12
|
```ruby
|
|
13
|
-
require '
|
|
13
|
+
require 'pulp_npm_client'
|
|
14
14
|
|
|
15
|
-
instance = PulpNpmClient::RepositorySyncURL.new(
|
|
16
|
-
|
|
15
|
+
instance = PulpNpmClient::RepositorySyncURL.new(
|
|
16
|
+
remote: null,
|
|
17
|
+
mirror: null
|
|
18
|
+
)
|
|
17
19
|
```
|
|
18
20
|
|
|
19
|
-
|
|
@@ -2,26 +2,31 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**pulp_href** | **String** | | [optional]
|
|
8
|
-
**
|
|
9
|
-
**
|
|
10
|
-
**
|
|
11
|
-
**
|
|
12
|
-
**
|
|
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
|
+
| **number** | **Integer** | | [optional][readonly] |
|
|
12
|
+
| **repository** | **String** | | [optional][readonly] |
|
|
13
|
+
| **base_version** | **String** | A repository version whose content was used as the initial set of content for this repository version | [optional] |
|
|
14
|
+
| **content_summary** | [**ContentSummaryResponse**](ContentSummaryResponse.md) | Various count summaries of the content in the version and the HREF to view them. | [optional][readonly] |
|
|
13
15
|
|
|
14
|
-
##
|
|
16
|
+
## Example
|
|
15
17
|
|
|
16
18
|
```ruby
|
|
17
|
-
require '
|
|
19
|
+
require 'pulp_npm_client'
|
|
18
20
|
|
|
19
|
-
instance = PulpNpmClient::RepositoryVersionResponse.new(
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
21
|
+
instance = PulpNpmClient::RepositoryVersionResponse.new(
|
|
22
|
+
pulp_href: null,
|
|
23
|
+
prn: null,
|
|
24
|
+
pulp_created: null,
|
|
25
|
+
pulp_last_updated: null,
|
|
26
|
+
number: null,
|
|
27
|
+
repository: null,
|
|
28
|
+
base_version: null,
|
|
29
|
+
content_summary: null
|
|
30
|
+
)
|
|
25
31
|
```
|
|
26
32
|
|
|
27
|
-
|
data/docs/SetLabel.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PulpNpmClient::SetLabel
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **key** | **String** | | |
|
|
8
|
+
| **value** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'pulp_npm_client'
|
|
14
|
+
|
|
15
|
+
instance = PulpNpmClient::SetLabel.new(
|
|
16
|
+
key: null,
|
|
17
|
+
value: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PulpNpmClient::SetLabelResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **key** | **String** | | |
|
|
8
|
+
| **value** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'pulp_npm_client'
|
|
14
|
+
|
|
15
|
+
instance = PulpNpmClient::SetLabelResponse.new(
|
|
16
|
+
key: null,
|
|
17
|
+
value: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/UnsetLabel.md
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# PulpNpmClient::UnsetLabel
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **key** | **String** | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'pulp_npm_client'
|
|
13
|
+
|
|
14
|
+
instance = PulpNpmClient::UnsetLabel.new(
|
|
15
|
+
key: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PulpNpmClient::UnsetLabelResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **key** | **String** | | |
|
|
8
|
+
| **value** | **String** | | [optional][readonly] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'pulp_npm_client'
|
|
14
|
+
|
|
15
|
+
instance = PulpNpmClient::UnsetLabelResponse.new(
|
|
16
|
+
key: null,
|
|
17
|
+
value: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|