pulp_npm_client 0.1.0a1.dev01595899927 → 0.1.0a1.dev01596331690

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] 

data/docs/RepositoriesNpmVersionsApi.md

@@ -4,18 +4,18 @@ All URIs are relative to *http://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**delete**](RepositoriesNpmVersionsApi.md#delete) | **DELETE** {npm_repository_version_href} | 
-[**list**](RepositoriesNpmVersionsApi.md#list) | **GET** {npm_repository_version_href}versions/ | 
-[**read**](RepositoriesNpmVersionsApi.md#read) | **GET** {npm_repository_version_href} | 
-[**repair**](RepositoriesNpmVersionsApi.md#repair) | **POST** {npm_repository_version_href}repair/ | 
+[**delete**](RepositoriesNpmVersionsApi.md#delete) | **DELETE** {npm_npm_repository_version_href} | Delete a repository version
+[**list**](RepositoriesNpmVersionsApi.md#list) | **GET** {npm_npm_repository_href}versions/ | List repository versions
+[**read**](RepositoriesNpmVersionsApi.md#read) | **GET** {npm_npm_repository_version_href} | Inspect a repository version
+[**repair**](RepositoriesNpmVersionsApi.md#repair) | **POST** {npm_npm_repository_version_href}repair/ | 
 
 
 
 ## delete
 
-> AsyncOperationResponse delete(npm_repository_version_href, opts)
-
+> AsyncOperationResponse delete(npm_npm_repository_version_href, opts)
 
+Delete a repository version
 
 Trigger an asynchronous task to delete a repositroy version.
 
@@ -32,7 +32,7 @@ PulpNpmClient.configure do |config|
 end
 
 api_instance = PulpNpmClient::RepositoriesNpmVersionsApi.new
-npm_repository_version_href = 'npm_repository_version_href_example' # String | 
+npm_npm_repository_version_href = 'npm_npm_repository_version_href_example' # String | 
 opts = {
   content: 'content_example', # String | content
   content__in: 'content__in_example', # String | content__in
@@ -52,7 +52,8 @@ opts = {
 }
 
 begin
-  result = api_instance.delete(npm_repository_version_href, opts)
+  #Delete a repository version
+  result = api_instance.delete(npm_npm_repository_version_href, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RepositoriesNpmVersionsApi->delete: #{e}"
@@ -64,7 +65,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_repository_version_href** | **String**|  | 
+ **npm_npm_repository_version_href** | **String**|  | 
  **content** | **String**| content | [optional] 
  **content__in** | **String**| content__in | [optional] 
  **number** | **String**| number | [optional] 
@@ -97,9 +98,9 @@ Name | Type | Description  | Notes
 
 ## list
 
-> InlineResponse2004 list(npm_repository_version_href, opts)
-
+> InlineResponse2004 list(npm_npm_repository_href, opts)
 
+List repository versions
 
 A ViewSet for a NpmRepositoryVersion represents a single Npm repository version.
 
@@ -116,7 +117,7 @@ PulpNpmClient.configure do |config|
 end
 
 api_instance = PulpNpmClient::RepositoriesNpmVersionsApi.new
-npm_repository_version_href = 'npm_repository_version_href_example' # String | 
+npm_npm_repository_href = 'npm_npm_repository_href_example' # String | 
 opts = {
   content: 'content_example', # String | content
   content__in: 'content__in_example', # String | content__in
@@ -140,7 +141,8 @@ opts = {
 }
 
 begin
-  result = api_instance.list(npm_repository_version_href, opts)
+  #List repository versions
+  result = api_instance.list(npm_npm_repository_href, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RepositoriesNpmVersionsApi->list: #{e}"
@@ -152,7 +154,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_repository_version_href** | **String**|  | 
+ **npm_npm_repository_href** | **String**|  | 
  **content** | **String**| content | [optional] 
  **content__in** | **String**| content__in | [optional] 
  **limit** | **Integer**| Number of results to return per page. | [optional] 
@@ -189,9 +191,9 @@ Name | Type | Description  | Notes
 
 ## read
 
-> RepositoryVersionResponse read(npm_repository_version_href, opts)
-
+> RepositoryVersionResponse read(npm_npm_repository_version_href, opts)
 
+Inspect a repository version
 
 A ViewSet for a NpmRepositoryVersion represents a single Npm repository version.
 
@@ -208,14 +210,15 @@ PulpNpmClient.configure do |config|
 end
 
 api_instance = PulpNpmClient::RepositoriesNpmVersionsApi.new
-npm_repository_version_href = 'npm_repository_version_href_example' # String | 
+npm_npm_repository_version_href = 'npm_npm_repository_version_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_version_href, opts)
+  #Inspect a repository version
+  result = api_instance.read(npm_npm_repository_version_href, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RepositoriesNpmVersionsApi->read: #{e}"
@@ -227,7 +230,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_repository_version_href** | **String**|  | 
+ **npm_npm_repository_version_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] 
 
@@ -247,7 +250,7 @@ Name | Type | Description  | Notes
 
 ## repair
 
-> AsyncOperationResponse repair(npm_repository_version_href, repository_version)
+> AsyncOperationResponse repair(npm_npm_repository_version_href, repository_version)
 
 
 
@@ -266,11 +269,11 @@ PulpNpmClient.configure do |config|
 end
 
 api_instance = PulpNpmClient::RepositoriesNpmVersionsApi.new
-npm_repository_version_href = 'npm_repository_version_href_example' # String | 
+npm_npm_repository_version_href = 'npm_npm_repository_version_href_example' # String | 
 repository_version = PulpNpmClient::RepositoryVersion.new # RepositoryVersion | 
 
 begin
-  result = api_instance.repair(npm_repository_version_href, repository_version)
+  result = api_instance.repair(npm_npm_repository_version_href, repository_version)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RepositoriesNpmVersionsApi->repair: #{e}"
@@ -282,7 +285,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_repository_version_href** | **String**|  | 
+ **npm_npm_repository_version_href** | **String**|  | 
  **repository_version** | [**RepositoryVersion**](RepositoryVersion.md)|  | 
 
 ### Return type

data/lib/pulp_npm_client/api/content_packages_api.rb

@@ -19,6 +19,7 @@ module PulpNpmClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # 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.
     # @param relative_path [String] 
     # @param name [String] 
@@ -33,6 +34,7 @@ module PulpNpmClient
       data
     end
 
+    # 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.
     # @param relative_path [String] 
     # @param name [String] 
@@ -105,6 +107,7 @@ module PulpNpmClient
       return data, status_code, headers
     end
 
+    # 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.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number of results to return per page.
@@ -123,6 +126,7 @@ module PulpNpmClient
       data
     end
 
+    # 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.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number of results to return per page.
@@ -189,33 +193,35 @@ module PulpNpmClient
       return data, status_code, headers
     end
 
+    # 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.
-    # @param package_href [String] 
+    # @param npm_package_href [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :fields A list of fields to include in the response.
     # @option opts [String] :exclude_fields A list of fields to exclude from the response.
     # @return [NpmPackageResponse]
-    def read(package_href, opts = {})
-      data, _status_code, _headers = read_with_http_info(package_href, opts)
+    def read(npm_package_href, opts = {})
+      data, _status_code, _headers = read_with_http_info(npm_package_href, opts)
       data
     end
 
+    # 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.
-    # @param package_href [String] 
+    # @param npm_package_href [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :fields A list of fields to include in the response.
     # @option opts [String] :exclude_fields A list of fields to exclude from the response.
     # @return [Array<(NpmPackageResponse, Integer, Hash)>] NpmPackageResponse data, response status code and response headers
-    def read_with_http_info(package_href, opts = {})
+    def read_with_http_info(npm_package_href, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ContentPackagesApi.read ...'
       end
-      # verify the required parameter 'package_href' is set
-      if @api_client.config.client_side_validation && package_href.nil?
-        fail ArgumentError, "Missing the required parameter 'package_href' when calling ContentPackagesApi.read"
+      # verify the required parameter 'npm_package_href' is set
+      if @api_client.config.client_side_validation && npm_package_href.nil?
+        fail ArgumentError, "Missing the required parameter 'npm_package_href' when calling ContentPackagesApi.read"
       end
       # resource path
-      local_var_path = '{package_href}'.sub('{' + 'package_href' + '}', CGI.escape(package_href.to_s).gsub('%2F', '/'))
+      local_var_path = '{npm_package_href}'.sub('{' + 'npm_package_href' + '}', CGI.escape(npm_package_href.to_s).gsub('%2F', '/'))
 
       # query parameters
       query_params = opts[:query_params] || {}