pulp_npm_client 0.9.0 → 0.10.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 +20 -4
- data/docs/DistributionsNpmApi.md +312 -0
- data/docs/MyPermissionsResponse.md +18 -0
- data/docs/NestedRole.md +22 -0
- data/docs/NestedRoleResponse.md +22 -0
- data/docs/NpmPingApi.md +1 -7
- data/docs/ObjectRolesResponse.md +18 -0
- data/docs/RemotesNpmApi.md +312 -0
- data/docs/RepositoriesNpmApi.md +312 -0
- data/lib/pulp_npm_client/api/distributions_npm_api.rb +298 -0
- data/lib/pulp_npm_client/api/npm_ping_api.rb +1 -1
- data/lib/pulp_npm_client/api/remotes_npm_api.rb +298 -0
- data/lib/pulp_npm_client/api/repositories_npm_api.rb +298 -0
- data/lib/pulp_npm_client/models/my_permissions_response.rb +223 -0
- data/lib/pulp_npm_client/models/nested_role.rb +263 -0
- data/lib/pulp_npm_client/models/nested_role_response.rb +244 -0
- data/lib/pulp_npm_client/models/object_roles_response.rb +223 -0
- data/lib/pulp_npm_client/version.rb +1 -1
- data/lib/pulp_npm_client.rb +4 -0
- data/spec/api/distributions_npm_api_spec.rb +58 -0
- data/spec/api/remotes_npm_api_spec.rb +58 -0
- data/spec/api/repositories_npm_api_spec.rb +58 -0
- data/spec/models/my_permissions_response_spec.rb +36 -0
- data/spec/models/nested_role_response_spec.rb +48 -0
- data/spec/models/nested_role_spec.rb +48 -0
- data/spec/models/object_roles_response_spec.rb +36 -0
- metadata +43 -27
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 49af2eaf9c21b816f014004ca8c6bfe25ed0c5d5a6f759708d7ada181a8256e2
|
|
4
|
+
data.tar.gz: d403e758c9182d0a15fbc476684224322ca1b39025679b4ec782810843cbeeb5
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6d81c078a7c0112acfd63ce1f76a9419964229a734fcf69f469c2eef9ea452b67c845011ab0748c81c85a6fc4f49b3b0fa52d310746b86c8204ce98b686d71f4
|
|
7
|
+
data.tar.gz: 467312c152d7b478a9c5d69633cb2f0912a6495f826f3d739305f209522ffb68326fe5134360c6e0ca1386f3c3b2d6384c93d0781cbdd8294e8451565dd73a6b
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Fetch, Upload, Organize, and Distribute Software Packages
|
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
9
|
- API version: v3
|
|
10
|
-
- Package version: 0.
|
|
10
|
+
- Package version: 0.10.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.
|
|
28
|
+
gem install ./pulp_npm_client-0.10.0.gem
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
(for development, run `gem install --dev ./pulp_npm_client-0.
|
|
31
|
+
(for development, run `gem install --dev ./pulp_npm_client-0.10.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.
|
|
37
|
+
gem 'pulp_npm_client', '~> 0.10.0'
|
|
38
38
|
|
|
39
39
|
### Install from Git
|
|
40
40
|
|
|
@@ -105,31 +105,43 @@ Class | Method | HTTP request | Description
|
|
|
105
105
|
*PulpNpmClient::ContentPackagesApi* | [**set_label**](docs/ContentPackagesApi.md#set_label) | **POST** {npm_package_href}set_label/ | Set a label
|
|
106
106
|
*PulpNpmClient::ContentPackagesApi* | [**unset_label**](docs/ContentPackagesApi.md#unset_label) | **POST** {npm_package_href}unset_label/ | Unset a label
|
|
107
107
|
*PulpNpmClient::ContentPackagesApi* | [**upload**](docs/ContentPackagesApi.md#upload) | **POST** /pulp/api/v3/content/npm/packages/upload/ | Synchronous npm package upload
|
|
108
|
+
*PulpNpmClient::DistributionsNpmApi* | [**add_role**](docs/DistributionsNpmApi.md#add_role) | **POST** {npm_npm_distribution_href}add_role/ | Add a role
|
|
108
109
|
*PulpNpmClient::DistributionsNpmApi* | [**create**](docs/DistributionsNpmApi.md#create) | **POST** /pulp/api/v3/distributions/npm/npm/ | Create a npm distribution
|
|
109
110
|
*PulpNpmClient::DistributionsNpmApi* | [**delete**](docs/DistributionsNpmApi.md#delete) | **DELETE** {npm_npm_distribution_href} | Delete a npm distribution
|
|
110
111
|
*PulpNpmClient::DistributionsNpmApi* | [**list**](docs/DistributionsNpmApi.md#list) | **GET** /pulp/api/v3/distributions/npm/npm/ | List npm distributions
|
|
112
|
+
*PulpNpmClient::DistributionsNpmApi* | [**list_roles**](docs/DistributionsNpmApi.md#list_roles) | **GET** {npm_npm_distribution_href}list_roles/ | List roles
|
|
113
|
+
*PulpNpmClient::DistributionsNpmApi* | [**my_permissions**](docs/DistributionsNpmApi.md#my_permissions) | **GET** {npm_npm_distribution_href}my_permissions/ | List user permissions
|
|
111
114
|
*PulpNpmClient::DistributionsNpmApi* | [**partial_update**](docs/DistributionsNpmApi.md#partial_update) | **PATCH** {npm_npm_distribution_href} | Update a npm distribution
|
|
112
115
|
*PulpNpmClient::DistributionsNpmApi* | [**read**](docs/DistributionsNpmApi.md#read) | **GET** {npm_npm_distribution_href} | Inspect a npm distribution
|
|
116
|
+
*PulpNpmClient::DistributionsNpmApi* | [**remove_role**](docs/DistributionsNpmApi.md#remove_role) | **POST** {npm_npm_distribution_href}remove_role/ | Remove a role
|
|
113
117
|
*PulpNpmClient::DistributionsNpmApi* | [**set_label**](docs/DistributionsNpmApi.md#set_label) | **POST** {npm_npm_distribution_href}set_label/ | Set a label
|
|
114
118
|
*PulpNpmClient::DistributionsNpmApi* | [**unset_label**](docs/DistributionsNpmApi.md#unset_label) | **POST** {npm_npm_distribution_href}unset_label/ | Unset a label
|
|
115
119
|
*PulpNpmClient::DistributionsNpmApi* | [**update**](docs/DistributionsNpmApi.md#update) | **PUT** {npm_npm_distribution_href} | Update a npm distribution
|
|
116
120
|
*PulpNpmClient::NpmApi* | [**put**](docs/NpmApi.md#put) | **PUT** /npm/{path}/{package_name} |
|
|
117
121
|
*PulpNpmClient::NpmPingApi* | [**get**](docs/NpmPingApi.md#get) | **GET** /npm/{path}/-/ping |
|
|
118
122
|
*PulpNpmClient::NpmWhoamiApi* | [**get**](docs/NpmWhoamiApi.md#get) | **GET** /npm/{path}/-/whoami |
|
|
123
|
+
*PulpNpmClient::RemotesNpmApi* | [**add_role**](docs/RemotesNpmApi.md#add_role) | **POST** {npm_npm_remote_href}add_role/ | Add a role
|
|
119
124
|
*PulpNpmClient::RemotesNpmApi* | [**create**](docs/RemotesNpmApi.md#create) | **POST** /pulp/api/v3/remotes/npm/npm/ | Create a npm remote
|
|
120
125
|
*PulpNpmClient::RemotesNpmApi* | [**delete**](docs/RemotesNpmApi.md#delete) | **DELETE** {npm_npm_remote_href} | Delete a npm remote
|
|
121
126
|
*PulpNpmClient::RemotesNpmApi* | [**list**](docs/RemotesNpmApi.md#list) | **GET** /pulp/api/v3/remotes/npm/npm/ | List npm remotes
|
|
127
|
+
*PulpNpmClient::RemotesNpmApi* | [**list_roles**](docs/RemotesNpmApi.md#list_roles) | **GET** {npm_npm_remote_href}list_roles/ | List roles
|
|
128
|
+
*PulpNpmClient::RemotesNpmApi* | [**my_permissions**](docs/RemotesNpmApi.md#my_permissions) | **GET** {npm_npm_remote_href}my_permissions/ | List user permissions
|
|
122
129
|
*PulpNpmClient::RemotesNpmApi* | [**partial_update**](docs/RemotesNpmApi.md#partial_update) | **PATCH** {npm_npm_remote_href} | Update a npm remote
|
|
123
130
|
*PulpNpmClient::RemotesNpmApi* | [**read**](docs/RemotesNpmApi.md#read) | **GET** {npm_npm_remote_href} | Inspect a npm remote
|
|
131
|
+
*PulpNpmClient::RemotesNpmApi* | [**remove_role**](docs/RemotesNpmApi.md#remove_role) | **POST** {npm_npm_remote_href}remove_role/ | Remove a role
|
|
124
132
|
*PulpNpmClient::RemotesNpmApi* | [**set_label**](docs/RemotesNpmApi.md#set_label) | **POST** {npm_npm_remote_href}set_label/ | Set a label
|
|
125
133
|
*PulpNpmClient::RemotesNpmApi* | [**unset_label**](docs/RemotesNpmApi.md#unset_label) | **POST** {npm_npm_remote_href}unset_label/ | Unset a label
|
|
126
134
|
*PulpNpmClient::RemotesNpmApi* | [**update**](docs/RemotesNpmApi.md#update) | **PUT** {npm_npm_remote_href} | Update a npm remote
|
|
135
|
+
*PulpNpmClient::RepositoriesNpmApi* | [**add_role**](docs/RepositoriesNpmApi.md#add_role) | **POST** {npm_npm_repository_href}add_role/ | Add a role
|
|
127
136
|
*PulpNpmClient::RepositoriesNpmApi* | [**create**](docs/RepositoriesNpmApi.md#create) | **POST** /pulp/api/v3/repositories/npm/npm/ | Create a npm repository
|
|
128
137
|
*PulpNpmClient::RepositoriesNpmApi* | [**delete**](docs/RepositoriesNpmApi.md#delete) | **DELETE** {npm_npm_repository_href} | Delete a npm repository
|
|
129
138
|
*PulpNpmClient::RepositoriesNpmApi* | [**list**](docs/RepositoriesNpmApi.md#list) | **GET** /pulp/api/v3/repositories/npm/npm/ | List npm repositorys
|
|
139
|
+
*PulpNpmClient::RepositoriesNpmApi* | [**list_roles**](docs/RepositoriesNpmApi.md#list_roles) | **GET** {npm_npm_repository_href}list_roles/ | List roles
|
|
130
140
|
*PulpNpmClient::RepositoriesNpmApi* | [**modify**](docs/RepositoriesNpmApi.md#modify) | **POST** {npm_npm_repository_href}modify/ | Modify Repository Content
|
|
141
|
+
*PulpNpmClient::RepositoriesNpmApi* | [**my_permissions**](docs/RepositoriesNpmApi.md#my_permissions) | **GET** {npm_npm_repository_href}my_permissions/ | List user permissions
|
|
131
142
|
*PulpNpmClient::RepositoriesNpmApi* | [**partial_update**](docs/RepositoriesNpmApi.md#partial_update) | **PATCH** {npm_npm_repository_href} | Update a npm repository
|
|
132
143
|
*PulpNpmClient::RepositoriesNpmApi* | [**read**](docs/RepositoriesNpmApi.md#read) | **GET** {npm_npm_repository_href} | Inspect a npm repository
|
|
144
|
+
*PulpNpmClient::RepositoriesNpmApi* | [**remove_role**](docs/RepositoriesNpmApi.md#remove_role) | **POST** {npm_npm_repository_href}remove_role/ | Remove a role
|
|
133
145
|
*PulpNpmClient::RepositoriesNpmApi* | [**set_label**](docs/RepositoriesNpmApi.md#set_label) | **POST** {npm_npm_repository_href}set_label/ | Set a label
|
|
134
146
|
*PulpNpmClient::RepositoriesNpmApi* | [**sync**](docs/RepositoriesNpmApi.md#sync) | **POST** {npm_npm_repository_href}sync/ | Sync from remote
|
|
135
147
|
*PulpNpmClient::RepositoriesNpmApi* | [**unset_label**](docs/RepositoriesNpmApi.md#unset_label) | **POST** {npm_npm_repository_href}unset_label/ | Unset a label
|
|
@@ -144,6 +156,9 @@ Class | Method | HTTP request | Description
|
|
|
144
156
|
|
|
145
157
|
- [PulpNpmClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
|
|
146
158
|
- [PulpNpmClient::ContentSummaryResponse](docs/ContentSummaryResponse.md)
|
|
159
|
+
- [PulpNpmClient::MyPermissionsResponse](docs/MyPermissionsResponse.md)
|
|
160
|
+
- [PulpNpmClient::NestedRole](docs/NestedRole.md)
|
|
161
|
+
- [PulpNpmClient::NestedRoleResponse](docs/NestedRoleResponse.md)
|
|
147
162
|
- [PulpNpmClient::NpmNpmDistribution](docs/NpmNpmDistribution.md)
|
|
148
163
|
- [PulpNpmClient::NpmNpmDistributionResponse](docs/NpmNpmDistributionResponse.md)
|
|
149
164
|
- [PulpNpmClient::NpmNpmRemote](docs/NpmNpmRemote.md)
|
|
@@ -152,6 +167,7 @@ Class | Method | HTTP request | Description
|
|
|
152
167
|
- [PulpNpmClient::NpmNpmRepository](docs/NpmNpmRepository.md)
|
|
153
168
|
- [PulpNpmClient::NpmNpmRepositoryResponse](docs/NpmNpmRepositoryResponse.md)
|
|
154
169
|
- [PulpNpmClient::NpmPackageResponse](docs/NpmPackageResponse.md)
|
|
170
|
+
- [PulpNpmClient::ObjectRolesResponse](docs/ObjectRolesResponse.md)
|
|
155
171
|
- [PulpNpmClient::PaginatedRepositoryVersionResponseList](docs/PaginatedRepositoryVersionResponseList.md)
|
|
156
172
|
- [PulpNpmClient::PaginatednpmNpmDistributionResponseList](docs/PaginatednpmNpmDistributionResponseList.md)
|
|
157
173
|
- [PulpNpmClient::PaginatednpmNpmRemoteResponseList](docs/PaginatednpmNpmRemoteResponseList.md)
|
data/docs/DistributionsNpmApi.md
CHANGED
|
@@ -4,16 +4,96 @@ All URIs are relative to *http://localhost:24817*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**add_role**](DistributionsNpmApi.md#add_role) | **POST** {npm_npm_distribution_href}add_role/ | Add a role |
|
|
7
8
|
| [**create**](DistributionsNpmApi.md#create) | **POST** /pulp/api/v3/distributions/npm/npm/ | Create a npm distribution |
|
|
8
9
|
| [**delete**](DistributionsNpmApi.md#delete) | **DELETE** {npm_npm_distribution_href} | Delete a npm distribution |
|
|
9
10
|
| [**list**](DistributionsNpmApi.md#list) | **GET** /pulp/api/v3/distributions/npm/npm/ | List npm distributions |
|
|
11
|
+
| [**list_roles**](DistributionsNpmApi.md#list_roles) | **GET** {npm_npm_distribution_href}list_roles/ | List roles |
|
|
12
|
+
| [**my_permissions**](DistributionsNpmApi.md#my_permissions) | **GET** {npm_npm_distribution_href}my_permissions/ | List user permissions |
|
|
10
13
|
| [**partial_update**](DistributionsNpmApi.md#partial_update) | **PATCH** {npm_npm_distribution_href} | Update a npm distribution |
|
|
11
14
|
| [**read**](DistributionsNpmApi.md#read) | **GET** {npm_npm_distribution_href} | Inspect a npm distribution |
|
|
15
|
+
| [**remove_role**](DistributionsNpmApi.md#remove_role) | **POST** {npm_npm_distribution_href}remove_role/ | Remove a role |
|
|
12
16
|
| [**set_label**](DistributionsNpmApi.md#set_label) | **POST** {npm_npm_distribution_href}set_label/ | Set a label |
|
|
13
17
|
| [**unset_label**](DistributionsNpmApi.md#unset_label) | **POST** {npm_npm_distribution_href}unset_label/ | Unset a label |
|
|
14
18
|
| [**update**](DistributionsNpmApi.md#update) | **PUT** {npm_npm_distribution_href} | Update a npm distribution |
|
|
15
19
|
|
|
16
20
|
|
|
21
|
+
## add_role
|
|
22
|
+
|
|
23
|
+
> <NestedRoleResponse> add_role(npm_npm_distribution_href, nested_role, opts)
|
|
24
|
+
|
|
25
|
+
Add a role
|
|
26
|
+
|
|
27
|
+
Add a role for this object to users/groups.
|
|
28
|
+
|
|
29
|
+
### Examples
|
|
30
|
+
|
|
31
|
+
```ruby
|
|
32
|
+
require 'time'
|
|
33
|
+
require 'pulp_npm_client'
|
|
34
|
+
# setup authorization
|
|
35
|
+
PulpNpmClient.configure do |config|
|
|
36
|
+
# Configure HTTP basic authorization: basicAuth
|
|
37
|
+
config.username = 'YOUR USERNAME'
|
|
38
|
+
config.password = 'YOUR PASSWORD'
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
api_instance = PulpNpmClient::DistributionsNpmApi.new
|
|
42
|
+
npm_npm_distribution_href = 'npm_npm_distribution_href_example' # String |
|
|
43
|
+
nested_role = PulpNpmClient::NestedRole.new({role: 'role_example'}) # NestedRole |
|
|
44
|
+
opts = {
|
|
45
|
+
x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
begin
|
|
49
|
+
# Add a role
|
|
50
|
+
result = api_instance.add_role(npm_npm_distribution_href, nested_role, opts)
|
|
51
|
+
p result
|
|
52
|
+
rescue PulpNpmClient::ApiError => e
|
|
53
|
+
puts "Error when calling DistributionsNpmApi->add_role: #{e}"
|
|
54
|
+
end
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
#### Using the add_role_with_http_info variant
|
|
58
|
+
|
|
59
|
+
This returns an Array which contains the response data, status code and headers.
|
|
60
|
+
|
|
61
|
+
> <Array(<NestedRoleResponse>, Integer, Hash)> add_role_with_http_info(npm_npm_distribution_href, nested_role, opts)
|
|
62
|
+
|
|
63
|
+
```ruby
|
|
64
|
+
begin
|
|
65
|
+
# Add a role
|
|
66
|
+
data, status_code, headers = api_instance.add_role_with_http_info(npm_npm_distribution_href, nested_role, opts)
|
|
67
|
+
p status_code # => 2xx
|
|
68
|
+
p headers # => { ... }
|
|
69
|
+
p data # => <NestedRoleResponse>
|
|
70
|
+
rescue PulpNpmClient::ApiError => e
|
|
71
|
+
puts "Error when calling DistributionsNpmApi->add_role_with_http_info: #{e}"
|
|
72
|
+
end
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Parameters
|
|
76
|
+
|
|
77
|
+
| Name | Type | Description | Notes |
|
|
78
|
+
| ---- | ---- | ----------- | ----- |
|
|
79
|
+
| **npm_npm_distribution_href** | **String** | | |
|
|
80
|
+
| **nested_role** | [**NestedRole**](NestedRole.md) | | |
|
|
81
|
+
| **x_task_diagnostics** | [**Array<String>**](String.md) | List of profilers to use on tasks. | [optional] |
|
|
82
|
+
|
|
83
|
+
### Return type
|
|
84
|
+
|
|
85
|
+
[**NestedRoleResponse**](NestedRoleResponse.md)
|
|
86
|
+
|
|
87
|
+
### Authorization
|
|
88
|
+
|
|
89
|
+
[basicAuth](../README.md#basicAuth)
|
|
90
|
+
|
|
91
|
+
### HTTP request headers
|
|
92
|
+
|
|
93
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
94
|
+
- **Accept**: application/json
|
|
95
|
+
|
|
96
|
+
|
|
17
97
|
## create
|
|
18
98
|
|
|
19
99
|
> <AsyncOperationResponse> create(npm_npm_distribution, opts)
|
|
@@ -288,6 +368,162 @@ end
|
|
|
288
368
|
- **Accept**: application/json
|
|
289
369
|
|
|
290
370
|
|
|
371
|
+
## list_roles
|
|
372
|
+
|
|
373
|
+
> <ObjectRolesResponse> list_roles(npm_npm_distribution_href, opts)
|
|
374
|
+
|
|
375
|
+
List roles
|
|
376
|
+
|
|
377
|
+
List roles assigned to this object.
|
|
378
|
+
|
|
379
|
+
### Examples
|
|
380
|
+
|
|
381
|
+
```ruby
|
|
382
|
+
require 'time'
|
|
383
|
+
require 'pulp_npm_client'
|
|
384
|
+
# setup authorization
|
|
385
|
+
PulpNpmClient.configure do |config|
|
|
386
|
+
# Configure HTTP basic authorization: basicAuth
|
|
387
|
+
config.username = 'YOUR USERNAME'
|
|
388
|
+
config.password = 'YOUR PASSWORD'
|
|
389
|
+
end
|
|
390
|
+
|
|
391
|
+
api_instance = PulpNpmClient::DistributionsNpmApi.new
|
|
392
|
+
npm_npm_distribution_href = 'npm_npm_distribution_href_example' # String |
|
|
393
|
+
opts = {
|
|
394
|
+
x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
|
|
395
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
|
396
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
begin
|
|
400
|
+
# List roles
|
|
401
|
+
result = api_instance.list_roles(npm_npm_distribution_href, opts)
|
|
402
|
+
p result
|
|
403
|
+
rescue PulpNpmClient::ApiError => e
|
|
404
|
+
puts "Error when calling DistributionsNpmApi->list_roles: #{e}"
|
|
405
|
+
end
|
|
406
|
+
```
|
|
407
|
+
|
|
408
|
+
#### Using the list_roles_with_http_info variant
|
|
409
|
+
|
|
410
|
+
This returns an Array which contains the response data, status code and headers.
|
|
411
|
+
|
|
412
|
+
> <Array(<ObjectRolesResponse>, Integer, Hash)> list_roles_with_http_info(npm_npm_distribution_href, opts)
|
|
413
|
+
|
|
414
|
+
```ruby
|
|
415
|
+
begin
|
|
416
|
+
# List roles
|
|
417
|
+
data, status_code, headers = api_instance.list_roles_with_http_info(npm_npm_distribution_href, opts)
|
|
418
|
+
p status_code # => 2xx
|
|
419
|
+
p headers # => { ... }
|
|
420
|
+
p data # => <ObjectRolesResponse>
|
|
421
|
+
rescue PulpNpmClient::ApiError => e
|
|
422
|
+
puts "Error when calling DistributionsNpmApi->list_roles_with_http_info: #{e}"
|
|
423
|
+
end
|
|
424
|
+
```
|
|
425
|
+
|
|
426
|
+
### Parameters
|
|
427
|
+
|
|
428
|
+
| Name | Type | Description | Notes |
|
|
429
|
+
| ---- | ---- | ----------- | ----- |
|
|
430
|
+
| **npm_npm_distribution_href** | **String** | | |
|
|
431
|
+
| **x_task_diagnostics** | [**Array<String>**](String.md) | List of profilers to use on tasks. | [optional] |
|
|
432
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
|
433
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
|
434
|
+
|
|
435
|
+
### Return type
|
|
436
|
+
|
|
437
|
+
[**ObjectRolesResponse**](ObjectRolesResponse.md)
|
|
438
|
+
|
|
439
|
+
### Authorization
|
|
440
|
+
|
|
441
|
+
[basicAuth](../README.md#basicAuth)
|
|
442
|
+
|
|
443
|
+
### HTTP request headers
|
|
444
|
+
|
|
445
|
+
- **Content-Type**: Not defined
|
|
446
|
+
- **Accept**: application/json
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
## my_permissions
|
|
450
|
+
|
|
451
|
+
> <MyPermissionsResponse> my_permissions(npm_npm_distribution_href, opts)
|
|
452
|
+
|
|
453
|
+
List user permissions
|
|
454
|
+
|
|
455
|
+
List permissions available to the current user on this object.
|
|
456
|
+
|
|
457
|
+
### Examples
|
|
458
|
+
|
|
459
|
+
```ruby
|
|
460
|
+
require 'time'
|
|
461
|
+
require 'pulp_npm_client'
|
|
462
|
+
# setup authorization
|
|
463
|
+
PulpNpmClient.configure do |config|
|
|
464
|
+
# Configure HTTP basic authorization: basicAuth
|
|
465
|
+
config.username = 'YOUR USERNAME'
|
|
466
|
+
config.password = 'YOUR PASSWORD'
|
|
467
|
+
end
|
|
468
|
+
|
|
469
|
+
api_instance = PulpNpmClient::DistributionsNpmApi.new
|
|
470
|
+
npm_npm_distribution_href = 'npm_npm_distribution_href_example' # String |
|
|
471
|
+
opts = {
|
|
472
|
+
x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
|
|
473
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
|
474
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
|
475
|
+
}
|
|
476
|
+
|
|
477
|
+
begin
|
|
478
|
+
# List user permissions
|
|
479
|
+
result = api_instance.my_permissions(npm_npm_distribution_href, opts)
|
|
480
|
+
p result
|
|
481
|
+
rescue PulpNpmClient::ApiError => e
|
|
482
|
+
puts "Error when calling DistributionsNpmApi->my_permissions: #{e}"
|
|
483
|
+
end
|
|
484
|
+
```
|
|
485
|
+
|
|
486
|
+
#### Using the my_permissions_with_http_info variant
|
|
487
|
+
|
|
488
|
+
This returns an Array which contains the response data, status code and headers.
|
|
489
|
+
|
|
490
|
+
> <Array(<MyPermissionsResponse>, Integer, Hash)> my_permissions_with_http_info(npm_npm_distribution_href, opts)
|
|
491
|
+
|
|
492
|
+
```ruby
|
|
493
|
+
begin
|
|
494
|
+
# List user permissions
|
|
495
|
+
data, status_code, headers = api_instance.my_permissions_with_http_info(npm_npm_distribution_href, opts)
|
|
496
|
+
p status_code # => 2xx
|
|
497
|
+
p headers # => { ... }
|
|
498
|
+
p data # => <MyPermissionsResponse>
|
|
499
|
+
rescue PulpNpmClient::ApiError => e
|
|
500
|
+
puts "Error when calling DistributionsNpmApi->my_permissions_with_http_info: #{e}"
|
|
501
|
+
end
|
|
502
|
+
```
|
|
503
|
+
|
|
504
|
+
### Parameters
|
|
505
|
+
|
|
506
|
+
| Name | Type | Description | Notes |
|
|
507
|
+
| ---- | ---- | ----------- | ----- |
|
|
508
|
+
| **npm_npm_distribution_href** | **String** | | |
|
|
509
|
+
| **x_task_diagnostics** | [**Array<String>**](String.md) | List of profilers to use on tasks. | [optional] |
|
|
510
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
|
511
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
|
512
|
+
|
|
513
|
+
### Return type
|
|
514
|
+
|
|
515
|
+
[**MyPermissionsResponse**](MyPermissionsResponse.md)
|
|
516
|
+
|
|
517
|
+
### Authorization
|
|
518
|
+
|
|
519
|
+
[basicAuth](../README.md#basicAuth)
|
|
520
|
+
|
|
521
|
+
### HTTP request headers
|
|
522
|
+
|
|
523
|
+
- **Content-Type**: Not defined
|
|
524
|
+
- **Accept**: application/json
|
|
525
|
+
|
|
526
|
+
|
|
291
527
|
## partial_update
|
|
292
528
|
|
|
293
529
|
> <NpmNpmDistributionResponse> partial_update(npm_npm_distribution_href, patchednpm_npm_distribution, opts)
|
|
@@ -442,6 +678,82 @@ end
|
|
|
442
678
|
- **Accept**: application/json
|
|
443
679
|
|
|
444
680
|
|
|
681
|
+
## remove_role
|
|
682
|
+
|
|
683
|
+
> <NestedRoleResponse> remove_role(npm_npm_distribution_href, nested_role, opts)
|
|
684
|
+
|
|
685
|
+
Remove a role
|
|
686
|
+
|
|
687
|
+
Remove a role for this object from users/groups.
|
|
688
|
+
|
|
689
|
+
### Examples
|
|
690
|
+
|
|
691
|
+
```ruby
|
|
692
|
+
require 'time'
|
|
693
|
+
require 'pulp_npm_client'
|
|
694
|
+
# setup authorization
|
|
695
|
+
PulpNpmClient.configure do |config|
|
|
696
|
+
# Configure HTTP basic authorization: basicAuth
|
|
697
|
+
config.username = 'YOUR USERNAME'
|
|
698
|
+
config.password = 'YOUR PASSWORD'
|
|
699
|
+
end
|
|
700
|
+
|
|
701
|
+
api_instance = PulpNpmClient::DistributionsNpmApi.new
|
|
702
|
+
npm_npm_distribution_href = 'npm_npm_distribution_href_example' # String |
|
|
703
|
+
nested_role = PulpNpmClient::NestedRole.new({role: 'role_example'}) # NestedRole |
|
|
704
|
+
opts = {
|
|
705
|
+
x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
|
|
706
|
+
}
|
|
707
|
+
|
|
708
|
+
begin
|
|
709
|
+
# Remove a role
|
|
710
|
+
result = api_instance.remove_role(npm_npm_distribution_href, nested_role, opts)
|
|
711
|
+
p result
|
|
712
|
+
rescue PulpNpmClient::ApiError => e
|
|
713
|
+
puts "Error when calling DistributionsNpmApi->remove_role: #{e}"
|
|
714
|
+
end
|
|
715
|
+
```
|
|
716
|
+
|
|
717
|
+
#### Using the remove_role_with_http_info variant
|
|
718
|
+
|
|
719
|
+
This returns an Array which contains the response data, status code and headers.
|
|
720
|
+
|
|
721
|
+
> <Array(<NestedRoleResponse>, Integer, Hash)> remove_role_with_http_info(npm_npm_distribution_href, nested_role, opts)
|
|
722
|
+
|
|
723
|
+
```ruby
|
|
724
|
+
begin
|
|
725
|
+
# Remove a role
|
|
726
|
+
data, status_code, headers = api_instance.remove_role_with_http_info(npm_npm_distribution_href, nested_role, opts)
|
|
727
|
+
p status_code # => 2xx
|
|
728
|
+
p headers # => { ... }
|
|
729
|
+
p data # => <NestedRoleResponse>
|
|
730
|
+
rescue PulpNpmClient::ApiError => e
|
|
731
|
+
puts "Error when calling DistributionsNpmApi->remove_role_with_http_info: #{e}"
|
|
732
|
+
end
|
|
733
|
+
```
|
|
734
|
+
|
|
735
|
+
### Parameters
|
|
736
|
+
|
|
737
|
+
| Name | Type | Description | Notes |
|
|
738
|
+
| ---- | ---- | ----------- | ----- |
|
|
739
|
+
| **npm_npm_distribution_href** | **String** | | |
|
|
740
|
+
| **nested_role** | [**NestedRole**](NestedRole.md) | | |
|
|
741
|
+
| **x_task_diagnostics** | [**Array<String>**](String.md) | List of profilers to use on tasks. | [optional] |
|
|
742
|
+
|
|
743
|
+
### Return type
|
|
744
|
+
|
|
745
|
+
[**NestedRoleResponse**](NestedRoleResponse.md)
|
|
746
|
+
|
|
747
|
+
### Authorization
|
|
748
|
+
|
|
749
|
+
[basicAuth](../README.md#basicAuth)
|
|
750
|
+
|
|
751
|
+
### HTTP request headers
|
|
752
|
+
|
|
753
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
754
|
+
- **Accept**: application/json
|
|
755
|
+
|
|
756
|
+
|
|
445
757
|
## set_label
|
|
446
758
|
|
|
447
759
|
> <SetLabelResponse> set_label(npm_npm_distribution_href, set_label, opts)
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# PulpNpmClient::MyPermissionsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **permissions** | **Array<String>** | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'pulp_npm_client'
|
|
13
|
+
|
|
14
|
+
instance = PulpNpmClient::MyPermissionsResponse.new(
|
|
15
|
+
permissions: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/NestedRole.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# PulpNpmClient::NestedRole
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **users** | **Array<String>** | | [optional] |
|
|
8
|
+
| **groups** | **Array<String>** | | [optional] |
|
|
9
|
+
| **role** | **String** | | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'pulp_npm_client'
|
|
15
|
+
|
|
16
|
+
instance = PulpNpmClient::NestedRole.new(
|
|
17
|
+
users: null,
|
|
18
|
+
groups: null,
|
|
19
|
+
role: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# PulpNpmClient::NestedRoleResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **users** | **Array<String>** | | [optional] |
|
|
8
|
+
| **groups** | **Array<String>** | | [optional] |
|
|
9
|
+
| **role** | **String** | | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'pulp_npm_client'
|
|
15
|
+
|
|
16
|
+
instance = PulpNpmClient::NestedRoleResponse.new(
|
|
17
|
+
users: null,
|
|
18
|
+
groups: null,
|
|
19
|
+
role: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/NpmPingApi.md
CHANGED
|
@@ -20,12 +20,6 @@ Handle ``GET /-/ping`` -- registry health check.
|
|
|
20
20
|
```ruby
|
|
21
21
|
require 'time'
|
|
22
22
|
require 'pulp_npm_client'
|
|
23
|
-
# setup authorization
|
|
24
|
-
PulpNpmClient.configure do |config|
|
|
25
|
-
# Configure HTTP basic authorization: basicAuth
|
|
26
|
-
config.username = 'YOUR USERNAME'
|
|
27
|
-
config.password = 'YOUR PASSWORD'
|
|
28
|
-
end
|
|
29
23
|
|
|
30
24
|
api_instance = PulpNpmClient::NpmPingApi.new
|
|
31
25
|
path = 'path_example' # String |
|
|
@@ -76,7 +70,7 @@ nil (empty response body)
|
|
|
76
70
|
|
|
77
71
|
### Authorization
|
|
78
72
|
|
|
79
|
-
|
|
73
|
+
No authorization required
|
|
80
74
|
|
|
81
75
|
### HTTP request headers
|
|
82
76
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# PulpNpmClient::ObjectRolesResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **roles** | [**Array<NestedRoleResponse>**](NestedRoleResponse.md) | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'pulp_npm_client'
|
|
13
|
+
|
|
14
|
+
instance = PulpNpmClient::ObjectRolesResponse.new(
|
|
15
|
+
roles: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|