harbor2_client 0.1.0 → 2.3.3.3

data/spec/api/robotv1_api_spec.rb

@@ -0,0 +1,114 @@
+=begin
+#Harbor API
+
+#These APIs provide services for manipulating Harbor project.
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.22
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Harbor2Client::Robotv1Api
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'Robotv1Api' do
+  before do
+    # run before each test
+    @instance = Harbor2Client::Robotv1Api.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of Robotv1Api' do
+    it 'should create an instance of Robotv1Api' do
+      expect(@instance).to be_instance_of(Harbor2Client::Robotv1Api)
+    end
+  end
+
+  # unit tests for create_robot_v1
+  # Create a robot account
+  # Create a robot account
+  # @param project_name_or_id The name or id of the project
+  # @param robot The JSON object of a robot account.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @option opts [BOOLEAN] :x_is_resource_name The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
+  # @return [RobotCreated]
+  describe 'create_robot_v1 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 delete_robot_v1
+  # Delete a robot account
+  # This endpoint deletes specific robot account information by robot ID.
+  # @param project_name_or_id The name or id of the project
+  # @param robot_id Robot ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @option opts [BOOLEAN] :x_is_resource_name The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
+  # @return [nil]
+  describe 'delete_robot_v1 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 get_robot_by_idv1
+  # Get a robot account
+  # This endpoint returns specific robot account information by robot ID.
+  # @param project_name_or_id The name or id of the project
+  # @param robot_id Robot ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @option opts [BOOLEAN] :x_is_resource_name The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
+  # @return [Robot]
+  describe 'get_robot_by_idv1 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 list_robot_v1
+  # Get all robot accounts of specified project
+  # Get all robot accounts of specified project
+  # @param project_name_or_id The name or id of the project
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @option opts [BOOLEAN] :x_is_resource_name The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
+  # @option opts [Integer] :page The page number
+  # @option opts [Integer] :page_size The size of per page
+  # @option opts [String] :q Query string to query resources. Supported query patterns are \"exact match(k=v)\", \"fuzzy match(k=~v)\", \"range(k=[min~max])\", \"list with union releationship(k={v1 v2 v3})\" and \"list with intersetion relationship(k=(v1 v2 v3))\". The value of range and list can be string(enclosed by \" or '), integer or time(in format \"2020-04-09 02:36:00\"). All of these query patterns should be put in the query string \"q=xxx\" and splitted by \",\". e.g. q=k1=v1,k2=~v2,k3=[min~max]
+  # @option opts [String] :sort Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending orderr and field2 in descending order with \"sort=field1,-field2\"
+  # @return [Array<Robot>]
+  describe 'list_robot_v1 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 update_robot_v1
+  # Update status of robot account.
+  # Used to disable/enable a specified robot account.
+  # @param project_name_or_id The name or id of the project
+  # @param robot_id Robot ID
+  # @param robot The JSON object of a robot account.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @option opts [BOOLEAN] :x_is_resource_name The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
+  # @return [nil]
+  describe 'update_robot_v1 test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/scan_all_api_spec.rb

@@ -0,0 +1,97 @@
+=begin
+#Harbor API
+
+#These APIs provide services for manipulating Harbor project.
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.22
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Harbor2Client::ScanAllApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ScanAllApi' do
+  before do
+    # run before each test
+    @instance = Harbor2Client::ScanAllApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ScanAllApi' do
+    it 'should create an instance of ScanAllApi' do
+      expect(@instance).to be_instance_of(Harbor2Client::ScanAllApi)
+    end
+  end
+
+  # unit tests for create_scan_all_schedule
+  # Create a schedule or a manual trigger for the scan all job.
+  # This endpoint is for creating a schedule or a manual trigger for the scan all job, which scans all of images in Harbor.
+  # @param schedule Create a schedule or a manual trigger for the scan all job.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [nil]
+  describe 'create_scan_all_schedule 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 get_latest_scan_all_metrics
+  # Get the metrics of the latest scan all process
+  # Get the metrics of the latest scan all process
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [Stats]
+  describe 'get_latest_scan_all_metrics 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 get_latest_scheduled_scan_all_metrics
+  # 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
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [Stats]
+  describe 'get_latest_scheduled_scan_all_metrics 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 get_scan_all_schedule
+  # Get scan all's schedule.
+  # This endpoint is for getting a schedule for the scan all job, which scans all of images in Harbor.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [Schedule]
+  describe 'get_scan_all_schedule 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 update_scan_all_schedule
+  # Update scan all's schedule.
+  # This endpoint is for updating the schedule of scan all job, which scans all of images in Harbor.
+  # @param schedule Updates the schedule of scan all job, which scans all of images in Harbor.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [nil]
+  describe 'update_scan_all_schedule test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/scan_api_spec.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.17
+Swagger Codegen version: 2.4.22
 
 =end
 

data/spec/api/scanner_api_spec.rb

@@ -0,0 +1,144 @@
+=begin
+#Harbor API
+
+#These APIs provide services for manipulating Harbor project.
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.22
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Harbor2Client::ScannerApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ScannerApi' do
+  before do
+    # run before each test
+    @instance = Harbor2Client::ScannerApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ScannerApi' do
+    it 'should create an instance of ScannerApi' do
+      expect(@instance).to be_instance_of(Harbor2Client::ScannerApi)
+    end
+  end
+
+  # unit tests for create_scanner
+  # Create a scanner registration
+  # Creats a new scanner registration with the given data. 
+  # @param registration A scanner registration to be created.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [nil]
+  describe 'create_scanner 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 delete_scanner
+  # Delete a scanner registration
+  # Deletes the specified scanner registration. 
+  # @param registration_id The scanner registration identifier.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [ScannerRegistration]
+  describe 'delete_scanner 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 get_scanner
+  # 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
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [ScannerRegistration]
+  describe 'get_scanner 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 get_scanner_metadata
+  # Get the metadata of the specified scanner registration
+  # Get the metadata of the specified scanner registration, including the capabilities and customized properties. 
+  # @param registration_id The scanner registration identifier.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [ScannerAdapterMetadata]
+  describe 'get_scanner_metadata 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 list_scanners
+  # List scanner registrations
+  # Returns a list of currently configured scanner registrations. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @option opts [String] :q Query string to query resources. Supported query patterns are \"exact match(k=v)\", \"fuzzy match(k=~v)\", \"range(k=[min~max])\", \"list with union releationship(k={v1 v2 v3})\" and \"list with intersetion relationship(k=(v1 v2 v3))\". The value of range and list can be string(enclosed by \" or '), integer or time(in format \"2020-04-09 02:36:00\"). All of these query patterns should be put in the query string \"q=xxx\" and splitted by \",\". e.g. q=k1=v1,k2=~v2,k3=[min~max]
+  # @option opts [String] :sort Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending orderr and field2 in descending order with \"sort=field1,-field2\"
+  # @option opts [Integer] :page The page number
+  # @option opts [Integer] :page_size The size of per page
+  # @return [Array<ScannerRegistration>]
+  describe 'list_scanners 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 ping_scanner
+  # 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
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [nil]
+  describe 'ping_scanner 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 set_scanner_as_default
+  # Set system default scanner registration
+  # Set the specified scanner registration as the system default one. 
+  # @param registration_id The scanner registration identifier.
+  # @param payload 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [nil]
+  describe 'set_scanner_as_default 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 update_scanner
+  # Update a scanner registration
+  # Updates the specified scanner registration. 
+  # @param registration_id The scanner registration identifier.
+  # @param registration A scanner registraiton to be updated.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [nil]
+  describe 'update_scanner test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/search_api_spec.rb

@@ -0,0 +1,48 @@
+=begin
+#Harbor API
+
+#These APIs provide services for manipulating Harbor project.
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.22
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Harbor2Client::SearchApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'SearchApi' do
+  before do
+    # run before each test
+    @instance = Harbor2Client::SearchApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SearchApi' do
+    it 'should create an instance of SearchApi' do
+      expect(@instance).to be_instance_of(Harbor2Client::SearchApi)
+    end
+  end
+
+  # unit tests for search
+  # 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.
+  # @param q Search parameter for project and repository name.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [Search]
+  describe 'search test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/statistic_api_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#Harbor API
+
+#These APIs provide services for manipulating Harbor project.
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.22
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Harbor2Client::StatisticApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'StatisticApi' do
+  before do
+    # run before each test
+    @instance = Harbor2Client::StatisticApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of StatisticApi' do
+    it 'should create an instance of StatisticApi' do
+      expect(@instance).to be_instance_of(Harbor2Client::StatisticApi)
+    end
+  end
+
+  # unit tests for get_statistic
+  # Get the statistic information about the projects and repositories
+  # Get the statistic information about the projects and repositories
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [Statistic]
+  describe 'get_statistic test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/system_cve_allowlist_api_spec.rb

@@ -0,0 +1,60 @@
+=begin
+#Harbor API
+
+#These APIs provide services for manipulating Harbor project.
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.22
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Harbor2Client::SystemCVEAllowlistApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'SystemCVEAllowlistApi' do
+  before do
+    # run before each test
+    @instance = Harbor2Client::SystemCVEAllowlistApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SystemCVEAllowlistApi' do
+    it 'should create an instance of SystemCVEAllowlistApi' do
+      expect(@instance).to be_instance_of(Harbor2Client::SystemCVEAllowlistApi)
+    end
+  end
+
+  # unit tests for get_system_cve_allowlist
+  # Get the system level allowlist of CVE.
+  # Get the system level allowlist of CVE.  This API can be called by all authenticated users.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [CVEAllowlist]
+  describe 'get_system_cve_allowlist 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 put_system_cve_allowlist
+  # Update the system level allowlist of CVE.
+  # This API overwrites the system level allowlist of CVE with the list in request body.  Only system Admin has permission to call this API.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @option opts [CVEAllowlist] :allowlist The allowlist with new content
+  # @return [nil]
+  describe 'put_system_cve_allowlist test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/systeminfo_api_spec.rb

@@ -0,0 +1,71 @@
+=begin
+#Harbor API
+
+#These APIs provide services for manipulating Harbor project.
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.22
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Harbor2Client::SysteminfoApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'SysteminfoApi' do
+  before do
+    # run before each test
+    @instance = Harbor2Client::SysteminfoApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SysteminfoApi' do
+    it 'should create an instance of SysteminfoApi' do
+      expect(@instance).to be_instance_of(Harbor2Client::SysteminfoApi)
+    end
+  end
+
+  # unit tests for get_cert
+  # Get default root certificate.
+  # This endpoint is for downloading a default root certificate. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [File]
+  describe 'get_cert 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 get_system_info
+  # Get general system info
+  # This API is for retrieving general system info, this can be called by anonymous request.  Some attributes will be omitted in the response when this API is called by anonymous request. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [GeneralInfo]
+  describe 'get_system_info 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 get_volumes
+  # Get system volume info (total/free size).
+  # This endpoint is for retrieving system volume info that only provides for admin user.  Note that the response only reflects the storage status of local disk. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [SystemInfo]
+  describe 'get_volumes test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end