pulp_npm_client 0.1.0a4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17e5be2599f8bd3c8d1e77fb9154575df3a44b299f3984dd8ea4492c8b0e39d1
-  data.tar.gz: 6fa4eaecdc4a725ae6076283d8eab3c804f10530aaf2b678dce0509fac57c668
+  metadata.gz: 119e880b645d5ae43a04c69fb8189160df80d0722e85dee931fb003414e523fd
+  data.tar.gz: 5d2877c5c6920f9c5fea88aa89fa9dd4d5336a79d7520af04fa2ac06a104ee47
 SHA512:
-  metadata.gz: 6170105e489adaba2ff0ecf6a7a2a750f408cc0a6c230ff54fff059d7e7df88693a9b5785f7da8626c5cdd4b9c11b6f3979d82a68012f289f44751e7f5bd87fe
-  data.tar.gz: 76e5de68ce2a37d72752bd7a32208e4cea6dbcc16550a3dfef0ad1767c43a9781c295040d9d36e7d102d8eca180e50bff9ed2e90de1af3b44f282b19f783731e
+  metadata.gz: 222323df7d9ebfa079c3bc74be9e1cdde7c224fc828f544c2fd566e7c919f7b7e9f15b9529187e18357d1c5b1420fe1e1b6c4e5458a4307e5d94430e41a5bc4b
+  data.tar.gz: 8d8b3ad258e5bfd5b5b85f8dc6d102f799f219c0015dfd4226632472e31bc724fc34ee9876c18e0e35531eb0177ff66f197956000a7db58a357dc9b25a963f06

data/README.md

@@ -7,7 +7,8 @@ Fetch, Upload, Organize, and Distribute Software Packages
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v3
-- Package version: 0.1.0a4
+- Package version: 0.1.0
+- Generator version: 7.10.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://pulpproject.org](https://pulpproject.org)
 
@@ -24,16 +25,16 @@ gem build pulp_npm_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./pulp_npm_client-0.1.0a4.gem
+gem install ./pulp_npm_client-0.1.0.gem
 ```
 
-(for development, run `gem install --dev ./pulp_npm_client-0.1.0a4.gem` to install the development dependencies)
+(for development, run `gem install --dev ./pulp_npm_client-0.1.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'pulp_npm_client', '~> 0.1.0a4'
+    gem 'pulp_npm_client', '~> 0.1.0'
 
 ### Install from Git
 
@@ -62,6 +63,8 @@ PulpNpmClient.configure do |config|
   # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR_USERNAME'
   config.password = 'YOUR_PASSWORD'
+  # Configure faraday connection
+  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
 end
 
 api_instance = PulpNpmClient::ContentPackagesApi.new
@@ -69,10 +72,11 @@ relative_path = 'relative_path_example' # String |
 name = 'name_example' # String | 
 version = 'version_example' # String | 
 opts = {
-  artifact: 'artifact_example', # String | Artifact file representing the physical content
-  file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
   repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
-  upload: 'upload_example' # String | An uncommitted upload that may be turned into the artifact of the content unit.
+  artifact: 'artifact_example', # String | Artifact file representing the physical content
+  file: File.new('/path/to/some/file'), # File | An uploaded file that may be turned into the content unit.
+  upload: 'upload_example', # String | An uncommitted upload that may be turned into the content unit.
+  file_url: 'file_url_example' # String | A url that Pulp can download and turn into the content unit.
 }
 
 begin
@@ -87,7 +91,7 @@ end
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *https://pulp*
+All URIs are relative to *http://localhost:24817*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
@@ -99,13 +103,16 @@ Class | Method | HTTP request | Description
 *PulpNpmClient::DistributionsNpmApi* | [**list**](docs/DistributionsNpmApi.md#list) | **GET** /pulp/api/v3/distributions/npm/npm/ | List npm distributions
 *PulpNpmClient::DistributionsNpmApi* | [**partial_update**](docs/DistributionsNpmApi.md#partial_update) | **PATCH** {npm_npm_distribution_href} | Update a npm distribution
 *PulpNpmClient::DistributionsNpmApi* | [**read**](docs/DistributionsNpmApi.md#read) | **GET** {npm_npm_distribution_href} | Inspect a npm distribution
+*PulpNpmClient::DistributionsNpmApi* | [**set_label**](docs/DistributionsNpmApi.md#set_label) | **POST** {npm_npm_distribution_href}set_label/ | Set a label
+*PulpNpmClient::DistributionsNpmApi* | [**unset_label**](docs/DistributionsNpmApi.md#unset_label) | **POST** {npm_npm_distribution_href}unset_label/ | Unset a label
 *PulpNpmClient::DistributionsNpmApi* | [**update**](docs/DistributionsNpmApi.md#update) | **PUT** {npm_npm_distribution_href} | Update a npm distribution
-*PulpNpmClient::PulpNpmPackagesApi* | [**get**](docs/PulpNpmPackagesApi.md#get) | **GET** /pulp_npm/packages/{name}/ | 
 *PulpNpmClient::RemotesNpmApi* | [**create**](docs/RemotesNpmApi.md#create) | **POST** /pulp/api/v3/remotes/npm/npm/ | Create a npm remote
 *PulpNpmClient::RemotesNpmApi* | [**delete**](docs/RemotesNpmApi.md#delete) | **DELETE** {npm_npm_remote_href} | Delete a npm remote
 *PulpNpmClient::RemotesNpmApi* | [**list**](docs/RemotesNpmApi.md#list) | **GET** /pulp/api/v3/remotes/npm/npm/ | List npm remotes
 *PulpNpmClient::RemotesNpmApi* | [**partial_update**](docs/RemotesNpmApi.md#partial_update) | **PATCH** {npm_npm_remote_href} | Update a npm remote
 *PulpNpmClient::RemotesNpmApi* | [**read**](docs/RemotesNpmApi.md#read) | **GET** {npm_npm_remote_href} | Inspect a npm remote
+*PulpNpmClient::RemotesNpmApi* | [**set_label**](docs/RemotesNpmApi.md#set_label) | **POST** {npm_npm_remote_href}set_label/ | Set a label
+*PulpNpmClient::RemotesNpmApi* | [**unset_label**](docs/RemotesNpmApi.md#unset_label) | **POST** {npm_npm_remote_href}unset_label/ | Unset a label
 *PulpNpmClient::RemotesNpmApi* | [**update**](docs/RemotesNpmApi.md#update) | **PUT** {npm_npm_remote_href} | Update a npm remote
 *PulpNpmClient::RepositoriesNpmApi* | [**create**](docs/RepositoriesNpmApi.md#create) | **POST** /pulp/api/v3/repositories/npm/npm/ | Create a npm repository
 *PulpNpmClient::RepositoriesNpmApi* | [**delete**](docs/RepositoriesNpmApi.md#delete) | **DELETE** {npm_npm_repository_href} | Delete a npm repository
@@ -113,7 +120,9 @@ Class | Method | HTTP request | Description
 *PulpNpmClient::RepositoriesNpmApi* | [**modify**](docs/RepositoriesNpmApi.md#modify) | **POST** {npm_npm_repository_href}modify/ | Modify Repository Content
 *PulpNpmClient::RepositoriesNpmApi* | [**partial_update**](docs/RepositoriesNpmApi.md#partial_update) | **PATCH** {npm_npm_repository_href} | Update a npm repository
 *PulpNpmClient::RepositoriesNpmApi* | [**read**](docs/RepositoriesNpmApi.md#read) | **GET** {npm_npm_repository_href} | Inspect a npm repository
+*PulpNpmClient::RepositoriesNpmApi* | [**set_label**](docs/RepositoriesNpmApi.md#set_label) | **POST** {npm_npm_repository_href}set_label/ | Set a label
 *PulpNpmClient::RepositoriesNpmApi* | [**sync**](docs/RepositoriesNpmApi.md#sync) | **POST** {npm_npm_repository_href}sync/ | Sync from remote
+*PulpNpmClient::RepositoriesNpmApi* | [**unset_label**](docs/RepositoriesNpmApi.md#unset_label) | **POST** {npm_npm_repository_href}unset_label/ | Unset a label
 *PulpNpmClient::RepositoriesNpmApi* | [**update**](docs/RepositoriesNpmApi.md#update) | **PUT** {npm_npm_repository_href} | Update a npm repository
 *PulpNpmClient::RepositoriesNpmVersionsApi* | [**delete**](docs/RepositoriesNpmVersionsApi.md#delete) | **DELETE** {npm_npm_repository_version_href} | Delete a repository version
 *PulpNpmClient::RepositoriesNpmVersionsApi* | [**list**](docs/RepositoriesNpmVersionsApi.md#list) | **GET** {npm_npm_repository_href}versions/ | List repository versions
@@ -129,9 +138,9 @@ Class | Method | HTTP request | Description
  - [PulpNpmClient::NpmNpmDistributionResponse](docs/NpmNpmDistributionResponse.md)
  - [PulpNpmClient::NpmNpmRemote](docs/NpmNpmRemote.md)
  - [PulpNpmClient::NpmNpmRemoteResponse](docs/NpmNpmRemoteResponse.md)
+ - [PulpNpmClient::NpmNpmRemoteResponseHiddenFieldsInner](docs/NpmNpmRemoteResponseHiddenFieldsInner.md)
  - [PulpNpmClient::NpmNpmRepository](docs/NpmNpmRepository.md)
  - [PulpNpmClient::NpmNpmRepositoryResponse](docs/NpmNpmRepositoryResponse.md)
- - [PulpNpmClient::NpmPackage](docs/NpmPackage.md)
  - [PulpNpmClient::NpmPackageResponse](docs/NpmPackageResponse.md)
  - [PulpNpmClient::PaginatedRepositoryVersionResponseList](docs/PaginatedRepositoryVersionResponseList.md)
  - [PulpNpmClient::PaginatednpmNpmDistributionResponseList](docs/PaginatednpmNpmDistributionResponseList.md)
@@ -146,11 +155,16 @@ Class | Method | HTTP request | Description
  - [PulpNpmClient::RepositoryAddRemoveContent](docs/RepositoryAddRemoveContent.md)
  - [PulpNpmClient::RepositorySyncURL](docs/RepositorySyncURL.md)
  - [PulpNpmClient::RepositoryVersionResponse](docs/RepositoryVersionResponse.md)
+ - [PulpNpmClient::SetLabel](docs/SetLabel.md)
+ - [PulpNpmClient::SetLabelResponse](docs/SetLabelResponse.md)
+ - [PulpNpmClient::UnsetLabel](docs/UnsetLabel.md)
+ - [PulpNpmClient::UnsetLabelResponse](docs/UnsetLabelResponse.md)
 
 
 ## Documentation for Authorization
 
 
+Authentication schemes defined for the API:
 ### basicAuth
 
 - **Type**: HTTP basic authentication

data/docs/AsyncOperationResponse.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**task** | **String** | The href of the task. | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **task** | **String** | The href of the task. |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpNpmClient'
+require 'pulp_npm_client'
 
-instance = PulpNpmClient::AsyncOperationResponse.new(task: null)
+instance = PulpNpmClient::AsyncOperationResponse.new(
+  task: null
+)
 ```
 
-

data/docs/ContentPackagesApi.md

@@ -1,27 +1,26 @@
 # PulpNpmClient::ContentPackagesApi
 
-All URIs are relative to *https://pulp*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](ContentPackagesApi.md#create) | **POST** /pulp/api/v3/content/npm/packages/ | Create a package
-[**list**](ContentPackagesApi.md#list) | **GET** /pulp/api/v3/content/npm/packages/ | List packages
-[**read**](ContentPackagesApi.md#read) | **GET** {npm_package_href} | Inspect a package
+All URIs are relative to *http://localhost:24817*
 
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create**](ContentPackagesApi.md#create) | **POST** /pulp/api/v3/content/npm/packages/ | Create a package |
+| [**list**](ContentPackagesApi.md#list) | **GET** /pulp/api/v3/content/npm/packages/ | List packages |
+| [**read**](ContentPackagesApi.md#read) | **GET** {npm_package_href} | Inspect a package |
 
 
 ## create
 
-> NpmPackageResponse create(relative_path, name, version, opts)
+> <NpmPackageResponse> create(relative_path, name, version, opts)
 
 Create a package
 
-Perform bookkeeping when saving Content.  \"Artifacts\" need to be popped off and saved indpendently, as they are not actually part of the Content model.
+Perform bookkeeping when saving Content.  \"Artifacts\" need to be popped off and saved independently, as they are not actually part of the Content model.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_npm_client'
 # setup authorization
 PulpNpmClient.configure do |config|
@@ -35,33 +34,52 @@ relative_path = 'relative_path_example' # String |
 name = 'name_example' # String | 
 version = 'version_example' # String | 
 opts = {
-  artifact: 'artifact_example', # String | Artifact file representing the physical content
-  file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
   repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
-  upload: 'upload_example' # String | An uncommitted upload that may be turned into the artifact of the content unit.
+  artifact: 'artifact_example', # String | Artifact file representing the physical content
+  file: File.new('/path/to/some/file'), # File | An uploaded file that may be turned into the content unit.
+  upload: 'upload_example', # String | An uncommitted upload that may be turned into the content unit.
+  file_url: 'file_url_example' # String | A url that Pulp can download and turn into the content unit.
 }
 
 begin
-  #Create a package
+  # Create a package
   result = api_instance.create(relative_path, name, version, opts)
   p result
 rescue PulpNpmClient::ApiError => e
-  puts "Exception when calling ContentPackagesApi->create: #{e}"
+  puts "Error when calling ContentPackagesApi->create: #{e}"
 end
 ```
 
-### Parameters
+#### Using the create_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **relative_path** | **String**|  | 
- **name** | **String**|  | 
- **version** | **String**|  | 
- **artifact** | **String**| Artifact file representing the physical content | [optional] 
- **file** | **File**| An uploaded file that may be turned into the artifact of the content unit. | [optional] 
- **repository** | **String**| A URI of a repository the new content unit should be associated with. | [optional] 
- **upload** | **String**| An uncommitted upload that may be turned into the artifact of the content unit. | [optional] 
+> <Array(<NpmPackageResponse>, Integer, Hash)> create_with_http_info(relative_path, name, version, opts)
+
+```ruby
+begin
+  # Create a package
+  data, status_code, headers = api_instance.create_with_http_info(relative_path, name, version, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NpmPackageResponse>
+rescue PulpNpmClient::ApiError => e
+  puts "Error when calling ContentPackagesApi->create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **relative_path** | **String** |  |  |
+| **name** | **String** |  |  |
+| **version** | **String** |  |  |
+| **repository** | **String** | A URI of a repository the new content unit should be associated with. | [optional] |
+| **artifact** | **String** | Artifact file representing the physical content | [optional] |
+| **file** | **File** | An uploaded file that may be turned into the content unit. | [optional] |
+| **upload** | **String** | An uncommitted upload that may be turned into the content unit. | [optional] |
+| **file_url** | **String** | A url that Pulp can download and turn into the content unit. | [optional] |
 
 ### Return type
 
@@ -79,16 +97,16 @@ Name | Type | Description  | Notes
 
 ## list
 
-> PaginatednpmPackageResponseList list(opts)
+> <PaginatednpmPackageResponseList> list(opts)
 
 List packages
 
 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.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_npm_client'
 # setup authorization
 PulpNpmClient.configure do |config|
@@ -101,40 +119,67 @@ api_instance = PulpNpmClient::ContentPackagesApi.new
 opts = {
   limit: 56, # Integer | Number of results to return per page.
   name: 'name_example', # String | Filter results where name matches value
-  name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
+  name__in: ['inner_example'], # Array<String> | Filter results where name is in a comma-separated list of values
   offset: 56, # Integer | The initial index from which to return the results.
-  ordering: ['ordering_example'], # Array<String> | Ordering
-  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
-  repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF
-  repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF
-  fields: 'fields_example', # String | A list of fields to include in the response.
-  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+  ordering: ['-name'], # Array<String> | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `name` - Name * `-name` - Name (descending) * `version` - Version * `-version` - Version (descending) * `pk` - Pk * `-pk` - Pk (descending)
+  orphaned_for: 8.14, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
+  prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
+  q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
+  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF/PRN
+  repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF/PRN
+  repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF/PRN
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
 }
 
 begin
-  #List packages
+  # List packages
   result = api_instance.list(opts)
   p result
 rescue PulpNpmClient::ApiError => e
-  puts "Exception when calling ContentPackagesApi->list: #{e}"
+  puts "Error when calling ContentPackagesApi->list: #{e}"
 end
 ```
 
-### Parameters
+#### Using the list_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **limit** | **Integer**| Number of results to return per page. | [optional] 
- **name** | **String**| Filter results where name matches value | [optional] 
- **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional] 
- **offset** | **Integer**| The initial index from which to return the results. | [optional] 
- **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional] 
- **repository_version** | **String**| Repository Version referenced by HREF | [optional] 
- **repository_version_added** | **String**| Repository Version referenced by HREF | [optional] 
- **repository_version_removed** | **String**| Repository Version referenced by HREF | [optional] 
- **fields** | **String**| A list of fields to include in the response. | [optional] 
- **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+> <Array(<PaginatednpmPackageResponseList>, Integer, Hash)> list_with_http_info(opts)
+
+```ruby
+begin
+  # List packages
+  data, status_code, headers = api_instance.list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatednpmPackageResponseList>
+rescue PulpNpmClient::ApiError => e
+  puts "Error when calling ContentPackagesApi->list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | Number of results to return per page. | [optional] |
+| **name** | **String** | Filter results where name matches value | [optional] |
+| **name__in** | [**Array&lt;String&gt;**](String.md) | Filter results where name is in a comma-separated list of values | [optional] |
+| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
+| **ordering** | [**Array&lt;String&gt;**](String.md) | Ordering  * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;upstream_id&#x60; - Upstream id * &#x60;-upstream_id&#x60; - Upstream id (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;version&#x60; - Version * &#x60;-version&#x60; - Version (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] |
+| **orphaned_for** | **Float** | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [optional] |
+| **prn__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
+| **pulp_href__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
+| **pulp_id__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
+| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
+| **repository_version** | **String** | Repository Version referenced by HREF/PRN | [optional] |
+| **repository_version_added** | **String** | Repository Version referenced by HREF/PRN | [optional] |
+| **repository_version_removed** | **String** | Repository Version referenced by HREF/PRN | [optional] |
+| **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
+| **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
 
 ### Return type
 
@@ -152,16 +197,16 @@ Name | Type | Description  | Notes
 
 ## read
 
-> NpmPackageResponse read(npm_package_href, opts)
+> <NpmPackageResponse> read(npm_package_href, opts)
 
 Inspect a package
 
 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.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_npm_client'
 # setup authorization
 PulpNpmClient.configure do |config|
@@ -173,27 +218,44 @@ end
 api_instance = PulpNpmClient::ContentPackagesApi.new
 npm_package_href = 'npm_package_href_example' # String | 
 opts = {
-  fields: 'fields_example', # String | A list of fields to include in the response.
-  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
 }
 
 begin
-  #Inspect a package
+  # Inspect a package
   result = api_instance.read(npm_package_href, opts)
   p result
 rescue PulpNpmClient::ApiError => e
-  puts "Exception when calling ContentPackagesApi->read: #{e}"
+  puts "Error when calling ContentPackagesApi->read: #{e}"
 end
 ```
 
-### Parameters
+#### Using the read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<NpmPackageResponse>, Integer, Hash)> read_with_http_info(npm_package_href, opts)
+
+```ruby
+begin
+  # Inspect a package
+  data, status_code, headers = api_instance.read_with_http_info(npm_package_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NpmPackageResponse>
+rescue PulpNpmClient::ApiError => e
+  puts "Error when calling ContentPackagesApi->read_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **npm_package_href** | **String**|  | 
- **fields** | **String**| A list of fields to include in the response. | [optional] 
- **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **npm_package_href** | **String** |  |  |
+| **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
+| **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
 
 ### Return type
 

data/docs/ContentSummaryResponse.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**added** | **Hash<String, Object>** |  | 
-**removed** | **Hash<String, Object>** |  | 
-**present** | **Hash<String, Object>** |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **added** | **Hash<String, Object>** |  |  |
+| **removed** | **Hash<String, Object>** |  |  |
+| **present** | **Hash<String, Object>** |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpNpmClient'
+require 'pulp_npm_client'
 
-instance = PulpNpmClient::ContentSummaryResponse.new(added: null,
-                                 removed: null,
-                                 present: null)
+instance = PulpNpmClient::ContentSummaryResponse.new(
+  added: null,
+  removed: null,
+  present: null
+)
 ```
 
-