pulp_npm_client 0.1.0a1.dev01595856770 → 0.1.0a1.dev01596245316

data/docs/RemotesNpmApi.md

@@ -4,12 +4,12 @@ All URIs are relative to *http://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**create**](RemotesNpmApi.md#create) | **POST** /pulp/api/v3/remotes/npm/npm/ | 
-[**delete**](RemotesNpmApi.md#delete) | **DELETE** {npm_remote_href} | 
-[**list**](RemotesNpmApi.md#list) | **GET** /pulp/api/v3/remotes/npm/npm/ | 
-[**partial_update**](RemotesNpmApi.md#partial_update) | **PATCH** {npm_remote_href} | 
-[**read**](RemotesNpmApi.md#read) | **GET** {npm_remote_href} | 
-[**update**](RemotesNpmApi.md#update) | **PUT** {npm_remote_href} | 
+[**create**](RemotesNpmApi.md#create) | **POST** /pulp/api/v3/remotes/npm/npm/ | Create a npm remote
+[**delete**](RemotesNpmApi.md#delete) | **DELETE** {npm_npm_remote_href} | Delete a npm remote
+[**list**](RemotesNpmApi.md#list) | **GET** /pulp/api/v3/remotes/npm/npm/ | List npm remotes
+[**partial_update**](RemotesNpmApi.md#partial_update) | **PATCH** {npm_npm_remote_href} | Update a npm remote
+[**read**](RemotesNpmApi.md#read) | **GET** {npm_npm_remote_href} | Inspect a npm remote
+[**update**](RemotesNpmApi.md#update) | **PUT** {npm_npm_remote_href} | Update a npm remote
 
 
 
@@ -17,7 +17,7 @@ Method | HTTP request | Description
 
 > NpmNpmRemoteResponse create(npm_npm_remote)
 
-
+Create a npm remote
 
 A ViewSet for NpmRemote.  Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
 
@@ -37,6 +37,7 @@ api_instance = PulpNpmClient::RemotesNpmApi.new
 npm_npm_remote = PulpNpmClient::NpmNpmRemote.new # NpmNpmRemote | 
 
 begin
+  #Create a npm remote
   result = api_instance.create(npm_npm_remote)
   p result
 rescue PulpNpmClient::ApiError => e
@@ -67,9 +68,9 @@ Name | Type | Description  | Notes
 
 ## delete
 
-> AsyncOperationResponse delete(npm_remote_href, opts)
-
+> AsyncOperationResponse delete(npm_npm_remote_href, opts)
 
+Delete a npm remote
 
 Trigger an asynchronous delete task
 
@@ -86,7 +87,7 @@ PulpNpmClient.configure do |config|
 end
 
 api_instance = PulpNpmClient::RemotesNpmApi.new
-npm_remote_href = 'npm_remote_href_example' # String | 
+npm_npm_remote_href = 'npm_npm_remote_href_example' # String | 
 opts = {
   name: 'name_example', # String | name
   name__in: 'name__in_example', # String | name__in
@@ -100,7 +101,8 @@ opts = {
 }
 
 begin
-  result = api_instance.delete(npm_remote_href, opts)
+  #Delete a npm remote
+  result = api_instance.delete(npm_npm_remote_href, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RemotesNpmApi->delete: #{e}"
@@ -112,7 +114,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_remote_href** | **String**|  | 
+ **npm_npm_remote_href** | **String**|  | 
  **name** | **String**| name | [optional] 
  **name__in** | **String**| name__in | [optional] 
  **ordering** | **String**| Which field to use when ordering the results. | [optional] 
@@ -141,7 +143,7 @@ Name | Type | Description  | Notes
 
 > InlineResponse2002 list(opts)
 
-
+List npm remotes
 
 A ViewSet for NpmRemote.  Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
 
@@ -175,6 +177,7 @@ opts = {
 }
 
 begin
+  #List npm remotes
   result = api_instance.list(opts)
   p result
 rescue PulpNpmClient::ApiError => e
@@ -217,9 +220,9 @@ Name | Type | Description  | Notes
 
 ## partial_update
 
-> AsyncOperationResponse partial_update(npm_remote_href, patchednpm_npm_remote, opts)
-
+> AsyncOperationResponse partial_update(npm_npm_remote_href, patchednpm_npm_remote, opts)
 
+Update a npm remote
 
 Trigger an asynchronous partial update task
 
@@ -236,7 +239,7 @@ PulpNpmClient.configure do |config|
 end
 
 api_instance = PulpNpmClient::RemotesNpmApi.new
-npm_remote_href = 'npm_remote_href_example' # String | 
+npm_npm_remote_href = 'npm_npm_remote_href_example' # String | 
 patchednpm_npm_remote = PulpNpmClient::PatchednpmNpmRemote.new # PatchednpmNpmRemote | 
 opts = {
   name: 'name_example', # String | name
@@ -251,7 +254,8 @@ opts = {
 }
 
 begin
-  result = api_instance.partial_update(npm_remote_href, patchednpm_npm_remote, opts)
+  #Update a npm remote
+  result = api_instance.partial_update(npm_npm_remote_href, patchednpm_npm_remote, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RemotesNpmApi->partial_update: #{e}"
@@ -263,7 +267,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_remote_href** | **String**|  | 
+ **npm_npm_remote_href** | **String**|  | 
  **patchednpm_npm_remote** | [**PatchednpmNpmRemote**](PatchednpmNpmRemote.md)|  | 
  **name** | **String**| name | [optional] 
  **name__in** | **String**| name__in | [optional] 
@@ -291,9 +295,9 @@ Name | Type | Description  | Notes
 
 ## read
 
-> NpmNpmRemoteResponse read(npm_remote_href, opts)
-
+> NpmNpmRemoteResponse read(npm_npm_remote_href, opts)
 
+Inspect a npm remote
 
 A ViewSet for NpmRemote.  Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
 
@@ -310,14 +314,15 @@ PulpNpmClient.configure do |config|
 end
 
 api_instance = PulpNpmClient::RemotesNpmApi.new
-npm_remote_href = 'npm_remote_href_example' # String | 
+npm_npm_remote_href = 'npm_npm_remote_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.
 }
 
 begin
-  result = api_instance.read(npm_remote_href, opts)
+  #Inspect a npm remote
+  result = api_instance.read(npm_npm_remote_href, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RemotesNpmApi->read: #{e}"
@@ -329,7 +334,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_remote_href** | **String**|  | 
+ **npm_npm_remote_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] 
 
@@ -349,9 +354,9 @@ Name | Type | Description  | Notes
 
 ## update
 
-> AsyncOperationResponse update(npm_remote_href, npm_npm_remote, opts)
-
+> AsyncOperationResponse update(npm_npm_remote_href, npm_npm_remote, opts)
 
+Update a npm remote
 
 Trigger an asynchronous update task
 
@@ -368,7 +373,7 @@ PulpNpmClient.configure do |config|
 end
 
 api_instance = PulpNpmClient::RemotesNpmApi.new
-npm_remote_href = 'npm_remote_href_example' # String | 
+npm_npm_remote_href = 'npm_npm_remote_href_example' # String | 
 npm_npm_remote = PulpNpmClient::NpmNpmRemote.new # NpmNpmRemote | 
 opts = {
   name: 'name_example', # String | name
@@ -383,7 +388,8 @@ opts = {
 }
 
 begin
-  result = api_instance.update(npm_remote_href, npm_npm_remote, opts)
+  #Update a npm remote
+  result = api_instance.update(npm_npm_remote_href, npm_npm_remote, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RemotesNpmApi->update: #{e}"
@@ -395,7 +401,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_remote_href** | **String**|  | 
+ **npm_npm_remote_href** | **String**|  | 
  **npm_npm_remote** | [**NpmNpmRemote**](NpmNpmRemote.md)|  | 
  **name** | **String**| name | [optional] 
  **name__in** | **String**| name__in | [optional] 

data/docs/RepositoriesNpmApi.md

@@ -4,14 +4,14 @@ All URIs are relative to *http://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**create**](RepositoriesNpmApi.md#create) | **POST** /pulp/api/v3/repositories/npm/npm/ | 
-[**delete**](RepositoriesNpmApi.md#delete) | **DELETE** {npm_repository_href} | 
-[**list**](RepositoriesNpmApi.md#list) | **GET** /pulp/api/v3/repositories/npm/npm/ | 
-[**modify**](RepositoriesNpmApi.md#modify) | **POST** {npm_repository_href}modify/ | Modify Repository Content
-[**partial_update**](RepositoriesNpmApi.md#partial_update) | **PATCH** {npm_repository_href} | 
-[**read**](RepositoriesNpmApi.md#read) | **GET** {npm_repository_href} | 
-[**sync**](RepositoriesNpmApi.md#sync) | **POST** {npm_repository_href}sync/ | Sync from remote
-[**update**](RepositoriesNpmApi.md#update) | **PUT** {npm_repository_href} | 
+[**create**](RepositoriesNpmApi.md#create) | **POST** /pulp/api/v3/repositories/npm/npm/ | Create a npm repository
+[**delete**](RepositoriesNpmApi.md#delete) | **DELETE** {npm_npm_repository_href} | Delete a npm repository
+[**list**](RepositoriesNpmApi.md#list) | **GET** /pulp/api/v3/repositories/npm/npm/ | List npm repositorys
+[**modify**](RepositoriesNpmApi.md#modify) | **POST** {npm_npm_repository_href}modify/ | Modify Repository Content
+[**partial_update**](RepositoriesNpmApi.md#partial_update) | **PATCH** {npm_npm_repository_href} | Update a npm repository
+[**read**](RepositoriesNpmApi.md#read) | **GET** {npm_npm_repository_href} | Inspect a npm repository
+[**sync**](RepositoriesNpmApi.md#sync) | **POST** {npm_npm_repository_href}sync/ | Sync from remote
+[**update**](RepositoriesNpmApi.md#update) | **PUT** {npm_npm_repository_href} | Update a npm repository
 
 
 
@@ -19,7 +19,7 @@ Method | HTTP request | Description
 
 > NpmNpmRepositoryResponse create(npm_npm_repository)
 
-
+Create a npm repository
 
 A ViewSet for NpmRepository.  Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
 
@@ -39,6 +39,7 @@ api_instance = PulpNpmClient::RepositoriesNpmApi.new
 npm_npm_repository = PulpNpmClient::NpmNpmRepository.new # NpmNpmRepository | 
 
 begin
+  #Create a npm repository
   result = api_instance.create(npm_npm_repository)
   p result
 rescue PulpNpmClient::ApiError => e
@@ -69,9 +70,9 @@ Name | Type | Description  | Notes
 
 ## delete
 
-> AsyncOperationResponse delete(npm_repository_href, opts)
-
+> AsyncOperationResponse delete(npm_npm_repository_href, opts)
 
+Delete a npm repository
 
 Trigger an asynchronous delete task
 
@@ -88,7 +89,7 @@ PulpNpmClient.configure do |config|
 end
 
 api_instance = PulpNpmClient::RepositoriesNpmApi.new
-npm_repository_href = 'npm_repository_href_example' # String | 
+npm_npm_repository_href = 'npm_npm_repository_href_example' # String | 
 opts = {
   name: 'name_example', # String | name
   name__in: 'name__in_example', # String | name__in
@@ -96,7 +97,8 @@ opts = {
 }
 
 begin
-  result = api_instance.delete(npm_repository_href, opts)
+  #Delete a npm repository
+  result = api_instance.delete(npm_npm_repository_href, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RepositoriesNpmApi->delete: #{e}"
@@ -108,7 +110,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_repository_href** | **String**|  | 
+ **npm_npm_repository_href** | **String**|  | 
  **name** | **String**| name | [optional] 
  **name__in** | **String**| name__in | [optional] 
  **ordering** | **String**| Which field to use when ordering the results. | [optional] 
@@ -131,7 +133,7 @@ Name | Type | Description  | Notes
 
 > InlineResponse2003 list(opts)
 
-
+List npm repositorys
 
 A ViewSet for NpmRepository.  Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
 
@@ -159,6 +161,7 @@ opts = {
 }
 
 begin
+  #List npm repositorys
   result = api_instance.list(opts)
   p result
 rescue PulpNpmClient::ApiError => e
@@ -195,7 +198,7 @@ Name | Type | Description  | Notes
 
 ## modify
 
-> AsyncOperationResponse modify(npm_repository_href, repository_add_remove_content)
+> AsyncOperationResponse modify(npm_npm_repository_href, repository_add_remove_content)
 
 Modify Repository Content
 
@@ -214,12 +217,12 @@ PulpNpmClient.configure do |config|
 end
 
 api_instance = PulpNpmClient::RepositoriesNpmApi.new
-npm_repository_href = 'npm_repository_href_example' # String | 
+npm_npm_repository_href = 'npm_npm_repository_href_example' # String | 
 repository_add_remove_content = PulpNpmClient::RepositoryAddRemoveContent.new # RepositoryAddRemoveContent | 
 
 begin
   #Modify Repository Content
-  result = api_instance.modify(npm_repository_href, repository_add_remove_content)
+  result = api_instance.modify(npm_npm_repository_href, repository_add_remove_content)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RepositoriesNpmApi->modify: #{e}"
@@ -231,7 +234,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_repository_href** | **String**|  | 
+ **npm_npm_repository_href** | **String**|  | 
  **repository_add_remove_content** | [**RepositoryAddRemoveContent**](RepositoryAddRemoveContent.md)|  | 
 
 ### Return type
@@ -250,9 +253,9 @@ Name | Type | Description  | Notes
 
 ## partial_update
 
-> AsyncOperationResponse partial_update(npm_repository_href, patchednpm_npm_repository, opts)
-
+> AsyncOperationResponse partial_update(npm_npm_repository_href, patchednpm_npm_repository, opts)
 
+Update a npm repository
 
 Trigger an asynchronous partial update task
 
@@ -269,7 +272,7 @@ PulpNpmClient.configure do |config|
 end
 
 api_instance = PulpNpmClient::RepositoriesNpmApi.new
-npm_repository_href = 'npm_repository_href_example' # String | 
+npm_npm_repository_href = 'npm_npm_repository_href_example' # String | 
 patchednpm_npm_repository = PulpNpmClient::PatchednpmNpmRepository.new # PatchednpmNpmRepository | 
 opts = {
   name: 'name_example', # String | name
@@ -278,7 +281,8 @@ opts = {
 }
 
 begin
-  result = api_instance.partial_update(npm_repository_href, patchednpm_npm_repository, opts)
+  #Update a npm repository
+  result = api_instance.partial_update(npm_npm_repository_href, patchednpm_npm_repository, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RepositoriesNpmApi->partial_update: #{e}"
@@ -290,7 +294,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_repository_href** | **String**|  | 
+ **npm_npm_repository_href** | **String**|  | 
  **patchednpm_npm_repository** | [**PatchednpmNpmRepository**](PatchednpmNpmRepository.md)|  | 
  **name** | **String**| name | [optional] 
  **name__in** | **String**| name__in | [optional] 
@@ -312,9 +316,9 @@ Name | Type | Description  | Notes
 
 ## read
 
-> NpmNpmRepositoryResponse read(npm_repository_href, opts)
-
+> NpmNpmRepositoryResponse read(npm_npm_repository_href, opts)
 
+Inspect a npm repository
 
 A ViewSet for NpmRepository.  Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
 
@@ -331,14 +335,15 @@ PulpNpmClient.configure do |config|
 end
 
 api_instance = PulpNpmClient::RepositoriesNpmApi.new
-npm_repository_href = 'npm_repository_href_example' # String | 
+npm_npm_repository_href = 'npm_npm_repository_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.
 }
 
 begin
-  result = api_instance.read(npm_repository_href, opts)
+  #Inspect a npm repository
+  result = api_instance.read(npm_npm_repository_href, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RepositoriesNpmApi->read: #{e}"
@@ -350,7 +355,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_repository_href** | **String**|  | 
+ **npm_npm_repository_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] 
 
@@ -370,7 +375,7 @@ Name | Type | Description  | Notes
 
 ## sync
 
-> AsyncOperationResponse sync(npm_repository_href, repository_sync_url)
+> AsyncOperationResponse sync(npm_npm_repository_href, repository_sync_url)
 
 Sync from remote
 
@@ -389,12 +394,12 @@ PulpNpmClient.configure do |config|
 end
 
 api_instance = PulpNpmClient::RepositoriesNpmApi.new
-npm_repository_href = 'npm_repository_href_example' # String | 
+npm_npm_repository_href = 'npm_npm_repository_href_example' # String | 
 repository_sync_url = PulpNpmClient::RepositorySyncURL.new # RepositorySyncURL | 
 
 begin
   #Sync from remote
-  result = api_instance.sync(npm_repository_href, repository_sync_url)
+  result = api_instance.sync(npm_npm_repository_href, repository_sync_url)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RepositoriesNpmApi->sync: #{e}"
@@ -406,7 +411,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_repository_href** | **String**|  | 
+ **npm_npm_repository_href** | **String**|  | 
  **repository_sync_url** | [**RepositorySyncURL**](RepositorySyncURL.md)|  | 
 
 ### Return type
@@ -425,9 +430,9 @@ Name | Type | Description  | Notes
 
 ## update
 
-> AsyncOperationResponse update(npm_repository_href, npm_npm_repository, opts)
-
+> AsyncOperationResponse update(npm_npm_repository_href, npm_npm_repository, opts)
 
+Update a npm repository
 
 Trigger an asynchronous update task
 
@@ -444,7 +449,7 @@ PulpNpmClient.configure do |config|
 end
 
 api_instance = PulpNpmClient::RepositoriesNpmApi.new
-npm_repository_href = 'npm_repository_href_example' # String | 
+npm_npm_repository_href = 'npm_npm_repository_href_example' # String | 
 npm_npm_repository = PulpNpmClient::NpmNpmRepository.new # NpmNpmRepository | 
 opts = {
   name: 'name_example', # String | name
@@ -453,7 +458,8 @@ opts = {
 }
 
 begin
-  result = api_instance.update(npm_repository_href, npm_npm_repository, opts)
+  #Update a npm repository
+  result = api_instance.update(npm_npm_repository_href, npm_npm_repository, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RepositoriesNpmApi->update: #{e}"
@@ -465,7 +471,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_repository_href** | **String**|  | 
+ **npm_npm_repository_href** | **String**|  | 
  **npm_npm_repository** | [**NpmNpmRepository**](NpmNpmRepository.md)|  | 
  **name** | **String**| name | [optional] 
  **name__in** | **String**| name__in | [optional]