pulp_npm_client 0.1.0a1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (105) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +157 -0
  4. data/Rakefile +10 -0
  5. data/docs/AsyncOperationResponse.md +17 -0
  6. data/docs/ContentPackagesApi.md +208 -0
  7. data/docs/ContentSummary.md +21 -0
  8. data/docs/ContentSummaryResponse.md +21 -0
  9. data/docs/DistributionsNpmApi.md +364 -0
  10. data/docs/NpmNpmDistribution.md +25 -0
  11. data/docs/NpmNpmDistributionResponse.md +31 -0
  12. data/docs/NpmNpmRemote.md +37 -0
  13. data/docs/NpmNpmRemoteResponse.md +43 -0
  14. data/docs/NpmNpmRepository.md +21 -0
  15. data/docs/NpmNpmRepositoryResponse.md +29 -0
  16. data/docs/NpmPackage.md +27 -0
  17. data/docs/NpmPackageResponse.md +27 -0
  18. data/docs/PaginatedRepositoryVersionResponseList.md +23 -0
  19. data/docs/PaginatednpmNpmDistributionResponseList.md +23 -0
  20. data/docs/PaginatednpmNpmRemoteResponseList.md +23 -0
  21. data/docs/PaginatednpmNpmRepositoryResponseList.md +23 -0
  22. data/docs/PaginatednpmPackageResponseList.md +23 -0
  23. data/docs/PatchednpmNpmDistribution.md +25 -0
  24. data/docs/PatchednpmNpmRemote.md +37 -0
  25. data/docs/PatchednpmNpmRepository.md +21 -0
  26. data/docs/PolicyEnum.md +16 -0
  27. data/docs/PulpNpmPackagesApi.md +60 -0
  28. data/docs/RemotesNpmApi.md +368 -0
  29. data/docs/RepositoriesNpmApi.md +468 -0
  30. data/docs/RepositoriesNpmVersionsApi.md +271 -0
  31. data/docs/RepositoryAddRemoveContent.md +21 -0
  32. data/docs/RepositorySyncURL.md +19 -0
  33. data/docs/RepositoryVersion.md +17 -0
  34. data/docs/RepositoryVersionResponse.md +25 -0
  35. data/git_push.sh +58 -0
  36. data/lib/pulp_npm_client.rb +69 -0
  37. data/lib/pulp_npm_client/api/content_packages_api.rb +264 -0
  38. data/lib/pulp_npm_client/api/distributions_npm_api.rb +445 -0
  39. data/lib/pulp_npm_client/api/pulp_npm_packages_api.rb +86 -0
  40. data/lib/pulp_npm_client/api/remotes_npm_api.rb +451 -0
  41. data/lib/pulp_npm_client/api/repositories_npm_api.rb +573 -0
  42. data/lib/pulp_npm_client/api/repositories_npm_versions_api.rb +339 -0
  43. data/lib/pulp_npm_client/api_client.rb +402 -0
  44. data/lib/pulp_npm_client/api_error.rb +57 -0
  45. data/lib/pulp_npm_client/configuration.rb +243 -0
  46. data/lib/pulp_npm_client/models/async_operation_response.rb +213 -0
  47. data/lib/pulp_npm_client/models/content_summary.rb +240 -0
  48. data/lib/pulp_npm_client/models/content_summary_response.rb +240 -0
  49. data/lib/pulp_npm_client/models/npm_npm_distribution.rb +261 -0
  50. data/lib/pulp_npm_client/models/npm_npm_distribution_response.rb +290 -0
  51. data/lib/pulp_npm_client/models/npm_npm_remote.rb +339 -0
  52. data/lib/pulp_npm_client/models/npm_npm_remote_response.rb +368 -0
  53. data/lib/pulp_npm_client/models/npm_npm_repository.rb +234 -0
  54. data/lib/pulp_npm_client/models/npm_npm_repository_response.rb +271 -0
  55. data/lib/pulp_npm_client/models/npm_package.rb +270 -0
  56. data/lib/pulp_npm_client/models/npm_package_response.rb +269 -0
  57. data/lib/pulp_npm_client/models/paginated_repository_version_response_list.rb +237 -0
  58. data/lib/pulp_npm_client/models/paginatednpm_npm_distribution_response_list.rb +237 -0
  59. data/lib/pulp_npm_client/models/paginatednpm_npm_remote_response_list.rb +237 -0
  60. data/lib/pulp_npm_client/models/paginatednpm_npm_repository_response_list.rb +237 -0
  61. data/lib/pulp_npm_client/models/paginatednpm_package_response_list.rb +237 -0
  62. data/lib/pulp_npm_client/models/patchednpm_npm_distribution.rb +251 -0
  63. data/lib/pulp_npm_client/models/patchednpm_npm_remote.rb +329 -0
  64. data/lib/pulp_npm_client/models/patchednpm_npm_repository.rb +229 -0
  65. data/lib/pulp_npm_client/models/policy_enum.rb +37 -0
  66. data/lib/pulp_npm_client/models/repository_add_remove_content.rb +232 -0
  67. data/lib/pulp_npm_client/models/repository_sync_url.rb +220 -0
  68. data/lib/pulp_npm_client/models/repository_version.rb +208 -0
  69. data/lib/pulp_npm_client/models/repository_version_response.rb +246 -0
  70. data/lib/pulp_npm_client/version.rb +15 -0
  71. data/pulp_npm_client.gemspec +39 -0
  72. data/spec/api/content_packages_api_spec.rb +87 -0
  73. data/spec/api/distributions_npm_api_spec.rb +121 -0
  74. data/spec/api/pulp_npm_packages_api_spec.rb +48 -0
  75. data/spec/api/remotes_npm_api_spec.rb +123 -0
  76. data/spec/api/repositories_npm_api_spec.rb +143 -0
  77. data/spec/api/repositories_npm_versions_api_spec.rb +104 -0
  78. data/spec/api_client_spec.rb +188 -0
  79. data/spec/configuration_spec.rb +42 -0
  80. data/spec/models/async_operation_response_spec.rb +41 -0
  81. data/spec/models/content_summary_response_spec.rb +53 -0
  82. data/spec/models/content_summary_spec.rb +53 -0
  83. data/spec/models/npm_npm_distribution_response_spec.rb +83 -0
  84. data/spec/models/npm_npm_distribution_spec.rb +65 -0
  85. data/spec/models/npm_npm_remote_response_spec.rb +119 -0
  86. data/spec/models/npm_npm_remote_spec.rb +101 -0
  87. data/spec/models/npm_npm_repository_response_spec.rb +77 -0
  88. data/spec/models/npm_npm_repository_spec.rb +53 -0
  89. data/spec/models/npm_package_response_spec.rb +71 -0
  90. data/spec/models/npm_package_spec.rb +71 -0
  91. data/spec/models/paginated_repository_version_response_list_spec.rb +59 -0
  92. data/spec/models/paginatednpm_npm_distribution_response_list_spec.rb +59 -0
  93. data/spec/models/paginatednpm_npm_remote_response_list_spec.rb +59 -0
  94. data/spec/models/paginatednpm_npm_repository_response_list_spec.rb +59 -0
  95. data/spec/models/paginatednpm_package_response_list_spec.rb +59 -0
  96. data/spec/models/patchednpm_npm_distribution_spec.rb +65 -0
  97. data/spec/models/patchednpm_npm_remote_spec.rb +101 -0
  98. data/spec/models/patchednpm_npm_repository_spec.rb +53 -0
  99. data/spec/models/policy_enum_spec.rb +35 -0
  100. data/spec/models/repository_add_remove_content_spec.rb +53 -0
  101. data/spec/models/repository_sync_url_spec.rb +47 -0
  102. data/spec/models/repository_version_response_spec.rb +65 -0
  103. data/spec/models/repository_version_spec.rb +41 -0
  104. data/spec/spec_helper.rb +111 -0
  105. metadata +233 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 9371b0d6c6a0799a3dbb1373bcc536584de4127227b0dace2fc7089e4d7c7a5f
4
+ data.tar.gz: 5c05d8f8fe15895f3f57e2da261fb6079cdfcc45072eb4afe6ffc1bf0e288317
5
+ SHA512:
6
+ metadata.gz: 8ebbf923f7b91fed761f7d2da0ba8cc9f25abeba250550a05fcf336d75708c88a9dad220b04c7a592863db4fb47adf533369f53c07d44f61755694e8bfe39c39
7
+ data.tar.gz: b6e15a6e56e855a8bdf3e669cdfe4e083bfff33dabd6310faa06a00c39b5c491e30b614552146d28d8d749476980ef75f50d5c86ad6f6b2d45f23b611b96a6cc
data/Gemfile ADDED
@@ -0,0 +1,9 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 12.0.0'
7
+ gem 'pry-byebug'
8
+ gem 'rubocop', '~> 0.66.0'
9
+ end
@@ -0,0 +1,157 @@
1
+ # pulp_npm_client
2
+
3
+ PulpNpmClient - the Ruby gem for the Pulp 3 API
4
+
5
+ Fetch, Upload, Organize, and Distribute Software Packages
6
+
7
+ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
+
9
+ - API version: v3
10
+ - Package version: 0.1.0a1
11
+ - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
+ For more information, please visit [https://pulpproject.org](https://pulpproject.org)
13
+
14
+ ## Installation
15
+
16
+ ### Build a gem
17
+
18
+ To build the Ruby code into a gem:
19
+
20
+ ```shell
21
+ gem build pulp_npm_client.gemspec
22
+ ```
23
+
24
+ Then either install the gem locally:
25
+
26
+ ```shell
27
+ gem install ./pulp_npm_client-0.1.0a1.gem
28
+ ```
29
+
30
+ (for development, run `gem install --dev ./pulp_npm_client-0.1.0a1.gem` to install the development dependencies)
31
+
32
+ or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
+
34
+ Finally add this to the Gemfile:
35
+
36
+ gem 'pulp_npm_client', '~> 0.1.0a1'
37
+
38
+ ### Install from Git
39
+
40
+ If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
41
+
42
+ gem 'pulp_npm_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
43
+
44
+ ### Include the Ruby code directly
45
+
46
+ Include the Ruby code directly using `-I` as follows:
47
+
48
+ ```shell
49
+ ruby -Ilib script.rb
50
+ ```
51
+
52
+ ## Getting Started
53
+
54
+ Please follow the [installation](#installation) procedure and then run the following code:
55
+
56
+ ```ruby
57
+ # Load the gem
58
+ require 'pulp_npm_client'
59
+
60
+ # Setup authorization
61
+ PulpNpmClient.configure do |config|
62
+ # Configure HTTP basic authorization: basicAuth
63
+ config.username = 'YOUR_USERNAME'
64
+ config.password = 'YOUR_PASSWORD'
65
+ end
66
+
67
+ api_instance = PulpNpmClient::ContentPackagesApi.new
68
+ relative_path = 'relative_path_example' # String |
69
+ name = 'name_example' # String |
70
+ version = 'version_example' # String |
71
+ opts = {
72
+ artifact: 'artifact_example', # String | Artifact file representing the physical content
73
+ file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
74
+ repository: 'repository_example' # String | A URI of a repository the new content unit should be associated with.
75
+ }
76
+
77
+ begin
78
+ #Create a package
79
+ result = api_instance.create(relative_path, name, version, opts)
80
+ p result
81
+ rescue PulpNpmClient::ApiError => e
82
+ puts "Exception when calling ContentPackagesApi->create: #{e}"
83
+ end
84
+
85
+ ```
86
+
87
+ ## Documentation for API Endpoints
88
+
89
+ All URIs are relative to *http://pulp*
90
+
91
+ Class | Method | HTTP request | Description
92
+ ------------ | ------------- | ------------- | -------------
93
+ *PulpNpmClient::ContentPackagesApi* | [**create**](docs/ContentPackagesApi.md#create) | **POST** /pulp/api/v3/content/npm/packages/ | Create a package
94
+ *PulpNpmClient::ContentPackagesApi* | [**list**](docs/ContentPackagesApi.md#list) | **GET** /pulp/api/v3/content/npm/packages/ | List packages
95
+ *PulpNpmClient::ContentPackagesApi* | [**read**](docs/ContentPackagesApi.md#read) | **GET** {npm_package_href} | Inspect a package
96
+ *PulpNpmClient::DistributionsNpmApi* | [**create**](docs/DistributionsNpmApi.md#create) | **POST** /pulp/api/v3/distributions/npm/npm/ | Create a npm distribution
97
+ *PulpNpmClient::DistributionsNpmApi* | [**delete**](docs/DistributionsNpmApi.md#delete) | **DELETE** {npm_npm_distribution_href} | Delete a npm distribution
98
+ *PulpNpmClient::DistributionsNpmApi* | [**list**](docs/DistributionsNpmApi.md#list) | **GET** /pulp/api/v3/distributions/npm/npm/ | List npm distributions
99
+ *PulpNpmClient::DistributionsNpmApi* | [**partial_update**](docs/DistributionsNpmApi.md#partial_update) | **PATCH** {npm_npm_distribution_href} | Update a npm distribution
100
+ *PulpNpmClient::DistributionsNpmApi* | [**read**](docs/DistributionsNpmApi.md#read) | **GET** {npm_npm_distribution_href} | Inspect a npm distribution
101
+ *PulpNpmClient::DistributionsNpmApi* | [**update**](docs/DistributionsNpmApi.md#update) | **PUT** {npm_npm_distribution_href} | Update a npm distribution
102
+ *PulpNpmClient::PulpNpmPackagesApi* | [**get**](docs/PulpNpmPackagesApi.md#get) | **GET** /pulp_npm/packages/{name}/ |
103
+ *PulpNpmClient::RemotesNpmApi* | [**create**](docs/RemotesNpmApi.md#create) | **POST** /pulp/api/v3/remotes/npm/npm/ | Create a npm remote
104
+ *PulpNpmClient::RemotesNpmApi* | [**delete**](docs/RemotesNpmApi.md#delete) | **DELETE** {npm_npm_remote_href} | Delete a npm remote
105
+ *PulpNpmClient::RemotesNpmApi* | [**list**](docs/RemotesNpmApi.md#list) | **GET** /pulp/api/v3/remotes/npm/npm/ | List npm remotes
106
+ *PulpNpmClient::RemotesNpmApi* | [**partial_update**](docs/RemotesNpmApi.md#partial_update) | **PATCH** {npm_npm_remote_href} | Update a npm remote
107
+ *PulpNpmClient::RemotesNpmApi* | [**read**](docs/RemotesNpmApi.md#read) | **GET** {npm_npm_remote_href} | Inspect a npm remote
108
+ *PulpNpmClient::RemotesNpmApi* | [**update**](docs/RemotesNpmApi.md#update) | **PUT** {npm_npm_remote_href} | Update a npm remote
109
+ *PulpNpmClient::RepositoriesNpmApi* | [**create**](docs/RepositoriesNpmApi.md#create) | **POST** /pulp/api/v3/repositories/npm/npm/ | Create a npm repository
110
+ *PulpNpmClient::RepositoriesNpmApi* | [**delete**](docs/RepositoriesNpmApi.md#delete) | **DELETE** {npm_npm_repository_href} | Delete a npm repository
111
+ *PulpNpmClient::RepositoriesNpmApi* | [**list**](docs/RepositoriesNpmApi.md#list) | **GET** /pulp/api/v3/repositories/npm/npm/ | List npm repositorys
112
+ *PulpNpmClient::RepositoriesNpmApi* | [**modify**](docs/RepositoriesNpmApi.md#modify) | **POST** {npm_npm_repository_href}modify/ | Modify Repository Content
113
+ *PulpNpmClient::RepositoriesNpmApi* | [**partial_update**](docs/RepositoriesNpmApi.md#partial_update) | **PATCH** {npm_npm_repository_href} | Update a npm repository
114
+ *PulpNpmClient::RepositoriesNpmApi* | [**read**](docs/RepositoriesNpmApi.md#read) | **GET** {npm_npm_repository_href} | Inspect a npm repository
115
+ *PulpNpmClient::RepositoriesNpmApi* | [**sync**](docs/RepositoriesNpmApi.md#sync) | **POST** {npm_npm_repository_href}sync/ | Sync from remote
116
+ *PulpNpmClient::RepositoriesNpmApi* | [**update**](docs/RepositoriesNpmApi.md#update) | **PUT** {npm_npm_repository_href} | Update a npm repository
117
+ *PulpNpmClient::RepositoriesNpmVersionsApi* | [**delete**](docs/RepositoriesNpmVersionsApi.md#delete) | **DELETE** {npm_npm_repository_version_href} | Delete a repository version
118
+ *PulpNpmClient::RepositoriesNpmVersionsApi* | [**list**](docs/RepositoriesNpmVersionsApi.md#list) | **GET** {npm_npm_repository_href}versions/ | List repository versions
119
+ *PulpNpmClient::RepositoriesNpmVersionsApi* | [**read**](docs/RepositoriesNpmVersionsApi.md#read) | **GET** {npm_npm_repository_version_href} | Inspect a repository version
120
+ *PulpNpmClient::RepositoriesNpmVersionsApi* | [**repair**](docs/RepositoriesNpmVersionsApi.md#repair) | **POST** {npm_npm_repository_version_href}repair/ |
121
+
122
+
123
+ ## Documentation for Models
124
+
125
+ - [PulpNpmClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
126
+ - [PulpNpmClient::ContentSummary](docs/ContentSummary.md)
127
+ - [PulpNpmClient::ContentSummaryResponse](docs/ContentSummaryResponse.md)
128
+ - [PulpNpmClient::NpmNpmDistribution](docs/NpmNpmDistribution.md)
129
+ - [PulpNpmClient::NpmNpmDistributionResponse](docs/NpmNpmDistributionResponse.md)
130
+ - [PulpNpmClient::NpmNpmRemote](docs/NpmNpmRemote.md)
131
+ - [PulpNpmClient::NpmNpmRemoteResponse](docs/NpmNpmRemoteResponse.md)
132
+ - [PulpNpmClient::NpmNpmRepository](docs/NpmNpmRepository.md)
133
+ - [PulpNpmClient::NpmNpmRepositoryResponse](docs/NpmNpmRepositoryResponse.md)
134
+ - [PulpNpmClient::NpmPackage](docs/NpmPackage.md)
135
+ - [PulpNpmClient::NpmPackageResponse](docs/NpmPackageResponse.md)
136
+ - [PulpNpmClient::PaginatedRepositoryVersionResponseList](docs/PaginatedRepositoryVersionResponseList.md)
137
+ - [PulpNpmClient::PaginatednpmNpmDistributionResponseList](docs/PaginatednpmNpmDistributionResponseList.md)
138
+ - [PulpNpmClient::PaginatednpmNpmRemoteResponseList](docs/PaginatednpmNpmRemoteResponseList.md)
139
+ - [PulpNpmClient::PaginatednpmNpmRepositoryResponseList](docs/PaginatednpmNpmRepositoryResponseList.md)
140
+ - [PulpNpmClient::PaginatednpmPackageResponseList](docs/PaginatednpmPackageResponseList.md)
141
+ - [PulpNpmClient::PatchednpmNpmDistribution](docs/PatchednpmNpmDistribution.md)
142
+ - [PulpNpmClient::PatchednpmNpmRemote](docs/PatchednpmNpmRemote.md)
143
+ - [PulpNpmClient::PatchednpmNpmRepository](docs/PatchednpmNpmRepository.md)
144
+ - [PulpNpmClient::PolicyEnum](docs/PolicyEnum.md)
145
+ - [PulpNpmClient::RepositoryAddRemoveContent](docs/RepositoryAddRemoveContent.md)
146
+ - [PulpNpmClient::RepositorySyncURL](docs/RepositorySyncURL.md)
147
+ - [PulpNpmClient::RepositoryVersion](docs/RepositoryVersion.md)
148
+ - [PulpNpmClient::RepositoryVersionResponse](docs/RepositoryVersionResponse.md)
149
+
150
+
151
+ ## Documentation for Authorization
152
+
153
+
154
+ ### basicAuth
155
+
156
+ - **Type**: HTTP basic authentication
157
+
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+
3
+ begin
4
+ require 'rspec/core/rake_task'
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+ task default: :spec
8
+ rescue LoadError
9
+ # no rspec available
10
+ end
@@ -0,0 +1,17 @@
1
+ # PulpNpmClient::AsyncOperationResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **task** | **String** | The href of the task. |
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'PulpNpmClient'
13
+
14
+ instance = PulpNpmClient::AsyncOperationResponse.new(task: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,208 @@
1
+ # PulpNpmClient::ContentPackagesApi
2
+
3
+ All URIs are relative to *http://pulp*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create**](ContentPackagesApi.md#create) | **POST** /pulp/api/v3/content/npm/packages/ | Create a package
8
+ [**list**](ContentPackagesApi.md#list) | **GET** /pulp/api/v3/content/npm/packages/ | List packages
9
+ [**read**](ContentPackagesApi.md#read) | **GET** {npm_package_href} | Inspect a package
10
+
11
+
12
+
13
+ ## create
14
+
15
+ > NpmPackageResponse create(relative_path, name, version, opts)
16
+
17
+ Create a package
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
+
21
+ ### Example
22
+
23
+ ```ruby
24
+ # load the gem
25
+ require 'pulp_npm_client'
26
+ # setup authorization
27
+ PulpNpmClient.configure do |config|
28
+ # Configure HTTP basic authorization: basicAuth
29
+ config.username = 'YOUR USERNAME'
30
+ config.password = 'YOUR PASSWORD'
31
+ end
32
+
33
+ api_instance = PulpNpmClient::ContentPackagesApi.new
34
+ relative_path = 'relative_path_example' # String |
35
+ name = 'name_example' # String |
36
+ version = 'version_example' # String |
37
+ opts = {
38
+ artifact: 'artifact_example', # String | Artifact file representing the physical content
39
+ file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
40
+ repository: 'repository_example' # String | A URI of a repository the new content unit should be associated with.
41
+ }
42
+
43
+ begin
44
+ #Create a package
45
+ result = api_instance.create(relative_path, name, version, opts)
46
+ p result
47
+ rescue PulpNpmClient::ApiError => e
48
+ puts "Exception when calling ContentPackagesApi->create: #{e}"
49
+ end
50
+ ```
51
+
52
+ ### Parameters
53
+
54
+
55
+ Name | Type | Description | Notes
56
+ ------------- | ------------- | ------------- | -------------
57
+ **relative_path** | **String**| |
58
+ **name** | **String**| |
59
+ **version** | **String**| |
60
+ **artifact** | **String**| Artifact file representing the physical content | [optional]
61
+ **file** | **File**| An uploaded file that may be turned into the artifact of the content unit. | [optional]
62
+ **repository** | **String**| A URI of a repository the new content unit should be associated with. | [optional]
63
+
64
+ ### Return type
65
+
66
+ [**NpmPackageResponse**](NpmPackageResponse.md)
67
+
68
+ ### Authorization
69
+
70
+ [basicAuth](../README.md#basicAuth)
71
+
72
+ ### HTTP request headers
73
+
74
+ - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
75
+ - **Accept**: application/json
76
+
77
+
78
+ ## list
79
+
80
+ > PaginatednpmPackageResponseList list(opts)
81
+
82
+ List packages
83
+
84
+ 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
+
86
+ ### Example
87
+
88
+ ```ruby
89
+ # load the gem
90
+ require 'pulp_npm_client'
91
+ # setup authorization
92
+ PulpNpmClient.configure do |config|
93
+ # Configure HTTP basic authorization: basicAuth
94
+ config.username = 'YOUR USERNAME'
95
+ config.password = 'YOUR PASSWORD'
96
+ end
97
+
98
+ api_instance = PulpNpmClient::ContentPackagesApi.new
99
+ opts = {
100
+ limit: 56, # Integer | Number of results to return per page.
101
+ name: 'name_example', # String | name
102
+ name__in: 'name__in_example', # String | name__in
103
+ offset: 56, # Integer | The initial index from which to return the results.
104
+ ordering: 'ordering_example', # String | Which field to use when ordering the results.
105
+ repository_version: 'repository_version_example', # String | repository_version
106
+ repository_version_added: 'repository_version_added_example', # String | repository_version_added
107
+ repository_version_removed: 'repository_version_removed_example', # String | repository_version_removed
108
+ fields: 'fields_example', # String | A list of fields to include in the response.
109
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
110
+ }
111
+
112
+ begin
113
+ #List packages
114
+ result = api_instance.list(opts)
115
+ p result
116
+ rescue PulpNpmClient::ApiError => e
117
+ puts "Exception when calling ContentPackagesApi->list: #{e}"
118
+ end
119
+ ```
120
+
121
+ ### Parameters
122
+
123
+
124
+ Name | Type | Description | Notes
125
+ ------------- | ------------- | ------------- | -------------
126
+ **limit** | **Integer**| Number of results to return per page. | [optional]
127
+ **name** | **String**| name | [optional]
128
+ **name__in** | **String**| name__in | [optional]
129
+ **offset** | **Integer**| The initial index from which to return the results. | [optional]
130
+ **ordering** | **String**| Which field to use when ordering the results. | [optional]
131
+ **repository_version** | **String**| repository_version | [optional]
132
+ **repository_version_added** | **String**| repository_version_added | [optional]
133
+ **repository_version_removed** | **String**| repository_version_removed | [optional]
134
+ **fields** | **String**| A list of fields to include in the response. | [optional]
135
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
136
+
137
+ ### Return type
138
+
139
+ [**PaginatednpmPackageResponseList**](PaginatednpmPackageResponseList.md)
140
+
141
+ ### Authorization
142
+
143
+ [basicAuth](../README.md#basicAuth)
144
+
145
+ ### HTTP request headers
146
+
147
+ - **Content-Type**: Not defined
148
+ - **Accept**: application/json
149
+
150
+
151
+ ## read
152
+
153
+ > NpmPackageResponse read(npm_package_href, opts)
154
+
155
+ Inspect a package
156
+
157
+ 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
+
159
+ ### Example
160
+
161
+ ```ruby
162
+ # load the gem
163
+ require 'pulp_npm_client'
164
+ # setup authorization
165
+ PulpNpmClient.configure do |config|
166
+ # Configure HTTP basic authorization: basicAuth
167
+ config.username = 'YOUR USERNAME'
168
+ config.password = 'YOUR PASSWORD'
169
+ end
170
+
171
+ api_instance = PulpNpmClient::ContentPackagesApi.new
172
+ npm_package_href = 'npm_package_href_example' # String |
173
+ opts = {
174
+ fields: 'fields_example', # String | A list of fields to include in the response.
175
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
176
+ }
177
+
178
+ begin
179
+ #Inspect a package
180
+ result = api_instance.read(npm_package_href, opts)
181
+ p result
182
+ rescue PulpNpmClient::ApiError => e
183
+ puts "Exception when calling ContentPackagesApi->read: #{e}"
184
+ end
185
+ ```
186
+
187
+ ### Parameters
188
+
189
+
190
+ Name | Type | Description | Notes
191
+ ------------- | ------------- | ------------- | -------------
192
+ **npm_package_href** | **String**| |
193
+ **fields** | **String**| A list of fields to include in the response. | [optional]
194
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
195
+
196
+ ### Return type
197
+
198
+ [**NpmPackageResponse**](NpmPackageResponse.md)
199
+
200
+ ### Authorization
201
+
202
+ [basicAuth](../README.md#basicAuth)
203
+
204
+ ### HTTP request headers
205
+
206
+ - **Content-Type**: Not defined
207
+ - **Accept**: application/json
208
+
@@ -0,0 +1,21 @@
1
+ # PulpNpmClient::ContentSummary
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::ContentSummary.new(added: null,
17
+ removed: null,
18
+ present: null)
19
+ ```
20
+
21
+
@@ -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
+