Skip to content

Latest commit

 

History

History
329 lines (230 loc) · 12.7 KB

Robotv1Api.md

File metadata and controls

329 lines (230 loc) · 12.7 KB
Raw

Harbor2Client::Robotv1Api

All URIs are relative to http://localhost/api/v2.0

Method HTTP request Description
create_robot_v1 POST /projects/{project_name_or_id}/robots Create a robot account
delete_robot_v1 DELETE /projects/{project_name_or_id}/robots/{robot_id} Delete a robot account
get_robot_by_idv1 GET /projects/{project_name_or_id}/robots/{robot_id} Get a robot account
list_robot_v1 GET /projects/{project_name_or_id}/robots Get all robot accounts of specified project
update_robot_v1 PUT /projects/{project_name_or_id}/robots/{robot_id} Update status of robot account.

create_robot_v1

RobotCreated create_robot_v1(project_name_or_idrobot, opts)

Create a robot account

Create a robot account

Example

# load the gem
require 'harbor2_client'
# setup authorization
Harbor2Client.configure do |config|
  # Configure HTTP basic authorization: basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Harbor2Client::Robotv1Api.new

project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project

robot = Harbor2Client::RobotCreateV1.new # RobotCreateV1 | The JSON object of a robot account.

opts = { 
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
  x_is_resource_name: false # BOOLEAN | 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.
}

begin
  #Create a robot account
  result = api_instance.create_robot_v1(project_name_or_idrobot, opts)
  p result
rescue Harbor2Client::ApiError => e
  puts "Exception when calling Robotv1Api->create_robot_v1: #{e}"
end

Parameters

Name Type Description Notes
project_name_or_id String The name or id of the project
robot RobotCreateV1 The JSON object of a robot account.
x_request_id String An unique ID for the request [optional]
x_is_resource_name BOOLEAN 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. [optional] [default to false]

Return type

RobotCreated

Authorization

basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

delete_robot_v1

delete_robot_v1(project_name_or_idrobot_id, , opts)

Delete a robot account

This endpoint deletes specific robot account information by robot ID.

Example

# load the gem
require 'harbor2_client'
# setup authorization
Harbor2Client.configure do |config|
  # Configure HTTP basic authorization: basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Harbor2Client::Robotv1Api.new

project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project

robot_id = 56 # Integer | Robot ID

opts = { 
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
  x_is_resource_name: false # BOOLEAN | 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.
}

begin
  #Delete a robot account
  api_instance.delete_robot_v1(project_name_or_idrobot_id, , opts)
rescue Harbor2Client::ApiError => e
  puts "Exception when calling Robotv1Api->delete_robot_v1: #{e}"
end

Parameters

Name Type Description Notes
project_name_or_id String The name or id of the project
robot_id Integer Robot ID
x_request_id String An unique ID for the request [optional]
x_is_resource_name BOOLEAN 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. [optional] [default to false]

Return type

nil (empty response body)

Authorization

basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

get_robot_by_idv1

Robot get_robot_by_idv1(project_name_or_idrobot_id, , opts)

Get a robot account

This endpoint returns specific robot account information by robot ID.

Example

# load the gem
require 'harbor2_client'
# setup authorization
Harbor2Client.configure do |config|
  # Configure HTTP basic authorization: basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Harbor2Client::Robotv1Api.new

project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project

robot_id = 56 # Integer | Robot ID

opts = { 
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
  x_is_resource_name: false # BOOLEAN | 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.
}

begin
  #Get a robot account
  result = api_instance.get_robot_by_idv1(project_name_or_idrobot_id, , opts)
  p result
rescue Harbor2Client::ApiError => e
  puts "Exception when calling Robotv1Api->get_robot_by_idv1: #{e}"
end

Parameters

Name Type Description Notes
project_name_or_id String The name or id of the project
robot_id Integer Robot ID
x_request_id String An unique ID for the request [optional]
x_is_resource_name BOOLEAN 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. [optional] [default to false]

Return type

Robot

Authorization

basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

list_robot_v1

Array<Robot> list_robot_v1(project_name_or_id, opts)

Get all robot accounts of specified project

Get all robot accounts of specified project

Example

# load the gem
require 'harbor2_client'
# setup authorization
Harbor2Client.configure do |config|
  # Configure HTTP basic authorization: basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Harbor2Client::Robotv1Api.new

project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project

opts = { 
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
  x_is_resource_name: false # BOOLEAN | 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.
  page: 1, # Integer | The page number
  page_size: 10, # Integer | The size of per page
  q: 'q_example', # String | 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]
  sort: 'sort_example', # String | 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\"
}

begin
  #Get all robot accounts of specified project
  result = api_instance.list_robot_v1(project_name_or_id, opts)
  p result
rescue Harbor2Client::ApiError => e
  puts "Exception when calling Robotv1Api->list_robot_v1: #{e}"
end

Parameters

Name Type Description Notes
project_name_or_id String The name or id of the project
x_request_id String An unique ID for the request [optional]
x_is_resource_name BOOLEAN 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. [optional] [default to false]
page Integer The page number [optional] [default to 1]
page_size Integer The size of per page [optional] [default to 10]
q String Query string to query resources. Supported query patterns are &quot;exact match(k=v)&quot;, &quot;fuzzy match(k=v)&quot;, &quot;range(k=[minmax])&quot;, &quot;list with union releationship(k={v1 v2 v3})&quot; and &quot;list with intersetion relationship(k=(v1 v2 v3))&quot;. The value of range and list can be string(enclosed by &quot; or '), integer or time(in format &quot;2020-04-09 02:36:00&quot;). All of these query patterns should be put in the query string &quot;q=xxx&quot; and splitted by &quot;,&quot;. e.g. q=k1=v1,k2=v2,k3=[minmax] [optional]
sort String Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending orderr and field2 in descending order with &quot;sort=field1,-field2&quot; [optional]

Return type

Array<Robot>

Authorization

basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

update_robot_v1

update_robot_v1(project_name_or_idrobot_id, robot, opts)

Update status of robot account.

Used to disable/enable a specified robot account.

Example

# load the gem
require 'harbor2_client'
# setup authorization
Harbor2Client.configure do |config|
  # Configure HTTP basic authorization: basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Harbor2Client::Robotv1Api.new

project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project

robot_id = 56 # Integer | Robot ID

robot = Harbor2Client::Robot.new # Robot | The JSON object of a robot account.

opts = { 
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
  x_is_resource_name: false # BOOLEAN | 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.
}

begin
  #Update status of robot account.
  api_instance.update_robot_v1(project_name_or_idrobot_id, robot, opts)
rescue Harbor2Client::ApiError => e
  puts "Exception when calling Robotv1Api->update_robot_v1: #{e}"
end

Parameters

Name Type Description Notes
project_name_or_id String The name or id of the project
robot_id Integer Robot ID
robot Robot The JSON object of a robot account.
x_request_id String An unique ID for the request [optional]
x_is_resource_name BOOLEAN 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. [optional] [default to false]

Return type

nil (empty response body)

Authorization

basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json