harbor_swagger_client 1.0.4 → 2.0.0

data/lib/harbor_swagger_client/api/scan_api.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.7
+Swagger Codegen version: 2.4.17
 
 =end
 
@@ -19,25 +19,55 @@ module SwaggerClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Get the metrics of the latest scan all process
-    # Get the metrics of the latest scan all process
+    # Get the log of the scan report
+    # Get the log of the scan report
+    # @param project_name The name of the project
+    # @param repository_name The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
+    # @param reference The reference of the artifact, can be digest or tag
+    # @param report_id The report id to get the log
     # @param [Hash] opts the optional parameters
-    # @return [Stats]
-    def scans_all_metrics_get(opts = {})
-      data, _status_code, _headers = scans_all_metrics_get_with_http_info(opts)
+    # @option opts [String] :x_request_id An unique ID for the request
+    # @return [String]
+    def get_report_log(project_name, repository_name, reference, report_id, opts = {})
+      data, _status_code, _headers = get_report_log_with_http_info(project_name, repository_name, reference, report_id, opts)
       data
     end
 
-    # Get the metrics of the latest scan all process
-    # Get the metrics of the latest scan all process
+    # Get the log of the scan report
+    # Get the log of the scan report
+    # @param project_name The name of the project
+    # @param repository_name The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
+    # @param reference The reference of the artifact, can be digest or tag
+    # @param report_id The report id to get the log
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Stats, Fixnum, Hash)>] Stats data, response status code and response headers
-    def scans_all_metrics_get_with_http_info(opts = {})
+    # @option opts [String] :x_request_id An unique ID for the request
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def get_report_log_with_http_info(project_name, repository_name, reference, report_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: ScanApi.scans_all_metrics_get ...'
+        @api_client.config.logger.debug 'Calling API: ScanApi.get_report_log ...'
       end
+      # verify the required parameter 'project_name' is set
+      if @api_client.config.client_side_validation && project_name.nil?
+        fail ArgumentError, "Missing the required parameter 'project_name' when calling ScanApi.get_report_log"
+      end
+      # verify the required parameter 'repository_name' is set
+      if @api_client.config.client_side_validation && repository_name.nil?
+        fail ArgumentError, "Missing the required parameter 'repository_name' when calling ScanApi.get_report_log"
+      end
+      # verify the required parameter 'reference' is set
+      if @api_client.config.client_side_validation && reference.nil?
+        fail ArgumentError, "Missing the required parameter 'reference' when calling ScanApi.get_report_log"
+      end
+      # verify the required parameter 'report_id' is set
+      if @api_client.config.client_side_validation && report_id.nil?
+        fail ArgumentError, "Missing the required parameter 'report_id' when calling ScanApi.get_report_log"
+      end
+      if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
+        fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling ScanApi.get_report_log, the character length must be great than or equal to 1.'
+      end
+
       # resource path
-      local_var_path = '/scans/all/metrics'
+      local_var_path = '/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/scan/{report_id}/log'.sub('{' + 'project_name' + '}', project_name.to_s).sub('{' + 'repository_name' + '}', repository_name.to_s).sub('{' + 'reference' + '}', reference.to_s).sub('{' + 'report_id' + '}', report_id.to_s)
 
       # query parameters
       query_params = {}
@@ -45,47 +75,72 @@ module SwaggerClient
       # header parameters
       header_params = {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain'])
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?
 
       # form parameters
       form_params = {}
 
       # http body (model)
       post_body = nil
-      auth_names = ['basicAuth']
+      auth_names = ['basic']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Stats')
+        :return_type => 'String')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ScanApi#scans_all_metrics_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: ScanApi#get_report_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
-    # Get the metrics of the latest scheduled scan all process
-    # Get the metrics of the latest scheduled scan all process
+    # Scan the artifact
+    # Scan the specified artifact
+    # @param project_name The name of the project
+    # @param repository_name The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -&gt; a%252Fb
+    # @param reference The reference of the artifact, can be digest or tag
     # @param [Hash] opts the optional parameters
-    # @return [Stats]
-    def scans_schedule_metrics_get(opts = {})
-      data, _status_code, _headers = scans_schedule_metrics_get_with_http_info(opts)
-      data
+    # @option opts [String] :x_request_id An unique ID for the request
+    # @return [nil]
+    def scan_artifact(project_name, repository_name, reference, opts = {})
+      scan_artifact_with_http_info(project_name, repository_name, reference, opts)
+      nil
     end
 
-    # Get the metrics of the latest scheduled scan all process
-    # Get the metrics of the latest scheduled scan all process
+    # Scan the artifact
+    # Scan the specified artifact
+    # @param project_name The name of the project
+    # @param repository_name The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -&gt; a%252Fb
+    # @param reference The reference of the artifact, can be digest or tag
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Stats, Fixnum, Hash)>] Stats data, response status code and response headers
-    def scans_schedule_metrics_get_with_http_info(opts = {})
+    # @option opts [String] :x_request_id An unique ID for the request
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def scan_artifact_with_http_info(project_name, repository_name, reference, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: ScanApi.scans_schedule_metrics_get ...'
+        @api_client.config.logger.debug 'Calling API: ScanApi.scan_artifact ...'
       end
+      # verify the required parameter 'project_name' is set
+      if @api_client.config.client_side_validation && project_name.nil?
+        fail ArgumentError, "Missing the required parameter 'project_name' when calling ScanApi.scan_artifact"
+      end
+      # verify the required parameter 'repository_name' is set
+      if @api_client.config.client_side_validation && repository_name.nil?
+        fail ArgumentError, "Missing the required parameter 'repository_name' when calling ScanApi.scan_artifact"
+      end
+      # verify the required parameter 'reference' is set
+      if @api_client.config.client_side_validation && reference.nil?
+        fail ArgumentError, "Missing the required parameter 'reference' when calling ScanApi.scan_artifact"
+      end
+      if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
+        fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling ScanApi.scan_artifact, the character length must be great than or equal to 1.'
+      end
+
       # resource path
-      local_var_path = '/scans/schedule/metrics'
+      local_var_path = '/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/scan'.sub('{' + 'project_name' + '}', project_name.to_s).sub('{' + 'repository_name' + '}', repository_name.to_s).sub('{' + 'reference' + '}', reference.to_s)
 
       # query parameters
       query_params = {}
@@ -93,25 +148,25 @@ module SwaggerClient
       # header parameters
       header_params = {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?
 
       # form parameters
       form_params = {}
 
       # http body (model)
       post_body = nil
-      auth_names = ['basicAuth']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+      auth_names = ['basic']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'Stats')
+        :auth_names => auth_names)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ScanApi#scans_schedule_metrics_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: ScanApi#scan_artifact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end

data/lib/harbor_swagger_client/api/systeminfo_api.rb

@@ -0,0 +1,167 @@
+=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.17
+
+=end
+
+require 'uri'
+
+module SwaggerClient
+  class SysteminfoApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 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
+    # @return [GeneralInfo]
+    def systeminfo_get(opts = {})
+      data, _status_code, _headers = systeminfo_get_with_http_info(opts)
+      data
+    end
+
+    # 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
+    # @return [Array<(GeneralInfo, Fixnum, Hash)>] GeneralInfo data, response status code and response headers
+    def systeminfo_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SysteminfoApi.systeminfo_get ...'
+      end
+      # resource path
+      local_var_path = '/systeminfo'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['basic']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'GeneralInfo')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SysteminfoApi#systeminfo_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get default root certificate.
+    # This endpoint is for downloading a default root certificate. 
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def systeminfo_getcert_get(opts = {})
+      data, _status_code, _headers = systeminfo_getcert_get_with_http_info(opts)
+      data
+    end
+
+    # Get default root certificate.
+    # This endpoint is for downloading a default root certificate. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
+    def systeminfo_getcert_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SysteminfoApi.systeminfo_getcert_get ...'
+      end
+      # resource path
+      local_var_path = '/systeminfo/getcert'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['basic']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'File')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SysteminfoApi#systeminfo_getcert_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 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
+    # @return [SystemInfo]
+    def systeminfo_volumes_get(opts = {})
+      data, _status_code, _headers = systeminfo_volumes_get_with_http_info(opts)
+      data
+    end
+
+    # 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
+    # @return [Array<(SystemInfo, Fixnum, Hash)>] SystemInfo data, response status code and response headers
+    def systeminfo_volumes_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SysteminfoApi.systeminfo_volumes_get ...'
+      end
+      # resource path
+      local_var_path = '/systeminfo/volumes'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['basic']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'SystemInfo')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SysteminfoApi#systeminfo_volumes_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/harbor_swagger_client/api_client.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.7
+Swagger Codegen version: 2.4.17
 
 =end
 
@@ -15,7 +15,7 @@ require 'json'
 require 'logger'
 require 'tempfile'
 require 'typhoeus'
-require 'uri'
+require 'addressable/uri'
 
 module SwaggerClient
   class ApiClient
@@ -63,7 +63,7 @@ module SwaggerClient
                             :message => response.return_message)
         else
           fail ApiError.new(:code => response.code,
-                            :response_headers => response.headers,
+                            :response_headers => response.headers.to_h,
                             :response_body => response.body),
                response.status_message
         end
@@ -112,6 +112,8 @@ module SwaggerClient
         :verbose => @config.debugging
       }
 
+      req_opts.merge!(multipart: true) if header_params['Content-Type'].start_with? "multipart/"
+
       # set custom cert, if provided
       req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
 
@@ -264,7 +266,7 @@ module SwaggerClient
     def build_request_url(path)
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-      URI.encode(@config.base_url + path)
+      Addressable::URI.encode(@config.base_url + path)
     end
 
     # Builds the HTTP request body

data/lib/harbor_swagger_client/api_error.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.7
+Swagger Codegen version: 2.4.17
 
 =end
 

data/lib/harbor_swagger_client/configuration.rb

@@ -6,11 +6,11 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.7
+Swagger Codegen version: 2.4.17
 
 =end
 
-require 'uri'
+require 'addressable/uri'
 
 module SwaggerClient
   class Configuration
@@ -175,7 +175,7 @@ module SwaggerClient
 
     def base_url
       url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
-      URI.encode(url)
+      Addressable::URI.encode(url)
     end
 
     # Gets API key (with prefix if set).
@@ -196,7 +196,7 @@ module SwaggerClient
     # Returns Auth Settings hash for api client.
     def auth_settings
       {
-        'basicAuth' =>
+        'basic' =>
           {
             type: 'basic',
             in: 'header',

data/lib/harbor_swagger_client/models/{robot_account_access.rb → access.rb}

@@ -6,25 +6,29 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.7
+Swagger Codegen version: 2.4.17
 
 =end
 
 require 'date'
 
 module SwaggerClient
-  class RobotAccountAccess
-    # the resource of harbor
+  class Access
+    # The resource of the access
     attr_accessor :resource
 
-    # the action to resource that perdefined in harbor rbac
+    # The action of the access
     attr_accessor :action
 
+    # The effect of the access
+    attr_accessor :effect
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'resource' => :'resource',
-        :'action' => :'action'
+        :'action' => :'action',
+        :'effect' => :'effect'
       }
     end
 
@@ -32,7 +36,8 @@ module SwaggerClient
     def self.swagger_types
       {
         :'resource' => :'String',
-        :'action' => :'String'
+        :'action' => :'String',
+        :'effect' => :'String'
       }
     end
 
@@ -51,6 +56,10 @@ module SwaggerClient
       if attributes.has_key?(:'action')
         self.action = attributes[:'action']
       end
+
+      if attributes.has_key?(:'effect')
+        self.effect = attributes[:'effect']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -72,7 +81,8 @@ module SwaggerClient
       return true if self.equal?(o)
       self.class == o.class &&
           resource == o.resource &&
-          action == o.action
+          action == o.action &&
+          effect == o.effect
     end
 
     # @see the `==` method
@@ -84,7 +94,7 @@ module SwaggerClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [resource, action].hash
+      [resource, action, effect].hash
     end
 
     # Builds the object from hash
@@ -94,7 +104,7 @@ module SwaggerClient
       return nil unless attributes.is_a?(Hash)
       self.class.swagger_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the the attribute
+          # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
             self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
@@ -190,5 +200,6 @@ module SwaggerClient
         value
       end
     end
+
   end
 end