harbor_swagger_client 1.0.2 → 1.0.3

data/spec/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/spec/api/chart_repository_api_spec.rb

@@ -3,7 +3,7 @@
 
 #These APIs provide services for manipulating Harbor project.
 
-OpenAPI spec version: 1.9.0
+OpenAPI spec version: 1.10.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.7
@@ -49,7 +49,7 @@ describe 'ChartRepositoryApi' do
   # Check the health of chart repository service.
   # Check the health of chart repository service.
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2001]
+  # @return [InlineResponse200]
   describe 'chartrepo_health_get test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/api/label_api_spec.rb

@@ -3,7 +3,7 @@
 
 #These APIs provide services for manipulating Harbor project.
 
-OpenAPI spec version: 1.9.0
+OpenAPI spec version: 1.10.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.7

data/spec/api/products_api_spec.rb

@@ -3,7 +3,7 @@
 
 #These APIs provide services for manipulating Harbor project.
 
-OpenAPI spec version: 1.9.0
+OpenAPI spec version: 1.10.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.7
@@ -49,7 +49,7 @@ describe 'ProductsApi' do
   # Check the health of chart repository service.
   # Check the health of chart repository service.
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2001]
+  # @return [InlineResponse200]
   describe 'chartrepo_health_get test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -482,6 +482,56 @@ describe 'ProductsApi' do
     end
   end
 
+  # unit tests for projects_project_id_immutabletagrules_get
+  # List all immutable tag rules of current project
+  # This endpoint returns the immutable tag rules of a project 
+  # @param project_id Relevant project ID.
+  # @param [Hash] opts the optional parameters
+  # @return [Array<ImmutableTagRule>]
+  describe 'projects_project_id_immutabletagrules_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for projects_project_id_immutabletagrules_id_delete
+  # Delete the immutable tag rule.
+  # @param project_id Relevant project ID.
+  # @param id Immutable tag rule ID.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'projects_project_id_immutabletagrules_id_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for projects_project_id_immutabletagrules_id_put
+  # Update the immutable tag rule or enable or disable the rule
+  # @param project_id Relevant project ID.
+  # @param id Immutable tag rule ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [ImmutableTagRule] :immutabletagrule 
+  # @return [nil]
+  describe 'projects_project_id_immutabletagrules_id_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for projects_project_id_immutabletagrules_post
+  # Add an immutable tag rule to current project
+  # This endpoint add an immutable tag rule to the project 
+  # @param project_id Relevant project ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [ImmutableTagRule] :immutabletagrule 
+  # @return [nil]
+  describe 'projects_project_id_immutabletagrules_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for projects_project_id_logs_get
   # Get access logs accompany with a relevant project.
   # This endpoint let user search access logs filtered by operations and date time ranges. 
@@ -709,6 +759,30 @@ describe 'ProductsApi' do
     end
   end
 
+  # unit tests for projects_project_id_scanner_candidates_get
+  # Get scanner registration candidates for configurating project level scanner
+  # Retrieve the system configured scanner registrations as candidates of setting project level scanner. 
+  # @param project_id The project identifier.
+  # @param [Hash] opts the optional parameters
+  # @return [Array<ScannerRegistration>]
+  describe 'projects_project_id_scanner_candidates_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for projects_project_id_scanner_get
+  # Get project level scanner
+  # Get the scanner registration of the specified project. If no scanner registration is configured for the specified project, the system default scanner registration will be returned.
+  # @param project_id The project identifier.
+  # @param [Hash] opts the optional parameters
+  # @return [ScannerRegistration]
+  describe 'projects_project_id_scanner_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for projects_project_id_summary_get
   # Get summary of the project.
   # Get summary of the project.
@@ -824,6 +898,47 @@ describe 'ProductsApi' do
     end
   end
 
+  # unit tests for quotas_get
+  # List quotas
+  # List quotas
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :reference The reference type of quota.
+  # @option opts [String] :reference_id The reference id of quota.
+  # @option opts [String] :sort Sort method, valid values include: &#39;hard.resource_name&#39;, &#39;-hard.resource_name&#39;, &#39;used.resource_name&#39;, &#39;-used.resource_name&#39;. Here &#39;-&#39; stands for descending order, resource_name should be the real resource name of the quota. 
+  # @option opts [Integer] :page The page number, default is 1.
+  # @option opts [Integer] :page_size The size of per page, default is 10, maximum is 100.
+  # @return [Array<Quota>]
+  describe 'quotas_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for quotas_id_get
+  # Get the specified quota
+  # Get the specified quota
+  # @param id Quota ID
+  # @param [Hash] opts the optional parameters
+  # @return [Quota]
+  describe 'quotas_id_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for quotas_id_put
+  # Update the specified quota
+  # Update hard limits of the specified quota
+  # @param id Quota ID
+  # @param hard The new hard limits for the quota
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'quotas_id_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for registries_get
   # List registries.
   # This endpoint let user list filtered registries by name, if name is nil, list returns all registries. 
@@ -1275,7 +1390,7 @@ describe 'ProductsApi' do
 
   # unit tests for repositories_repo_name_tags_tag_scan_post
   # Scan the image.
-  # Trigger jobservice to call Clair API to scan the image identified by the repo_name and tag.  Only project admins have permission to scan images under the project. 
+  # Trigger a scan targeting the artifact identified by the repo_name and tag. 
   # @param repo_name Repository name
   # @param tag Tag name
   # @param [Hash] opts the optional parameters
@@ -1286,14 +1401,15 @@ describe 'ProductsApi' do
     end
   end
 
-  # unit tests for repositories_repo_name_tags_tag_vulnerability_details_get
-  # Get vulnerability details of the image.
-  # Call Clair API to get the vulnerability based on the previous successful scan. 
+  # unit tests for repositories_repo_name_tags_tag_scan_uuid_log_get
+  # Get scan log
+  # Get the log text stream for the given artifact and scan action.
   # @param repo_name Repository name
   # @param tag Tag name
+  # @param uuid the scan unique identifier
   # @param [Hash] opts the optional parameters
-  # @return [Array<VulnerabilityItem>]
-  describe 'repositories_repo_name_tags_tag_vulnerability_details_get test' do
+  # @return [String]
+  describe 'repositories_repo_name_tags_tag_scan_uuid_log_get test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
@@ -1425,6 +1541,75 @@ describe 'ProductsApi' do
     end
   end
 
+  # unit tests for scanners_get
+  # List scanner registrations
+  # Returns a list of currently configured scanner registrations. 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<ScannerRegistration>]
+  describe 'scanners_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for scanners_ping_post
+  # Tests scanner registration settings
+  # Pings scanner adapter to test endpoint URL and authorization settings. 
+  # @param settings A scanner registration settings to be tested.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'scanners_ping_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for scanners_registration_id_get
+  # Get a scanner registration details
+  # Retruns the details of the specified scanner registration. 
+  # @param registration_id The scanner registration identifer.
+  # @param [Hash] opts the optional parameters
+  # @return [ScannerRegistration]
+  describe 'scanners_registration_id_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for scanners_registration_id_metadata_get
+  # Get the metadata of the specified scanner registration
+  # Get the metadata of the specified scanner registration, including the capabilities and customzied properties. 
+  # @param registration_id The scanner registration identifier.
+  # @param [Hash] opts the optional parameters
+  # @return [ScannerAdapterMetadata]
+  describe 'scanners_registration_id_metadata_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for scans_all_metrics_get
+  # Get the metrics of the latest scan all process
+  # Get the metrics of the latest scan all process
+  # @param [Hash] opts the optional parameters
+  # @return [Stats]
+  describe 'scans_all_metrics_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for scans_schedule_metrics_get
+  # Get the metrics of the latest scheduled scan all process
+  # Get the metrics of the latest scheduled scan all process
+  # @param [Hash] opts the optional parameters
+  # @return [Stats]
+  describe 'scans_schedule_metrics_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for search_get
   # Search for projects, repositories and helm charts
   # The Search endpoint returns information about the projects ,repositories  and helm charts offered at public status or related to the current logged in user. The response includes the project, repository list and charts in a proper display order. 
@@ -1746,25 +1931,26 @@ describe 'ProductsApi' do
     end
   end
 
-  # unit tests for users_user_id_delete
-  # Mark a registered user as be removed.
-  # This endpoint let administrator of Harbor mark a registered user as be removed.It actually won&#39;t be deleted from DB. 
-  # @param user_id User ID for marking as to be removed.
+  # unit tests for users_user_id_cli_secret_put
+  # Set CLI secret for a user.
+  # This endpoint let user generate a new CLI secret for himself.  This API only works when auth mode is set to &#39;OIDC&#39;. Once this API returns with successful status, the old secret will be invalid, as there will be only one CLI secret for a user. 
+  # @param user_id User ID
+  # @param input_secret JSON object that includes the new secret
   # @param [Hash] opts the optional parameters
   # @return [nil]
-  describe 'users_user_id_delete test' do
+  describe 'users_user_id_cli_secret_put test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  # unit tests for users_user_id_gen_cli_secret_post
-  # Generate new CLI secret for a user.
-  # This endpoint let user generate a new CLI secret for himself.  This API only works when auth mode is set to &#39;OIDC&#39;. Once this API returns with successful status, the old secret will be invalid, as there will be only one CLI secret for a user.  The new secret will be returned in the response. 
-  # @param user_id User ID
+  # unit tests for users_user_id_delete
+  # Mark a registered user as be removed.
+  # This endpoint let administrator of Harbor mark a registered user as be removed.It actually won&#39;t be deleted from DB. 
+  # @param user_id User ID for marking as to be removed.
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse200]
-  describe 'users_user_id_gen_cli_secret_post test' do
+  # @return [nil]
+  describe 'users_user_id_delete test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end

data/spec/api/quota_api_spec.rb

@@ -3,7 +3,7 @@
 
 #These APIs provide services for manipulating Harbor project.
 
-OpenAPI spec version: 1.9.0
+OpenAPI spec version: 1.10.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.7
@@ -32,21 +32,6 @@ describe 'QuotaApi' do
     end
   end
 
-  # unit tests for quotas_get
-  # List quotas
-  # List quotas
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :reference The reference type of quota.
-  # @option opts [String] :sort Sort method, valid values include: 'hard.resource_name', '-hard.resource_name', 'used.resource_name', '-used.resource_name'. Here '-' stands for descending order, resource_name should be the real resource name of the quota. 
-  # @option opts [Integer] :page The page number, default is 1.
-  # @option opts [Integer] :page_size The size of per page, default is 10, maximum is 100.
-  # @return [Array<Quota>]
-  describe 'quotas_get test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
   # unit tests for quotas_id_get
   # Get the specified quota
   # Get the specified quota

data/spec/api/retention_api_spec.rb

@@ -3,7 +3,7 @@
 
 #These APIs provide services for manipulating Harbor project.
 
-OpenAPI spec version: 1.9.0
+OpenAPI spec version: 1.10.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.7

data/spec/api/robot_account_api_spec.rb

@@ -3,7 +3,7 @@
 
 #These APIs provide services for manipulating Harbor project.
 
-OpenAPI spec version: 1.9.0
+OpenAPI spec version: 1.10.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.7

data/spec/api/scan_api_spec.rb

@@ -0,0 +1,98 @@
+=begin
+#Harbor API
+
+#These APIs provide services for manipulating Harbor project.
+
+OpenAPI spec version: 1.10.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.7
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SwaggerClient::ScanApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ScanApi' do
+  before do
+    # run before each test
+    @instance = SwaggerClient::ScanApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ScanApi' do
+    it 'should create an instance of ScanApi' do
+      expect(@instance).to be_instance_of(SwaggerClient::ScanApi)
+    end
+  end
+
+  # unit tests for repositories_repo_name_tags_tag_scan_get
+  # Get the scan report
+  # Retrieve the scan report for the artifact identified by the repo_name and tag. 
+  # @param repo_name Repository name
+  # @param tag Tag name
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :accept Mimetype in header. e.g: \"application/vnd.scanner.adapter.vuln.report.harbor+json; version=1.0\" 
+  # @return [Report]
+  describe 'repositories_repo_name_tags_tag_scan_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for repositories_repo_name_tags_tag_scan_post
+  # Scan the image.
+  # Trigger a scan targeting the artifact identified by the repo_name and tag. 
+  # @param repo_name Repository name
+  # @param tag Tag name
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'repositories_repo_name_tags_tag_scan_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for repositories_repo_name_tags_tag_scan_uuid_log_get
+  # Get scan log
+  # Get the log text stream for the given artifact and scan action.
+  # @param repo_name Repository name
+  # @param tag Tag name
+  # @param uuid the scan unique identifier
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'repositories_repo_name_tags_tag_scan_uuid_log_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for scans_all_metrics_get
+  # Get the metrics of the latest scan all process
+  # Get the metrics of the latest scan all process
+  # @param [Hash] opts the optional parameters
+  # @return [Stats]
+  describe 'scans_all_metrics_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for scans_schedule_metrics_get
+  # Get the metrics of the latest scheduled scan all process
+  # Get the metrics of the latest scheduled scan all process
+  # @param [Hash] opts the optional parameters
+  # @return [Stats]
+  describe 'scans_schedule_metrics_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end