pulp_npm_client 0.1.0a1.dev01595640515 → 0.1.0a1.dev01595986114
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of pulp_npm_client might be problematic. Click here for more details.
- checksums.yaml +4 -4
- data/README.md +42 -32
- data/docs/ContentPackagesApi.md +33 -36
- data/docs/ContentSummary.md +3 -3
- data/docs/ContentSummaryResponse.md +21 -0
- data/docs/DistributionsNpmApi.md +113 -71
- data/docs/InlineResponse200.md +3 -3
- data/docs/InlineResponse2001.md +3 -3
- data/docs/InlineResponse2002.md +3 -3
- data/docs/InlineResponse2003.md +3 -3
- data/docs/InlineResponse2004.md +3 -3
- data/docs/NpmNpmDistribution.md +1 -7
- data/docs/NpmNpmDistributionResponse.md +31 -0
- data/docs/NpmNpmRemote.md +4 -10
- data/docs/NpmNpmRemoteResponse.md +43 -0
- data/docs/NpmNpmRepository.md +4 -10
- data/docs/NpmNpmRepositoryResponse.md +29 -0
- data/docs/NpmPackage.md +5 -5
- data/docs/NpmPackageResponse.md +27 -0
- data/docs/PatchednpmNpmDistribution.md +25 -0
- data/docs/PatchednpmNpmRemote.md +37 -0
- data/docs/PatchednpmNpmRepository.md +21 -0
- data/docs/PolicyEnum.md +16 -0
- data/docs/RemotesNpmApi.md +133 -79
- data/docs/RepositoriesNpmApi.md +103 -85
- data/docs/RepositoriesNpmVersionsApi.md +95 -66
- data/docs/RepositoryAddRemoveContent.md +2 -2
- data/docs/RepositorySyncURL.md +1 -1
- data/docs/RepositoryVersion.md +1 -9
- data/docs/RepositoryVersionResponse.md +25 -0
- data/lib/pulp_npm_client.rb +12 -2
- data/lib/pulp_npm_client/api/content_packages_api.rb +34 -52
- data/lib/pulp_npm_client/api/distributions_npm_api.rb +129 -78
- data/lib/pulp_npm_client/api/remotes_npm_api.rb +163 -94
- data/lib/pulp_npm_client/api/repositories_npm_api.rb +119 -104
- data/lib/pulp_npm_client/api/repositories_npm_versions_api.rb +119 -80
- data/lib/pulp_npm_client/api_client.rb +2 -2
- data/lib/pulp_npm_client/api_error.rb +2 -2
- data/lib/pulp_npm_client/configuration.rb +3 -3
- data/lib/pulp_npm_client/models/async_operation_response.rb +3 -2
- data/lib/pulp_npm_client/models/content_summary.rb +9 -15
- data/lib/pulp_npm_client/models/content_summary_response.rb +240 -0
- data/lib/pulp_npm_client/models/inline_response200.rb +3 -13
- data/lib/pulp_npm_client/models/inline_response2001.rb +3 -13
- data/lib/pulp_npm_client/models/inline_response2002.rb +3 -13
- data/lib/pulp_npm_client/models/inline_response2003.rb +3 -13
- data/lib/pulp_npm_client/models/inline_response2004.rb +3 -13
- data/lib/pulp_npm_client/models/npm_npm_distribution.rb +4 -85
- data/lib/pulp_npm_client/models/npm_npm_distribution_response.rb +290 -0
- data/lib/pulp_npm_client/models/npm_npm_remote.rb +7 -199
- data/lib/pulp_npm_client/models/npm_npm_remote_response.rb +368 -0
- data/lib/pulp_npm_client/models/npm_npm_repository.rb +18 -78
- data/lib/pulp_npm_client/models/npm_npm_repository_response.rb +271 -0
- data/lib/pulp_npm_client/models/npm_package.rb +24 -79
- data/lib/pulp_npm_client/models/npm_package_response.rb +269 -0
- data/lib/pulp_npm_client/models/patchednpm_npm_distribution.rb +251 -0
- data/lib/pulp_npm_client/models/patchednpm_npm_remote.rb +329 -0
- data/lib/pulp_npm_client/models/patchednpm_npm_repository.rb +229 -0
- data/lib/pulp_npm_client/models/policy_enum.rb +37 -0
- data/lib/pulp_npm_client/models/repository_add_remove_content.rb +5 -4
- data/lib/pulp_npm_client/models/repository_sync_url.rb +3 -8
- data/lib/pulp_npm_client/models/repository_version.rb +7 -43
- data/lib/pulp_npm_client/models/repository_version_response.rb +246 -0
- data/lib/pulp_npm_client/version.rb +3 -3
- data/pulp_npm_client.gemspec +4 -4
- data/spec/api/content_packages_api_spec.rb +14 -17
- data/spec/api/distributions_npm_api_spec.rb +38 -23
- data/spec/api/remotes_npm_api_spec.rb +50 -29
- data/spec/api/repositories_npm_api_spec.rb +30 -27
- data/spec/api/repositories_npm_versions_api_spec.rb +38 -26
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/async_operation_response_spec.rb +2 -2
- data/spec/models/content_summary_response_spec.rb +53 -0
- data/spec/models/content_summary_spec.rb +2 -2
- data/spec/models/inline_response2001_spec.rb +2 -2
- data/spec/models/inline_response2002_spec.rb +2 -2
- data/spec/models/inline_response2003_spec.rb +2 -2
- data/spec/models/inline_response2004_spec.rb +2 -2
- data/spec/models/inline_response200_spec.rb +2 -2
- data/spec/models/npm_npm_distribution_response_spec.rb +83 -0
- data/spec/models/npm_npm_distribution_spec.rb +2 -20
- data/spec/models/npm_npm_remote_response_spec.rb +119 -0
- data/spec/models/npm_npm_remote_spec.rb +2 -24
- data/spec/models/npm_npm_repository_response_spec.rb +77 -0
- data/spec/models/npm_npm_repository_spec.rb +5 -23
- data/spec/models/npm_package_response_spec.rb +71 -0
- data/spec/models/npm_package_spec.rb +6 -6
- data/spec/models/patchednpm_npm_distribution_spec.rb +65 -0
- data/spec/models/patchednpm_npm_remote_spec.rb +101 -0
- data/spec/models/patchednpm_npm_repository_spec.rb +53 -0
- data/spec/models/policy_enum_spec.rb +35 -0
- data/spec/models/repository_add_remove_content_spec.rb +2 -2
- data/spec/models/repository_sync_url_spec.rb +2 -2
- data/spec/models/repository_version_response_spec.rb +65 -0
- data/spec/models/repository_version_spec.rb +2 -26
- data/spec/spec_helper.rb +2 -2
- metadata +44 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0d9a395204f9d421b0ca00bf5994283af0d07ca9a93456843edf1206d7f629b8
|
4
|
+
data.tar.gz: 26fdbd0a93c0b80a0a530da65a6bd531039c6a9795d72f1b0fdf21b694b21334
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9b96eb2eef1750836eb93bc8f05148543355b5f7601f10776511d0b12fb78e30cfed095df3386065f2629315065cf5f66f0be7187eb5c07b4b4a3de21cb4c4b6
|
7
|
+
data.tar.gz: a7e033f8d2ea4a25341708fce7b12990129d9f779ab89188611de65c725f424504c689a62e4f5034dff57572db6e390633e157041bb9b77c7795743dcd2c6c22
|
data/README.md
CHANGED
@@ -2,13 +2,14 @@
|
|
2
2
|
|
3
3
|
PulpNpmClient - the Ruby gem for the Pulp 3 API
|
4
4
|
|
5
|
-
|
5
|
+
Fetch, Upload, Organize, and Distribute Software Packages
|
6
6
|
|
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.1.0a1.
|
10
|
+
- Package version: 0.1.0a1.dev01595986114
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
|
+
For more information, please visit [https://pulpproject.org](https://pulpproject.org)
|
12
13
|
|
13
14
|
## Installation
|
14
15
|
|
@@ -23,16 +24,16 @@ gem build pulp_npm_client.gemspec
|
|
23
24
|
Then either install the gem locally:
|
24
25
|
|
25
26
|
```shell
|
26
|
-
gem install ./pulp_npm_client-0.1.0a1.
|
27
|
+
gem install ./pulp_npm_client-0.1.0a1.dev01595986114.gem
|
27
28
|
```
|
28
29
|
|
29
|
-
(for development, run `gem install --dev ./pulp_npm_client-0.1.0a1.
|
30
|
+
(for development, run `gem install --dev ./pulp_npm_client-0.1.0a1.dev01595986114.gem` to install the development dependencies)
|
30
31
|
|
31
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
33
|
|
33
34
|
Finally add this to the Gemfile:
|
34
35
|
|
35
|
-
gem 'pulp_npm_client', '~> 0.1.0a1.
|
36
|
+
gem 'pulp_npm_client', '~> 0.1.0a1.dev01595986114'
|
36
37
|
|
37
38
|
### Install from Git
|
38
39
|
|
@@ -58,7 +59,7 @@ require 'pulp_npm_client'
|
|
58
59
|
|
59
60
|
# Setup authorization
|
60
61
|
PulpNpmClient.configure do |config|
|
61
|
-
# Configure HTTP basic authorization:
|
62
|
+
# Configure HTTP basic authorization: basicAuth
|
62
63
|
config.username = 'YOUR_USERNAME'
|
63
64
|
config.password = 'YOUR_PASSWORD'
|
64
65
|
end
|
@@ -74,7 +75,6 @@ opts = {
|
|
74
75
|
}
|
75
76
|
|
76
77
|
begin
|
77
|
-
#Create a package
|
78
78
|
result = api_instance.create(relative_path, name, version, opts)
|
79
79
|
p result
|
80
80
|
rescue PulpNpmClient::ApiError => e
|
@@ -89,32 +89,32 @@ All URIs are relative to *http://pulp*
|
|
89
89
|
|
90
90
|
Class | Method | HTTP request | Description
|
91
91
|
------------ | ------------- | ------------- | -------------
|
92
|
-
*PulpNpmClient::ContentPackagesApi* | [**create**](docs/ContentPackagesApi.md#create) | **POST** /pulp/api/v3/content/npm/packages/ |
|
93
|
-
*PulpNpmClient::ContentPackagesApi* | [**list**](docs/ContentPackagesApi.md#list) | **GET** /pulp/api/v3/content/npm/packages/ |
|
94
|
-
*PulpNpmClient::ContentPackagesApi* | [**read**](docs/ContentPackagesApi.md#read) | **GET** {package_href} |
|
95
|
-
*PulpNpmClient::DistributionsNpmApi* | [**create**](docs/DistributionsNpmApi.md#create) | **POST** /pulp/api/v3/distributions/npm/npm/ |
|
96
|
-
*PulpNpmClient::DistributionsNpmApi* | [**delete**](docs/DistributionsNpmApi.md#delete) | **DELETE** {npm_distribution_href} |
|
97
|
-
*PulpNpmClient::DistributionsNpmApi* | [**list**](docs/DistributionsNpmApi.md#list) | **GET** /pulp/api/v3/distributions/npm/npm/ |
|
98
|
-
*PulpNpmClient::DistributionsNpmApi* | [**partial_update**](docs/DistributionsNpmApi.md#partial_update) | **PATCH** {npm_distribution_href} |
|
99
|
-
*PulpNpmClient::DistributionsNpmApi* | [**read**](docs/DistributionsNpmApi.md#read) | **GET** {npm_distribution_href} |
|
100
|
-
*PulpNpmClient::DistributionsNpmApi* | [**update**](docs/DistributionsNpmApi.md#update) | **PUT** {npm_distribution_href} |
|
101
|
-
*PulpNpmClient::RemotesNpmApi* | [**create**](docs/RemotesNpmApi.md#create) | **POST** /pulp/api/v3/remotes/npm/npm/ |
|
102
|
-
*PulpNpmClient::RemotesNpmApi* | [**delete**](docs/RemotesNpmApi.md#delete) | **DELETE** {npm_remote_href} |
|
103
|
-
*PulpNpmClient::RemotesNpmApi* | [**list**](docs/RemotesNpmApi.md#list) | **GET** /pulp/api/v3/remotes/npm/npm/ |
|
104
|
-
*PulpNpmClient::RemotesNpmApi* | [**partial_update**](docs/RemotesNpmApi.md#partial_update) | **PATCH** {npm_remote_href} |
|
105
|
-
*PulpNpmClient::RemotesNpmApi* | [**read**](docs/RemotesNpmApi.md#read) | **GET** {npm_remote_href} |
|
106
|
-
*PulpNpmClient::RemotesNpmApi* | [**update**](docs/RemotesNpmApi.md#update) | **PUT** {npm_remote_href} |
|
107
|
-
*PulpNpmClient::RepositoriesNpmApi* | [**create**](docs/RepositoriesNpmApi.md#create) | **POST** /pulp/api/v3/repositories/npm/npm/ |
|
108
|
-
*PulpNpmClient::RepositoriesNpmApi* | [**delete**](docs/RepositoriesNpmApi.md#delete) | **DELETE** {npm_repository_href} |
|
109
|
-
*PulpNpmClient::RepositoriesNpmApi* | [**list**](docs/RepositoriesNpmApi.md#list) | **GET** /pulp/api/v3/repositories/npm/npm/ |
|
92
|
+
*PulpNpmClient::ContentPackagesApi* | [**create**](docs/ContentPackagesApi.md#create) | **POST** /pulp/api/v3/content/npm/packages/ |
|
93
|
+
*PulpNpmClient::ContentPackagesApi* | [**list**](docs/ContentPackagesApi.md#list) | **GET** /pulp/api/v3/content/npm/packages/ |
|
94
|
+
*PulpNpmClient::ContentPackagesApi* | [**read**](docs/ContentPackagesApi.md#read) | **GET** {package_href} |
|
95
|
+
*PulpNpmClient::DistributionsNpmApi* | [**create**](docs/DistributionsNpmApi.md#create) | **POST** /pulp/api/v3/distributions/npm/npm/ |
|
96
|
+
*PulpNpmClient::DistributionsNpmApi* | [**delete**](docs/DistributionsNpmApi.md#delete) | **DELETE** {npm_distribution_href} |
|
97
|
+
*PulpNpmClient::DistributionsNpmApi* | [**list**](docs/DistributionsNpmApi.md#list) | **GET** /pulp/api/v3/distributions/npm/npm/ |
|
98
|
+
*PulpNpmClient::DistributionsNpmApi* | [**partial_update**](docs/DistributionsNpmApi.md#partial_update) | **PATCH** {npm_distribution_href} |
|
99
|
+
*PulpNpmClient::DistributionsNpmApi* | [**read**](docs/DistributionsNpmApi.md#read) | **GET** {npm_distribution_href} |
|
100
|
+
*PulpNpmClient::DistributionsNpmApi* | [**update**](docs/DistributionsNpmApi.md#update) | **PUT** {npm_distribution_href} |
|
101
|
+
*PulpNpmClient::RemotesNpmApi* | [**create**](docs/RemotesNpmApi.md#create) | **POST** /pulp/api/v3/remotes/npm/npm/ |
|
102
|
+
*PulpNpmClient::RemotesNpmApi* | [**delete**](docs/RemotesNpmApi.md#delete) | **DELETE** {npm_remote_href} |
|
103
|
+
*PulpNpmClient::RemotesNpmApi* | [**list**](docs/RemotesNpmApi.md#list) | **GET** /pulp/api/v3/remotes/npm/npm/ |
|
104
|
+
*PulpNpmClient::RemotesNpmApi* | [**partial_update**](docs/RemotesNpmApi.md#partial_update) | **PATCH** {npm_remote_href} |
|
105
|
+
*PulpNpmClient::RemotesNpmApi* | [**read**](docs/RemotesNpmApi.md#read) | **GET** {npm_remote_href} |
|
106
|
+
*PulpNpmClient::RemotesNpmApi* | [**update**](docs/RemotesNpmApi.md#update) | **PUT** {npm_remote_href} |
|
107
|
+
*PulpNpmClient::RepositoriesNpmApi* | [**create**](docs/RepositoriesNpmApi.md#create) | **POST** /pulp/api/v3/repositories/npm/npm/ |
|
108
|
+
*PulpNpmClient::RepositoriesNpmApi* | [**delete**](docs/RepositoriesNpmApi.md#delete) | **DELETE** {npm_repository_href} |
|
109
|
+
*PulpNpmClient::RepositoriesNpmApi* | [**list**](docs/RepositoriesNpmApi.md#list) | **GET** /pulp/api/v3/repositories/npm/npm/ |
|
110
110
|
*PulpNpmClient::RepositoriesNpmApi* | [**modify**](docs/RepositoriesNpmApi.md#modify) | **POST** {npm_repository_href}modify/ | Modify Repository Content
|
111
|
-
*PulpNpmClient::RepositoriesNpmApi* | [**partial_update**](docs/RepositoriesNpmApi.md#partial_update) | **PATCH** {npm_repository_href} |
|
112
|
-
*PulpNpmClient::RepositoriesNpmApi* | [**read**](docs/RepositoriesNpmApi.md#read) | **GET** {npm_repository_href} |
|
111
|
+
*PulpNpmClient::RepositoriesNpmApi* | [**partial_update**](docs/RepositoriesNpmApi.md#partial_update) | **PATCH** {npm_repository_href} |
|
112
|
+
*PulpNpmClient::RepositoriesNpmApi* | [**read**](docs/RepositoriesNpmApi.md#read) | **GET** {npm_repository_href} |
|
113
113
|
*PulpNpmClient::RepositoriesNpmApi* | [**sync**](docs/RepositoriesNpmApi.md#sync) | **POST** {npm_repository_href}sync/ | Sync from remote
|
114
|
-
*PulpNpmClient::RepositoriesNpmApi* | [**update**](docs/RepositoriesNpmApi.md#update) | **PUT** {npm_repository_href} |
|
115
|
-
*PulpNpmClient::RepositoriesNpmVersionsApi* | [**delete**](docs/RepositoriesNpmVersionsApi.md#delete) | **DELETE** {npm_repository_version_href} |
|
116
|
-
*PulpNpmClient::RepositoriesNpmVersionsApi* | [**list**](docs/RepositoriesNpmVersionsApi.md#list) | **GET** {
|
117
|
-
*PulpNpmClient::RepositoriesNpmVersionsApi* | [**read**](docs/RepositoriesNpmVersionsApi.md#read) | **GET** {npm_repository_version_href} |
|
114
|
+
*PulpNpmClient::RepositoriesNpmApi* | [**update**](docs/RepositoriesNpmApi.md#update) | **PUT** {npm_repository_href} |
|
115
|
+
*PulpNpmClient::RepositoriesNpmVersionsApi* | [**delete**](docs/RepositoriesNpmVersionsApi.md#delete) | **DELETE** {npm_repository_version_href} |
|
116
|
+
*PulpNpmClient::RepositoriesNpmVersionsApi* | [**list**](docs/RepositoriesNpmVersionsApi.md#list) | **GET** {npm_repository_version_href}versions/ |
|
117
|
+
*PulpNpmClient::RepositoriesNpmVersionsApi* | [**read**](docs/RepositoriesNpmVersionsApi.md#read) | **GET** {npm_repository_version_href} |
|
118
118
|
*PulpNpmClient::RepositoriesNpmVersionsApi* | [**repair**](docs/RepositoriesNpmVersionsApi.md#repair) | **POST** {npm_repository_version_href}repair/ |
|
119
119
|
|
120
120
|
|
@@ -122,24 +122,34 @@ Class | Method | HTTP request | Description
|
|
122
122
|
|
123
123
|
- [PulpNpmClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
|
124
124
|
- [PulpNpmClient::ContentSummary](docs/ContentSummary.md)
|
125
|
+
- [PulpNpmClient::ContentSummaryResponse](docs/ContentSummaryResponse.md)
|
125
126
|
- [PulpNpmClient::InlineResponse200](docs/InlineResponse200.md)
|
126
127
|
- [PulpNpmClient::InlineResponse2001](docs/InlineResponse2001.md)
|
127
128
|
- [PulpNpmClient::InlineResponse2002](docs/InlineResponse2002.md)
|
128
129
|
- [PulpNpmClient::InlineResponse2003](docs/InlineResponse2003.md)
|
129
130
|
- [PulpNpmClient::InlineResponse2004](docs/InlineResponse2004.md)
|
130
131
|
- [PulpNpmClient::NpmNpmDistribution](docs/NpmNpmDistribution.md)
|
132
|
+
- [PulpNpmClient::NpmNpmDistributionResponse](docs/NpmNpmDistributionResponse.md)
|
131
133
|
- [PulpNpmClient::NpmNpmRemote](docs/NpmNpmRemote.md)
|
134
|
+
- [PulpNpmClient::NpmNpmRemoteResponse](docs/NpmNpmRemoteResponse.md)
|
132
135
|
- [PulpNpmClient::NpmNpmRepository](docs/NpmNpmRepository.md)
|
136
|
+
- [PulpNpmClient::NpmNpmRepositoryResponse](docs/NpmNpmRepositoryResponse.md)
|
133
137
|
- [PulpNpmClient::NpmPackage](docs/NpmPackage.md)
|
138
|
+
- [PulpNpmClient::NpmPackageResponse](docs/NpmPackageResponse.md)
|
139
|
+
- [PulpNpmClient::PatchednpmNpmDistribution](docs/PatchednpmNpmDistribution.md)
|
140
|
+
- [PulpNpmClient::PatchednpmNpmRemote](docs/PatchednpmNpmRemote.md)
|
141
|
+
- [PulpNpmClient::PatchednpmNpmRepository](docs/PatchednpmNpmRepository.md)
|
142
|
+
- [PulpNpmClient::PolicyEnum](docs/PolicyEnum.md)
|
134
143
|
- [PulpNpmClient::RepositoryAddRemoveContent](docs/RepositoryAddRemoveContent.md)
|
135
144
|
- [PulpNpmClient::RepositorySyncURL](docs/RepositorySyncURL.md)
|
136
145
|
- [PulpNpmClient::RepositoryVersion](docs/RepositoryVersion.md)
|
146
|
+
- [PulpNpmClient::RepositoryVersionResponse](docs/RepositoryVersionResponse.md)
|
137
147
|
|
138
148
|
|
139
149
|
## Documentation for Authorization
|
140
150
|
|
141
151
|
|
142
|
-
###
|
152
|
+
### basicAuth
|
143
153
|
|
144
154
|
- **Type**: HTTP basic authentication
|
145
155
|
|
data/docs/ContentPackagesApi.md
CHANGED
@@ -4,19 +4,19 @@ All URIs are relative to *http://pulp*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**create**](ContentPackagesApi.md#create) | **POST** /pulp/api/v3/content/npm/packages/ |
|
8
|
-
[**list**](ContentPackagesApi.md#list) | **GET** /pulp/api/v3/content/npm/packages/ |
|
9
|
-
[**read**](ContentPackagesApi.md#read) | **GET** {package_href} |
|
7
|
+
[**create**](ContentPackagesApi.md#create) | **POST** /pulp/api/v3/content/npm/packages/ |
|
8
|
+
[**list**](ContentPackagesApi.md#list) | **GET** /pulp/api/v3/content/npm/packages/ |
|
9
|
+
[**read**](ContentPackagesApi.md#read) | **GET** {package_href} |
|
10
10
|
|
11
11
|
|
12
12
|
|
13
13
|
## create
|
14
14
|
|
15
|
-
>
|
15
|
+
> NpmPackageResponse create(relative_path, name, version, opts)
|
16
16
|
|
17
|
-
Create a package
|
18
17
|
|
19
|
-
|
18
|
+
|
19
|
+
Perform bookkeeping when saving Content. \"Artifacts\" need to be popped off and saved indpendently, as they are not actually part of the Content model.
|
20
20
|
|
21
21
|
### Example
|
22
22
|
|
@@ -25,7 +25,7 @@ Create a package
|
|
25
25
|
require 'pulp_npm_client'
|
26
26
|
# setup authorization
|
27
27
|
PulpNpmClient.configure do |config|
|
28
|
-
# Configure HTTP basic authorization:
|
28
|
+
# Configure HTTP basic authorization: basicAuth
|
29
29
|
config.username = 'YOUR USERNAME'
|
30
30
|
config.password = 'YOUR PASSWORD'
|
31
31
|
end
|
@@ -41,7 +41,6 @@ opts = {
|
|
41
41
|
}
|
42
42
|
|
43
43
|
begin
|
44
|
-
#Create a package
|
45
44
|
result = api_instance.create(relative_path, name, version, opts)
|
46
45
|
p result
|
47
46
|
rescue PulpNpmClient::ApiError => e
|
@@ -63,11 +62,11 @@ Name | Type | Description | Notes
|
|
63
62
|
|
64
63
|
### Return type
|
65
64
|
|
66
|
-
[**
|
65
|
+
[**NpmPackageResponse**](NpmPackageResponse.md)
|
67
66
|
|
68
67
|
### Authorization
|
69
68
|
|
70
|
-
[
|
69
|
+
[basicAuth](../README.md#basicAuth)
|
71
70
|
|
72
71
|
### HTTP request headers
|
73
72
|
|
@@ -79,9 +78,9 @@ Name | Type | Description | Notes
|
|
79
78
|
|
80
79
|
> InlineResponse200 list(opts)
|
81
80
|
|
82
|
-
List packages
|
83
81
|
|
84
|
-
|
82
|
+
|
83
|
+
A ViewSet for Package. Define endpoint name which will appear in the API endpoint for this content type. For example:: http://pulp.example.com/pulp/api/v3/content/npm/units/ Also specify queryset and serializer for Package.
|
85
84
|
|
86
85
|
### Example
|
87
86
|
|
@@ -90,27 +89,26 @@ Define endpoint name which will appear in the API endpoint for this content type
|
|
90
89
|
require 'pulp_npm_client'
|
91
90
|
# setup authorization
|
92
91
|
PulpNpmClient.configure do |config|
|
93
|
-
# Configure HTTP basic authorization:
|
92
|
+
# Configure HTTP basic authorization: basicAuth
|
94
93
|
config.username = 'YOUR USERNAME'
|
95
94
|
config.password = 'YOUR PASSWORD'
|
96
95
|
end
|
97
96
|
|
98
97
|
api_instance = PulpNpmClient::ContentPackagesApi.new
|
99
98
|
opts = {
|
100
|
-
ordering: 'ordering_example', # String | Which field to use when ordering the results.
|
101
|
-
name: 'name_example', # String | Filter results where name matches value
|
102
|
-
name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
|
103
|
-
repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
|
104
|
-
repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF
|
105
|
-
repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF
|
106
99
|
limit: 56, # Integer | Number of results to return per page.
|
100
|
+
name: 'name_example', # String | name
|
101
|
+
name__in: 'name__in_example', # String | name__in
|
107
102
|
offset: 56, # Integer | The initial index from which to return the results.
|
103
|
+
ordering: 'ordering_example', # String | Which field to use when ordering the results.
|
104
|
+
repository_version: 'repository_version_example', # String | repository_version
|
105
|
+
repository_version_added: 'repository_version_added_example', # String | repository_version_added
|
106
|
+
repository_version_removed: 'repository_version_removed_example', # String | repository_version_removed
|
108
107
|
fields: 'fields_example', # String | A list of fields to include in the response.
|
109
108
|
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
110
109
|
}
|
111
110
|
|
112
111
|
begin
|
113
|
-
#List packages
|
114
112
|
result = api_instance.list(opts)
|
115
113
|
p result
|
116
114
|
rescue PulpNpmClient::ApiError => e
|
@@ -123,14 +121,14 @@ end
|
|
123
121
|
|
124
122
|
Name | Type | Description | Notes
|
125
123
|
------------- | ------------- | ------------- | -------------
|
126
|
-
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
127
|
-
**name** | **String**| Filter results where name matches value | [optional]
|
128
|
-
**name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional]
|
129
|
-
**repository_version** | **String**| Repository Version referenced by HREF | [optional]
|
130
|
-
**repository_version_added** | **String**| Repository Version referenced by HREF | [optional]
|
131
|
-
**repository_version_removed** | **String**| Repository Version referenced by HREF | [optional]
|
132
124
|
**limit** | **Integer**| Number of results to return per page. | [optional]
|
125
|
+
**name** | **String**| name | [optional]
|
126
|
+
**name__in** | **String**| name__in | [optional]
|
133
127
|
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
128
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
129
|
+
**repository_version** | **String**| repository_version | [optional]
|
130
|
+
**repository_version_added** | **String**| repository_version_added | [optional]
|
131
|
+
**repository_version_removed** | **String**| repository_version_removed | [optional]
|
134
132
|
**fields** | **String**| A list of fields to include in the response. | [optional]
|
135
133
|
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
136
134
|
|
@@ -140,7 +138,7 @@ Name | Type | Description | Notes
|
|
140
138
|
|
141
139
|
### Authorization
|
142
140
|
|
143
|
-
[
|
141
|
+
[basicAuth](../README.md#basicAuth)
|
144
142
|
|
145
143
|
### HTTP request headers
|
146
144
|
|
@@ -150,11 +148,11 @@ Name | Type | Description | Notes
|
|
150
148
|
|
151
149
|
## read
|
152
150
|
|
153
|
-
>
|
151
|
+
> NpmPackageResponse read(package_href, opts)
|
152
|
+
|
154
153
|
|
155
|
-
Inspect a package
|
156
154
|
|
157
|
-
Define endpoint name which will appear in the API endpoint for this content type. For example:: http://pulp.example.com/pulp/api/v3/content/npm/units/ Also specify queryset and serializer for Package.
|
155
|
+
A ViewSet for Package. Define endpoint name which will appear in the API endpoint for this content type. For example:: http://pulp.example.com/pulp/api/v3/content/npm/units/ Also specify queryset and serializer for Package.
|
158
156
|
|
159
157
|
### Example
|
160
158
|
|
@@ -163,20 +161,19 @@ Define endpoint name which will appear in the API endpoint for this content type
|
|
163
161
|
require 'pulp_npm_client'
|
164
162
|
# setup authorization
|
165
163
|
PulpNpmClient.configure do |config|
|
166
|
-
# Configure HTTP basic authorization:
|
164
|
+
# Configure HTTP basic authorization: basicAuth
|
167
165
|
config.username = 'YOUR USERNAME'
|
168
166
|
config.password = 'YOUR PASSWORD'
|
169
167
|
end
|
170
168
|
|
171
169
|
api_instance = PulpNpmClient::ContentPackagesApi.new
|
172
|
-
package_href = 'package_href_example' # String |
|
170
|
+
package_href = 'package_href_example' # String |
|
173
171
|
opts = {
|
174
172
|
fields: 'fields_example', # String | A list of fields to include in the response.
|
175
173
|
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
176
174
|
}
|
177
175
|
|
178
176
|
begin
|
179
|
-
#Inspect a package
|
180
177
|
result = api_instance.read(package_href, opts)
|
181
178
|
p result
|
182
179
|
rescue PulpNpmClient::ApiError => e
|
@@ -189,17 +186,17 @@ end
|
|
189
186
|
|
190
187
|
Name | Type | Description | Notes
|
191
188
|
------------- | ------------- | ------------- | -------------
|
192
|
-
**package_href** | **String**|
|
189
|
+
**package_href** | **String**| |
|
193
190
|
**fields** | **String**| A list of fields to include in the response. | [optional]
|
194
191
|
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
195
192
|
|
196
193
|
### Return type
|
197
194
|
|
198
|
-
[**
|
195
|
+
[**NpmPackageResponse**](NpmPackageResponse.md)
|
199
196
|
|
200
197
|
### Authorization
|
201
198
|
|
202
|
-
[
|
199
|
+
[basicAuth](../README.md#basicAuth)
|
203
200
|
|
204
201
|
### HTTP request headers
|
205
202
|
|
data/docs/ContentSummary.md
CHANGED
@@ -4,9 +4,9 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**added** | **
|
8
|
-
**removed** | **
|
9
|
-
**present** | **
|
7
|
+
**added** | [**Object**](.md) | |
|
8
|
+
**removed** | [**Object**](.md) | |
|
9
|
+
**present** | [**Object**](.md) | |
|
10
10
|
|
11
11
|
## Code Sample
|
12
12
|
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# PulpNpmClient::ContentSummaryResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**added** | [**Object**](.md) | |
|
8
|
+
**removed** | [**Object**](.md) | |
|
9
|
+
**present** | [**Object**](.md) | |
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'PulpNpmClient'
|
15
|
+
|
16
|
+
instance = PulpNpmClient::ContentSummaryResponse.new(added: null,
|
17
|
+
removed: null,
|
18
|
+
present: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
data/docs/DistributionsNpmApi.md
CHANGED
@@ -4,20 +4,20 @@ All URIs are relative to *http://pulp*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**create**](DistributionsNpmApi.md#create) | **POST** /pulp/api/v3/distributions/npm/npm/ |
|
8
|
-
[**delete**](DistributionsNpmApi.md#delete) | **DELETE** {npm_distribution_href} |
|
9
|
-
[**list**](DistributionsNpmApi.md#list) | **GET** /pulp/api/v3/distributions/npm/npm/ |
|
10
|
-
[**partial_update**](DistributionsNpmApi.md#partial_update) | **PATCH** {npm_distribution_href} |
|
11
|
-
[**read**](DistributionsNpmApi.md#read) | **GET** {npm_distribution_href} |
|
12
|
-
[**update**](DistributionsNpmApi.md#update) | **PUT** {npm_distribution_href} |
|
7
|
+
[**create**](DistributionsNpmApi.md#create) | **POST** /pulp/api/v3/distributions/npm/npm/ |
|
8
|
+
[**delete**](DistributionsNpmApi.md#delete) | **DELETE** {npm_distribution_href} |
|
9
|
+
[**list**](DistributionsNpmApi.md#list) | **GET** /pulp/api/v3/distributions/npm/npm/ |
|
10
|
+
[**partial_update**](DistributionsNpmApi.md#partial_update) | **PATCH** {npm_distribution_href} |
|
11
|
+
[**read**](DistributionsNpmApi.md#read) | **GET** {npm_distribution_href} |
|
12
|
+
[**update**](DistributionsNpmApi.md#update) | **PUT** {npm_distribution_href} |
|
13
13
|
|
14
14
|
|
15
15
|
|
16
16
|
## create
|
17
17
|
|
18
|
-
> AsyncOperationResponse create(
|
18
|
+
> AsyncOperationResponse create(npm_npm_distribution)
|
19
|
+
|
19
20
|
|
20
|
-
Create a npm distribution
|
21
21
|
|
22
22
|
Trigger an asynchronous create task
|
23
23
|
|
@@ -28,17 +28,16 @@ Trigger an asynchronous create task
|
|
28
28
|
require 'pulp_npm_client'
|
29
29
|
# setup authorization
|
30
30
|
PulpNpmClient.configure do |config|
|
31
|
-
# Configure HTTP basic authorization:
|
31
|
+
# Configure HTTP basic authorization: basicAuth
|
32
32
|
config.username = 'YOUR USERNAME'
|
33
33
|
config.password = 'YOUR PASSWORD'
|
34
34
|
end
|
35
35
|
|
36
36
|
api_instance = PulpNpmClient::DistributionsNpmApi.new
|
37
|
-
|
37
|
+
npm_npm_distribution = PulpNpmClient::NpmNpmDistribution.new # NpmNpmDistribution |
|
38
38
|
|
39
39
|
begin
|
40
|
-
|
41
|
-
result = api_instance.create(data)
|
40
|
+
result = api_instance.create(npm_npm_distribution)
|
42
41
|
p result
|
43
42
|
rescue PulpNpmClient::ApiError => e
|
44
43
|
puts "Exception when calling DistributionsNpmApi->create: #{e}"
|
@@ -50,7 +49,7 @@ end
|
|
50
49
|
|
51
50
|
Name | Type | Description | Notes
|
52
51
|
------------- | ------------- | ------------- | -------------
|
53
|
-
**
|
52
|
+
**npm_npm_distribution** | [**NpmNpmDistribution**](NpmNpmDistribution.md)| |
|
54
53
|
|
55
54
|
### Return type
|
56
55
|
|
@@ -58,19 +57,19 @@ Name | Type | Description | Notes
|
|
58
57
|
|
59
58
|
### Authorization
|
60
59
|
|
61
|
-
[
|
60
|
+
[basicAuth](../README.md#basicAuth)
|
62
61
|
|
63
62
|
### HTTP request headers
|
64
63
|
|
65
|
-
- **Content-Type**: application/json
|
64
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
66
65
|
- **Accept**: application/json
|
67
66
|
|
68
67
|
|
69
68
|
## delete
|
70
69
|
|
71
|
-
> AsyncOperationResponse delete(npm_distribution_href)
|
70
|
+
> AsyncOperationResponse delete(npm_distribution_href, opts)
|
71
|
+
|
72
72
|
|
73
|
-
Delete a npm distribution
|
74
73
|
|
75
74
|
Trigger an asynchronous delete task
|
76
75
|
|
@@ -81,17 +80,25 @@ Trigger an asynchronous delete task
|
|
81
80
|
require 'pulp_npm_client'
|
82
81
|
# setup authorization
|
83
82
|
PulpNpmClient.configure do |config|
|
84
|
-
# Configure HTTP basic authorization:
|
83
|
+
# Configure HTTP basic authorization: basicAuth
|
85
84
|
config.username = 'YOUR USERNAME'
|
86
85
|
config.password = 'YOUR PASSWORD'
|
87
86
|
end
|
88
87
|
|
89
88
|
api_instance = PulpNpmClient::DistributionsNpmApi.new
|
90
|
-
npm_distribution_href = 'npm_distribution_href_example' # String |
|
89
|
+
npm_distribution_href = 'npm_distribution_href_example' # String |
|
90
|
+
opts = {
|
91
|
+
base_path: 'base_path_example', # String | base_path
|
92
|
+
base_path__contains: 'base_path__contains_example', # String | base_path__contains
|
93
|
+
base_path__icontains: 'base_path__icontains_example', # String | base_path__icontains
|
94
|
+
base_path__in: 'base_path__in_example', # String | base_path__in
|
95
|
+
name: 'name_example', # String | name
|
96
|
+
name__in: 'name__in_example', # String | name__in
|
97
|
+
ordering: 'ordering_example' # String | Which field to use when ordering the results.
|
98
|
+
}
|
91
99
|
|
92
100
|
begin
|
93
|
-
|
94
|
-
result = api_instance.delete(npm_distribution_href)
|
101
|
+
result = api_instance.delete(npm_distribution_href, opts)
|
95
102
|
p result
|
96
103
|
rescue PulpNpmClient::ApiError => e
|
97
104
|
puts "Exception when calling DistributionsNpmApi->delete: #{e}"
|
@@ -103,7 +110,14 @@ end
|
|
103
110
|
|
104
111
|
Name | Type | Description | Notes
|
105
112
|
------------- | ------------- | ------------- | -------------
|
106
|
-
**npm_distribution_href** | **String**|
|
113
|
+
**npm_distribution_href** | **String**| |
|
114
|
+
**base_path** | **String**| base_path | [optional]
|
115
|
+
**base_path__contains** | **String**| base_path__contains | [optional]
|
116
|
+
**base_path__icontains** | **String**| base_path__icontains | [optional]
|
117
|
+
**base_path__in** | **String**| base_path__in | [optional]
|
118
|
+
**name** | **String**| name | [optional]
|
119
|
+
**name__in** | **String**| name__in | [optional]
|
120
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
107
121
|
|
108
122
|
### Return type
|
109
123
|
|
@@ -111,7 +125,7 @@ Name | Type | Description | Notes
|
|
111
125
|
|
112
126
|
### Authorization
|
113
127
|
|
114
|
-
[
|
128
|
+
[basicAuth](../README.md#basicAuth)
|
115
129
|
|
116
130
|
### HTTP request headers
|
117
131
|
|
@@ -123,7 +137,7 @@ Name | Type | Description | Notes
|
|
123
137
|
|
124
138
|
> InlineResponse2001 list(opts)
|
125
139
|
|
126
|
-
|
140
|
+
|
127
141
|
|
128
142
|
ViewSet for NPM Distributions.
|
129
143
|
|
@@ -134,28 +148,27 @@ ViewSet for NPM Distributions.
|
|
134
148
|
require 'pulp_npm_client'
|
135
149
|
# setup authorization
|
136
150
|
PulpNpmClient.configure do |config|
|
137
|
-
# Configure HTTP basic authorization:
|
151
|
+
# Configure HTTP basic authorization: basicAuth
|
138
152
|
config.username = 'YOUR USERNAME'
|
139
153
|
config.password = 'YOUR PASSWORD'
|
140
154
|
end
|
141
155
|
|
142
156
|
api_instance = PulpNpmClient::DistributionsNpmApi.new
|
143
157
|
opts = {
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
base_path__contains: 'base_path__contains_example', # String | Filter results where base_path contains value
|
149
|
-
base_path__icontains: 'base_path__icontains_example', # String | Filter results where base_path contains value
|
150
|
-
base_path__in: 'base_path__in_example', # String | Filter results where base_path is in a comma-separated list of values
|
158
|
+
base_path: 'base_path_example', # String | base_path
|
159
|
+
base_path__contains: 'base_path__contains_example', # String | base_path__contains
|
160
|
+
base_path__icontains: 'base_path__icontains_example', # String | base_path__icontains
|
161
|
+
base_path__in: 'base_path__in_example', # String | base_path__in
|
151
162
|
limit: 56, # Integer | Number of results to return per page.
|
163
|
+
name: 'name_example', # String | name
|
164
|
+
name__in: 'name__in_example', # String | name__in
|
152
165
|
offset: 56, # Integer | The initial index from which to return the results.
|
166
|
+
ordering: 'ordering_example', # String | Which field to use when ordering the results.
|
153
167
|
fields: 'fields_example', # String | A list of fields to include in the response.
|
154
168
|
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
155
169
|
}
|
156
170
|
|
157
171
|
begin
|
158
|
-
#List npm distributions
|
159
172
|
result = api_instance.list(opts)
|
160
173
|
p result
|
161
174
|
rescue PulpNpmClient::ApiError => e
|
@@ -168,15 +181,15 @@ end
|
|
168
181
|
|
169
182
|
Name | Type | Description | Notes
|
170
183
|
------------- | ------------- | ------------- | -------------
|
171
|
-
**
|
172
|
-
**
|
173
|
-
**
|
174
|
-
**
|
175
|
-
**base_path__contains** | **String**| Filter results where base_path contains value | [optional]
|
176
|
-
**base_path__icontains** | **String**| Filter results where base_path contains value | [optional]
|
177
|
-
**base_path__in** | **String**| Filter results where base_path is in a comma-separated list of values | [optional]
|
184
|
+
**base_path** | **String**| base_path | [optional]
|
185
|
+
**base_path__contains** | **String**| base_path__contains | [optional]
|
186
|
+
**base_path__icontains** | **String**| base_path__icontains | [optional]
|
187
|
+
**base_path__in** | **String**| base_path__in | [optional]
|
178
188
|
**limit** | **Integer**| Number of results to return per page. | [optional]
|
189
|
+
**name** | **String**| name | [optional]
|
190
|
+
**name__in** | **String**| name__in | [optional]
|
179
191
|
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
192
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
180
193
|
**fields** | **String**| A list of fields to include in the response. | [optional]
|
181
194
|
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
182
195
|
|
@@ -186,7 +199,7 @@ Name | Type | Description | Notes
|
|
186
199
|
|
187
200
|
### Authorization
|
188
201
|
|
189
|
-
[
|
202
|
+
[basicAuth](../README.md#basicAuth)
|
190
203
|
|
191
204
|
### HTTP request headers
|
192
205
|
|
@@ -196,9 +209,9 @@ Name | Type | Description | Notes
|
|
196
209
|
|
197
210
|
## partial_update
|
198
211
|
|
199
|
-
> AsyncOperationResponse partial_update(npm_distribution_href,
|
212
|
+
> AsyncOperationResponse partial_update(npm_distribution_href, patchednpm_npm_distribution, opts)
|
213
|
+
|
200
214
|
|
201
|
-
Partially update a npm distribution
|
202
215
|
|
203
216
|
Trigger an asynchronous partial update task
|
204
217
|
|
@@ -209,18 +222,26 @@ Trigger an asynchronous partial update task
|
|
209
222
|
require 'pulp_npm_client'
|
210
223
|
# setup authorization
|
211
224
|
PulpNpmClient.configure do |config|
|
212
|
-
# Configure HTTP basic authorization:
|
225
|
+
# Configure HTTP basic authorization: basicAuth
|
213
226
|
config.username = 'YOUR USERNAME'
|
214
227
|
config.password = 'YOUR PASSWORD'
|
215
228
|
end
|
216
229
|
|
217
230
|
api_instance = PulpNpmClient::DistributionsNpmApi.new
|
218
|
-
npm_distribution_href = 'npm_distribution_href_example' # String |
|
219
|
-
|
231
|
+
npm_distribution_href = 'npm_distribution_href_example' # String |
|
232
|
+
patchednpm_npm_distribution = PulpNpmClient::PatchednpmNpmDistribution.new # PatchednpmNpmDistribution |
|
233
|
+
opts = {
|
234
|
+
base_path: 'base_path_example', # String | base_path
|
235
|
+
base_path__contains: 'base_path__contains_example', # String | base_path__contains
|
236
|
+
base_path__icontains: 'base_path__icontains_example', # String | base_path__icontains
|
237
|
+
base_path__in: 'base_path__in_example', # String | base_path__in
|
238
|
+
name: 'name_example', # String | name
|
239
|
+
name__in: 'name__in_example', # String | name__in
|
240
|
+
ordering: 'ordering_example' # String | Which field to use when ordering the results.
|
241
|
+
}
|
220
242
|
|
221
243
|
begin
|
222
|
-
|
223
|
-
result = api_instance.partial_update(npm_distribution_href, data)
|
244
|
+
result = api_instance.partial_update(npm_distribution_href, patchednpm_npm_distribution, opts)
|
224
245
|
p result
|
225
246
|
rescue PulpNpmClient::ApiError => e
|
226
247
|
puts "Exception when calling DistributionsNpmApi->partial_update: #{e}"
|
@@ -232,8 +253,15 @@ end
|
|
232
253
|
|
233
254
|
Name | Type | Description | Notes
|
234
255
|
------------- | ------------- | ------------- | -------------
|
235
|
-
**npm_distribution_href** | **String**|
|
236
|
-
**
|
256
|
+
**npm_distribution_href** | **String**| |
|
257
|
+
**patchednpm_npm_distribution** | [**PatchednpmNpmDistribution**](PatchednpmNpmDistribution.md)| |
|
258
|
+
**base_path** | **String**| base_path | [optional]
|
259
|
+
**base_path__contains** | **String**| base_path__contains | [optional]
|
260
|
+
**base_path__icontains** | **String**| base_path__icontains | [optional]
|
261
|
+
**base_path__in** | **String**| base_path__in | [optional]
|
262
|
+
**name** | **String**| name | [optional]
|
263
|
+
**name__in** | **String**| name__in | [optional]
|
264
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
237
265
|
|
238
266
|
### Return type
|
239
267
|
|
@@ -241,19 +269,19 @@ Name | Type | Description | Notes
|
|
241
269
|
|
242
270
|
### Authorization
|
243
271
|
|
244
|
-
[
|
272
|
+
[basicAuth](../README.md#basicAuth)
|
245
273
|
|
246
274
|
### HTTP request headers
|
247
275
|
|
248
|
-
- **Content-Type**: application/json
|
276
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
249
277
|
- **Accept**: application/json
|
250
278
|
|
251
279
|
|
252
280
|
## read
|
253
281
|
|
254
|
-
>
|
282
|
+
> NpmNpmDistributionResponse read(npm_distribution_href, opts)
|
283
|
+
|
255
284
|
|
256
|
-
Inspect a npm distribution
|
257
285
|
|
258
286
|
ViewSet for NPM Distributions.
|
259
287
|
|
@@ -264,20 +292,19 @@ ViewSet for NPM Distributions.
|
|
264
292
|
require 'pulp_npm_client'
|
265
293
|
# setup authorization
|
266
294
|
PulpNpmClient.configure do |config|
|
267
|
-
# Configure HTTP basic authorization:
|
295
|
+
# Configure HTTP basic authorization: basicAuth
|
268
296
|
config.username = 'YOUR USERNAME'
|
269
297
|
config.password = 'YOUR PASSWORD'
|
270
298
|
end
|
271
299
|
|
272
300
|
api_instance = PulpNpmClient::DistributionsNpmApi.new
|
273
|
-
npm_distribution_href = 'npm_distribution_href_example' # String |
|
301
|
+
npm_distribution_href = 'npm_distribution_href_example' # String |
|
274
302
|
opts = {
|
275
303
|
fields: 'fields_example', # String | A list of fields to include in the response.
|
276
304
|
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
277
305
|
}
|
278
306
|
|
279
307
|
begin
|
280
|
-
#Inspect a npm distribution
|
281
308
|
result = api_instance.read(npm_distribution_href, opts)
|
282
309
|
p result
|
283
310
|
rescue PulpNpmClient::ApiError => e
|
@@ -290,17 +317,17 @@ end
|
|
290
317
|
|
291
318
|
Name | Type | Description | Notes
|
292
319
|
------------- | ------------- | ------------- | -------------
|
293
|
-
**npm_distribution_href** | **String**|
|
320
|
+
**npm_distribution_href** | **String**| |
|
294
321
|
**fields** | **String**| A list of fields to include in the response. | [optional]
|
295
322
|
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
296
323
|
|
297
324
|
### Return type
|
298
325
|
|
299
|
-
[**
|
326
|
+
[**NpmNpmDistributionResponse**](NpmNpmDistributionResponse.md)
|
300
327
|
|
301
328
|
### Authorization
|
302
329
|
|
303
|
-
[
|
330
|
+
[basicAuth](../README.md#basicAuth)
|
304
331
|
|
305
332
|
### HTTP request headers
|
306
333
|
|
@@ -310,9 +337,9 @@ Name | Type | Description | Notes
|
|
310
337
|
|
311
338
|
## update
|
312
339
|
|
313
|
-
> AsyncOperationResponse update(npm_distribution_href,
|
340
|
+
> AsyncOperationResponse update(npm_distribution_href, npm_npm_distribution, opts)
|
341
|
+
|
314
342
|
|
315
|
-
Update a npm distribution
|
316
343
|
|
317
344
|
Trigger an asynchronous update task
|
318
345
|
|
@@ -323,18 +350,26 @@ Trigger an asynchronous update task
|
|
323
350
|
require 'pulp_npm_client'
|
324
351
|
# setup authorization
|
325
352
|
PulpNpmClient.configure do |config|
|
326
|
-
# Configure HTTP basic authorization:
|
353
|
+
# Configure HTTP basic authorization: basicAuth
|
327
354
|
config.username = 'YOUR USERNAME'
|
328
355
|
config.password = 'YOUR PASSWORD'
|
329
356
|
end
|
330
357
|
|
331
358
|
api_instance = PulpNpmClient::DistributionsNpmApi.new
|
332
|
-
npm_distribution_href = 'npm_distribution_href_example' # String |
|
333
|
-
|
359
|
+
npm_distribution_href = 'npm_distribution_href_example' # String |
|
360
|
+
npm_npm_distribution = PulpNpmClient::NpmNpmDistribution.new # NpmNpmDistribution |
|
361
|
+
opts = {
|
362
|
+
base_path: 'base_path_example', # String | base_path
|
363
|
+
base_path__contains: 'base_path__contains_example', # String | base_path__contains
|
364
|
+
base_path__icontains: 'base_path__icontains_example', # String | base_path__icontains
|
365
|
+
base_path__in: 'base_path__in_example', # String | base_path__in
|
366
|
+
name: 'name_example', # String | name
|
367
|
+
name__in: 'name__in_example', # String | name__in
|
368
|
+
ordering: 'ordering_example' # String | Which field to use when ordering the results.
|
369
|
+
}
|
334
370
|
|
335
371
|
begin
|
336
|
-
|
337
|
-
result = api_instance.update(npm_distribution_href, data)
|
372
|
+
result = api_instance.update(npm_distribution_href, npm_npm_distribution, opts)
|
338
373
|
p result
|
339
374
|
rescue PulpNpmClient::ApiError => e
|
340
375
|
puts "Exception when calling DistributionsNpmApi->update: #{e}"
|
@@ -346,8 +381,15 @@ end
|
|
346
381
|
|
347
382
|
Name | Type | Description | Notes
|
348
383
|
------------- | ------------- | ------------- | -------------
|
349
|
-
**npm_distribution_href** | **String**|
|
350
|
-
**
|
384
|
+
**npm_distribution_href** | **String**| |
|
385
|
+
**npm_npm_distribution** | [**NpmNpmDistribution**](NpmNpmDistribution.md)| |
|
386
|
+
**base_path** | **String**| base_path | [optional]
|
387
|
+
**base_path__contains** | **String**| base_path__contains | [optional]
|
388
|
+
**base_path__icontains** | **String**| base_path__icontains | [optional]
|
389
|
+
**base_path__in** | **String**| base_path__in | [optional]
|
390
|
+
**name** | **String**| name | [optional]
|
391
|
+
**name__in** | **String**| name__in | [optional]
|
392
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
351
393
|
|
352
394
|
### Return type
|
353
395
|
|
@@ -355,10 +397,10 @@ Name | Type | Description | Notes
|
|
355
397
|
|
356
398
|
### Authorization
|
357
399
|
|
358
|
-
[
|
400
|
+
[basicAuth](../README.md#basicAuth)
|
359
401
|
|
360
402
|
### HTTP request headers
|
361
403
|
|
362
|
-
- **Content-Type**: application/json
|
404
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
363
405
|
- **Accept**: application/json
|
364
406
|
|