pulp_npm_client 0.1.0a1.dev01595856770 → 0.1.0a1.dev01596245316

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/docs/RepositorySyncURL.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**remote** | **String** | A URI of the repository to be synchronized. | 
+**remote** | **String** | A remote to sync from. This will override a remote set on repository. | [optional] 
 **mirror** | **Boolean** | If ``True``, synchronization will remove all content that is not present in the remote repository. If ``False``, sync will be additive only. | [optional] [default to false]
 
 ## Code Sample

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] || {}

data/lib/pulp_npm_client/api/distributions_npm_api.rb

@@ -19,6 +19,7 @@ module PulpNpmClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Create a npm distribution
     # Trigger an asynchronous create task
     # @param npm_npm_distribution [NpmNpmDistribution] 
     # @param [Hash] opts the optional parameters
@@ -28,6 +29,7 @@ module PulpNpmClient
       data
     end
 
+    # Create a npm distribution
     # Trigger an asynchronous create task
     # @param npm_npm_distribution [NpmNpmDistribution] 
     # @param [Hash] opts the optional parameters
@@ -81,8 +83,9 @@ module PulpNpmClient
       return data, status_code, headers
     end
 
+    # Delete a npm distribution
     # Trigger an asynchronous delete task
-    # @param npm_distribution_href [String] 
+    # @param npm_npm_distribution_href [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :base_path base_path
     # @option opts [String] :base_path__contains base_path__contains
@@ -92,13 +95,14 @@ module PulpNpmClient
     # @option opts [String] :name__in name__in
     # @option opts [String] :ordering Which field to use when ordering the results.
     # @return [AsyncOperationResponse]
-    def delete(npm_distribution_href, opts = {})
-      data, _status_code, _headers = delete_with_http_info(npm_distribution_href, opts)
+    def delete(npm_npm_distribution_href, opts = {})
+      data, _status_code, _headers = delete_with_http_info(npm_npm_distribution_href, opts)
       data
     end
 
+    # Delete a npm distribution
     # Trigger an asynchronous delete task
-    # @param npm_distribution_href [String] 
+    # @param npm_npm_distribution_href [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :base_path base_path
     # @option opts [String] :base_path__contains base_path__contains
@@ -108,16 +112,16 @@ module PulpNpmClient
     # @option opts [String] :name__in name__in
     # @option opts [String] :ordering Which field to use when ordering the results.
     # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
-    def delete_with_http_info(npm_distribution_href, opts = {})
+    def delete_with_http_info(npm_npm_distribution_href, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DistributionsNpmApi.delete ...'
       end
-      # verify the required parameter 'npm_distribution_href' is set
-      if @api_client.config.client_side_validation && npm_distribution_href.nil?
-        fail ArgumentError, "Missing the required parameter 'npm_distribution_href' when calling DistributionsNpmApi.delete"
+      # verify the required parameter 'npm_npm_distribution_href' is set
+      if @api_client.config.client_side_validation && npm_npm_distribution_href.nil?
+        fail ArgumentError, "Missing the required parameter 'npm_npm_distribution_href' when calling DistributionsNpmApi.delete"
       end
       # resource path
-      local_var_path = '{npm_distribution_href}'.sub('{' + 'npm_distribution_href' + '}', CGI.escape(npm_distribution_href.to_s).gsub('%2F', '/'))
+      local_var_path = '{npm_npm_distribution_href}'.sub('{' + 'npm_npm_distribution_href' + '}', CGI.escape(npm_npm_distribution_href.to_s).gsub('%2F', '/'))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -162,6 +166,7 @@ module PulpNpmClient
       return data, status_code, headers
     end
 
+    # List npm distributions
     # ViewSet for NPM Distributions.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :base_path base_path
@@ -181,6 +186,7 @@ module PulpNpmClient
       data
     end
 
+    # List npm distributions
     # ViewSet for NPM Distributions.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :base_path base_path
@@ -249,8 +255,9 @@ module PulpNpmClient
       return data, status_code, headers
     end
 
+    # Update a npm distribution
     # Trigger an asynchronous partial update task
-    # @param npm_distribution_href [String] 
+    # @param npm_npm_distribution_href [String] 
     # @param patchednpm_npm_distribution [PatchednpmNpmDistribution] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :base_path base_path
@@ -261,13 +268,14 @@ module PulpNpmClient
     # @option opts [String] :name__in name__in
     # @option opts [String] :ordering Which field to use when ordering the results.
     # @return [AsyncOperationResponse]
-    def partial_update(npm_distribution_href, patchednpm_npm_distribution, opts = {})
-      data, _status_code, _headers = partial_update_with_http_info(npm_distribution_href, patchednpm_npm_distribution, opts)
+    def partial_update(npm_npm_distribution_href, patchednpm_npm_distribution, opts = {})
+      data, _status_code, _headers = partial_update_with_http_info(npm_npm_distribution_href, patchednpm_npm_distribution, opts)
       data
     end
 
+    # Update a npm distribution
     # Trigger an asynchronous partial update task
-    # @param npm_distribution_href [String] 
+    # @param npm_npm_distribution_href [String] 
     # @param patchednpm_npm_distribution [PatchednpmNpmDistribution] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :base_path base_path
@@ -278,20 +286,20 @@ module PulpNpmClient
     # @option opts [String] :name__in name__in
     # @option opts [String] :ordering Which field to use when ordering the results.
     # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
-    def partial_update_with_http_info(npm_distribution_href, patchednpm_npm_distribution, opts = {})
+    def partial_update_with_http_info(npm_npm_distribution_href, patchednpm_npm_distribution, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DistributionsNpmApi.partial_update ...'
       end
-      # verify the required parameter 'npm_distribution_href' is set
-      if @api_client.config.client_side_validation && npm_distribution_href.nil?
-        fail ArgumentError, "Missing the required parameter 'npm_distribution_href' when calling DistributionsNpmApi.partial_update"
+      # verify the required parameter 'npm_npm_distribution_href' is set
+      if @api_client.config.client_side_validation && npm_npm_distribution_href.nil?
+        fail ArgumentError, "Missing the required parameter 'npm_npm_distribution_href' when calling DistributionsNpmApi.partial_update"
       end
       # verify the required parameter 'patchednpm_npm_distribution' is set
       if @api_client.config.client_side_validation && patchednpm_npm_distribution.nil?
         fail ArgumentError, "Missing the required parameter 'patchednpm_npm_distribution' when calling DistributionsNpmApi.partial_update"
       end
       # resource path
-      local_var_path = '{npm_distribution_href}'.sub('{' + 'npm_distribution_href' + '}', CGI.escape(npm_distribution_href.to_s).gsub('%2F', '/'))
+      local_var_path = '{npm_npm_distribution_href}'.sub('{' + 'npm_npm_distribution_href' + '}', CGI.escape(npm_npm_distribution_href.to_s).gsub('%2F', '/'))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -338,33 +346,35 @@ module PulpNpmClient
       return data, status_code, headers
     end
 
+    # Inspect a npm distribution
     # ViewSet for NPM Distributions.
-    # @param npm_distribution_href [String] 
+    # @param npm_npm_distribution_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 [NpmNpmDistributionResponse]
-    def read(npm_distribution_href, opts = {})
-      data, _status_code, _headers = read_with_http_info(npm_distribution_href, opts)
+    def read(npm_npm_distribution_href, opts = {})
+      data, _status_code, _headers = read_with_http_info(npm_npm_distribution_href, opts)
       data
     end
 
+    # Inspect a npm distribution
     # ViewSet for NPM Distributions.
-    # @param npm_distribution_href [String] 
+    # @param npm_npm_distribution_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<(NpmNpmDistributionResponse, Integer, Hash)>] NpmNpmDistributionResponse data, response status code and response headers
-    def read_with_http_info(npm_distribution_href, opts = {})
+    def read_with_http_info(npm_npm_distribution_href, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DistributionsNpmApi.read ...'
       end
-      # verify the required parameter 'npm_distribution_href' is set
-      if @api_client.config.client_side_validation && npm_distribution_href.nil?
-        fail ArgumentError, "Missing the required parameter 'npm_distribution_href' when calling DistributionsNpmApi.read"
+      # verify the required parameter 'npm_npm_distribution_href' is set
+      if @api_client.config.client_side_validation && npm_npm_distribution_href.nil?
+        fail ArgumentError, "Missing the required parameter 'npm_npm_distribution_href' when calling DistributionsNpmApi.read"
       end
       # resource path
-      local_var_path = '{npm_distribution_href}'.sub('{' + 'npm_distribution_href' + '}', CGI.escape(npm_distribution_href.to_s).gsub('%2F', '/'))
+      local_var_path = '{npm_npm_distribution_href}'.sub('{' + 'npm_npm_distribution_href' + '}', CGI.escape(npm_npm_distribution_href.to_s).gsub('%2F', '/'))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -404,8 +414,9 @@ module PulpNpmClient
       return data, status_code, headers
     end
 
+    # Update a npm distribution
     # Trigger an asynchronous update task
-    # @param npm_distribution_href [String] 
+    # @param npm_npm_distribution_href [String] 
     # @param npm_npm_distribution [NpmNpmDistribution] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :base_path base_path
@@ -416,13 +427,14 @@ module PulpNpmClient
     # @option opts [String] :name__in name__in
     # @option opts [String] :ordering Which field to use when ordering the results.
     # @return [AsyncOperationResponse]
-    def update(npm_distribution_href, npm_npm_distribution, opts = {})
-      data, _status_code, _headers = update_with_http_info(npm_distribution_href, npm_npm_distribution, opts)
+    def update(npm_npm_distribution_href, npm_npm_distribution, opts = {})
+      data, _status_code, _headers = update_with_http_info(npm_npm_distribution_href, npm_npm_distribution, opts)
       data
     end
 
+    # Update a npm distribution
     # Trigger an asynchronous update task
-    # @param npm_distribution_href [String] 
+    # @param npm_npm_distribution_href [String] 
     # @param npm_npm_distribution [NpmNpmDistribution] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :base_path base_path
@@ -433,20 +445,20 @@ module PulpNpmClient
     # @option opts [String] :name__in name__in
     # @option opts [String] :ordering Which field to use when ordering the results.
     # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
-    def update_with_http_info(npm_distribution_href, npm_npm_distribution, opts = {})
+    def update_with_http_info(npm_npm_distribution_href, npm_npm_distribution, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DistributionsNpmApi.update ...'
       end
-      # verify the required parameter 'npm_distribution_href' is set
-      if @api_client.config.client_side_validation && npm_distribution_href.nil?
-        fail ArgumentError, "Missing the required parameter 'npm_distribution_href' when calling DistributionsNpmApi.update"
+      # verify the required parameter 'npm_npm_distribution_href' is set
+      if @api_client.config.client_side_validation && npm_npm_distribution_href.nil?
+        fail ArgumentError, "Missing the required parameter 'npm_npm_distribution_href' when calling DistributionsNpmApi.update"
       end
       # verify the required parameter 'npm_npm_distribution' is set
       if @api_client.config.client_side_validation && npm_npm_distribution.nil?
         fail ArgumentError, "Missing the required parameter 'npm_npm_distribution' when calling DistributionsNpmApi.update"
       end
       # resource path
-      local_var_path = '{npm_distribution_href}'.sub('{' + 'npm_distribution_href' + '}', CGI.escape(npm_distribution_href.to_s).gsub('%2F', '/'))
+      local_var_path = '{npm_npm_distribution_href}'.sub('{' + 'npm_npm_distribution_href' + '}', CGI.escape(npm_npm_distribution_href.to_s).gsub('%2F', '/'))
 
       # query parameters
       query_params = opts[:query_params] || {}