Project API v0.3.1

License: Apache License 2.0

Authentication

• HTTP Authentication, scheme: Bearer

Project

ListProjects

GET /api/v1/products/{product_name}/projects

Parameters

Name	In	Type	Required	Description
product_name	path	string	true	To list the product name of the repository.
field_selector	query	string	false	Filter the list by field.

Example responses

200 Response

{
  "items": [
    {
      "product": "string",
      "name": "string",
      "language": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK (opens new window)	OK	api.project.v1.ListsReply

To perform this operation, you must be authenticated by means of one of the following methods: BearerAuth

GetProject

GET /api/v1/products/{product_name}/projects/{project_name}

Parameters

Name	In	Type	Required	Description
product_name	path	string	true	The name of the product the project belongs to.
project_name	path	string	true	The name of the project being retrieved.

Example responses

200 Response

{
  "product": "string",
  "name": "string",
  "language": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK (opens new window)	OK	api.project.v1.GetReply

To perform this operation, you must be authenticated by means of one of the following methods: BearerAuth

SaveProject

POST /api/v1/products/{product_name}/projects/{project_name}

Body parameter

{
  "language": "string"
}

Parameters

Name	In	Type	Required	Description
product_name	path	string	true	The name of the product the project belongs to.
project_name	path	string	true	The name of the project being created or updated.
insecureSkipCheck	query	boolean	false	Whether or not to skip validation.
body	body	api.project.v1.SaveRequest_Body	true	none

Example responses

200 Response

{
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK (opens new window)	OK	api.project.v1.SaveReply

To perform this operation, you must be authenticated by means of one of the following methods: BearerAuth

DeleteProject

DELETE /api/v1/products/{product_name}/projects/{project_name}

Parameters

Name	In	Type	Required	Description
product_name	path	string	true	The name of the product the project belongs to.
project_name	path	string	true	The name of the project being deleted.
insecureSkipCheck	query	boolean	false	Whether or not to skip validation.

Example responses

200 Response

{
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK (opens new window)	OK	api.project.v1.DeleteReply

To perform this operation, you must be authenticated by means of one of the following methods: BearerAuth

Schemas

api.project.v1.DeleteReply

{
  "message": "string"
}

Defines the SaveReply message which is used to return a message after deleting a project.

Properties

Name	Type	Required	Restrictions	Description
message	string	false	none	The message being returned.

api.project.v1.GetReply

{
  "product": "string",
  "name": "string",
  "language": "string"
}

Defines the GetReply message which is used to return a specific project.

Properties

Name	Type	Required	Restrictions	Description
product	string	false	none	The name of the product the project belongs to.
name	string	false	none	The name of the project.
language	string	false	none	The language used in the project.

api.project.v1.ListsReply

{
  "items": [
    {
      "product": "string",
      "name": "string",
      "language": "string"
    }
  ]
}

Defines the ListsReply message which is used to return a list of projects.

Properties

Name	Type	Required	Restrictions	Description
items	[api.project.v1.GetReply]	false	none	The list of projects being returned.

api.project.v1.SaveReply

{
  "message": "string"
}

Defines the SaveReply message which is used to return a message after creating or updating a project.

Properties

Name	Type	Required	Restrictions	Description
message	string	false	none	The message being returned.

api.project.v1.SaveRequest_Body

{
  "language": "string"
}

The request body for the project.

Properties

Name	Type	Required	Restrictions	Description
language	string	false	none	The language used in the project.