SwaggerClient::ProjectApi

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

Method	HTTP request	Description
create_project	POST /projects	Create a new project.
delete_project	DELETE /projects/{project_id}	Delete project by projectID
get_logs	GET /projects/{project_name}/logs	Get recent logs of the projects
get_project	GET /projects/{project_id}	Return specific project detail information
get_project_deletable	GET /projects/{project_id}/_deletable	Get the deletable status of the project
get_project_summary	GET /projects/{project_id}/summary	Get summary of the project.
head_project	HEAD /projects	Check if the project name user provided already exists.
list_projects	GET /projects	List projects
update_project	PUT /projects/{project_id}	Update properties for a selected project.

create_project

create_project(project, opts)

Create a new project.

This endpoint is for user to create a new project.

Example

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

api_instance = SwaggerClient::ProjectApi.new

project = SwaggerClient::ProjectReq.new # ProjectReq | New created project.

opts = { 
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
}

begin
  #Create a new project.
  api_instance.create_project(project, opts)
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ProjectApi->create_project: #{e}"
end

Parameters

Name	Type	Description	Notes
project	ProjectReq	New created project.
x_request_id	String	An unique ID for the request	[optional]

Return type

nil (empty response body)

Authorization

basic

HTTP request headers

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

delete_project

delete_project(project_id, opts)

Delete project by projectID

This endpoint is aimed to delete project by project ID.

Example

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

api_instance = SwaggerClient::ProjectApi.new

project_id = 789 # Integer | The ID of the project

opts = { 
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
}

begin
  #Delete project by projectID
  api_instance.delete_project(project_id, opts)
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ProjectApi->delete_project: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	Integer	The ID of the project
x_request_id	String	An unique ID for the request	[optional]

Return type

nil (empty response body)

Authorization

basic

HTTP request headers

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

get_logs

Array<AuditLog> get_logs(project_name, opts)

Get recent logs of the projects

Example

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

api_instance = SwaggerClient::ProjectApi.new

project_name = 'project_name_example' # String | The name of the project

opts = { 
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
  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]
  page: 1, # Integer | The page number
  page_size: 10, # Integer | The size of per page
}

begin
  #Get recent logs of the projects
  result = api_instance.get_logs(project_name, opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ProjectApi->get_logs: #{e}"
end

Parameters

Name	Type	Description	Notes
project_name	String	The name of the project
x_request_id	String	An unique ID for the request	[optional]
q	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]	[optional]
page	Integer	The page number	[optional] [default to 1]
page_size	Integer	The size of per page	[optional] [default to 10]

Return type

Array<AuditLog>

Authorization

basic

HTTP request headers

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

get_project

Project get_project(project_id, opts)

Return specific project detail information

This endpoint returns specific project information by project ID.

Example

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

api_instance = SwaggerClient::ProjectApi.new

project_id = 789 # Integer | The ID of the project

opts = { 
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
}

begin
  #Return specific project detail information
  result = api_instance.get_project(project_id, opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ProjectApi->get_project: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	Integer	The ID of the project
x_request_id	String	An unique ID for the request	[optional]

Return type

Project

Authorization

basic

HTTP request headers

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

get_project_deletable

ProjectDeletable get_project_deletable(project_id, opts)

Get the deletable status of the project

Example

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

api_instance = SwaggerClient::ProjectApi.new

project_id = 789 # Integer | The ID of the project

opts = { 
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
}

begin
  #Get the deletable status of the project
  result = api_instance.get_project_deletable(project_id, opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ProjectApi->get_project_deletable: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	Integer	The ID of the project
x_request_id	String	An unique ID for the request	[optional]

Return type

ProjectDeletable

Authorization

basic

HTTP request headers

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

get_project_summary

ProjectSummary get_project_summary(project_id, opts)

Get summary of the project.

Example

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

api_instance = SwaggerClient::ProjectApi.new

project_id = 789 # Integer | The ID of the project

opts = { 
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
}

begin
  #Get summary of the project.
  result = api_instance.get_project_summary(project_id, opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ProjectApi->get_project_summary: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	Integer	The ID of the project
x_request_id	String	An unique ID for the request	[optional]

Return type

ProjectSummary

Authorization

basic

HTTP request headers

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

head_project

head_project(project_name, opts)

Check if the project name user provided already exists.

This endpoint is used to check if the project name provided already exist.

Example

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

api_instance = SwaggerClient::ProjectApi.new

project_name = 'project_name_example' # String | Project name for checking exists.

opts = { 
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
}

begin
  #Check if the project name user provided already exists.
  api_instance.head_project(project_name, opts)
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ProjectApi->head_project: #{e}"
end

Parameters

Name	Type	Description	Notes
project_name	String	Project name for checking exists.
x_request_id	String	An unique ID for the request	[optional]

Return type

nil (empty response body)

Authorization

basic

HTTP request headers

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

list_projects

Array<Project> list_projects(opts)

List projects

This endpoint returns projects created by Harbor.

Example

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

api_instance = SwaggerClient::ProjectApi.new

opts = { 
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
  page: 1, # Integer | The page number
  page_size: 10, # Integer | The size of per page
  name: 'name_example', # String | The name of project.
  public: true, # BOOLEAN | The project is public or private.
  owner: 'owner_example', # String | The name of project owner.
  with_detail: true # BOOLEAN | Bool value indicating whether return detailed information of the project
}

begin
  #List projects
  result = api_instance.list_projects(opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ProjectApi->list_projects: #{e}"
end

Parameters

Name	Type	Description	Notes
x_request_id	String	An unique ID for the request	[optional]
page	Integer	The page number	[optional] [default to 1]
page_size	Integer	The size of per page	[optional] [default to 10]
name	String	The name of project.	[optional]
public	BOOLEAN	The project is public or private.	[optional]
owner	String	The name of project owner.	[optional]
with_detail	BOOLEAN	Bool value indicating whether return detailed information of the project	[optional] [default to true]

Return type

Array<Project>

Authorization

basic

HTTP request headers

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

update_project

update_project(project_idproject, opts)

Update properties for a selected project.

This endpoint is aimed to update the properties of a project.

Example

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

api_instance = SwaggerClient::ProjectApi.new

project_id = 789 # Integer | The ID of the project

project = SwaggerClient::ProjectReq.new # ProjectReq | Updates of project.

opts = { 
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
}

begin
  #Update properties for a selected project.
  api_instance.update_project(project_idproject, opts)
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ProjectApi->update_project: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	Integer	The ID of the project
project	ProjectReq	Updates of project.
x_request_id	String	An unique ID for the request	[optional]

Return type

nil (empty response body)

Authorization

basic

HTTP request headers

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

Files

ProjectApi.md

Latest commit

History

ProjectApi.md

File metadata and controls

SwaggerClient::ProjectApi

create_project

Example

Parameters

Return type

Authorization

HTTP request headers

delete_project

Example

Parameters

Return type

Authorization

HTTP request headers

get_logs

Example

Parameters

Return type

Authorization

HTTP request headers

get_project

Example

Parameters

Return type

Authorization

HTTP request headers

get_project_deletable

Example

Parameters

Return type

Authorization

HTTP request headers

get_project_summary

Example

Parameters

Return type

Authorization

HTTP request headers

head_project

Example

Parameters

Return type

Authorization

HTTP request headers

list_projects

Example

Parameters

Return type

Authorization

HTTP request headers

update_project

Example

Parameters

Return type

Authorization

HTTP request headers