Code Repository Binding API v0.3.1

License: Apache License 2.0

Authentication

• HTTP Authentication, scheme: Bearer

CodeRepoBinding

ListCodeRepoBindings

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

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. eg: field_selector=projects.in=project1,product=product1,coderepo=coderepo1 Field Support: coderepo: fuzzy match product fuzzy match projects: fuzzy match

Example responses

200 Response

{
  "items": [
    {
      "product": "string",
      "name": "string",
      "projects": [
        "string"
      ],
      "permissions": "string",
      "coderepo": "string"
    }
  ]
}

Responses

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

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

GetCodeRepoBinding

GET /api/v1/products/{product_name}/coderepobindings/{coderepo_binding_name}

Parameters

Name	In	Type	Required	Description
product_name	path	string	true	none
coderepo_binding_name	path	string	true	none

Example responses

200 Response

{
  "product": "string",
  "name": "string",
  "projects": [
    "string"
  ],
  "permissions": "string",
  "coderepo": "string"
}

Responses

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

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

SaveCodeRepoBinding

POST /api/v1/products/{product_name}/coderepobindings/{coderepo_binding_name}

Body parameter

{
  "product": "string",
  "projects": [
    "string"
  ],
  "permissions": "string",
  "coderepo": "string"
}

Parameters

Name	In	Type	Required	Description
product_name	path	string	true	Products to which the resource belongs.
coderepo_binding_name	path	string	true	CodeRepoBinding resource name.
insecure_skip_check	query	boolean	false	Whether to skip global resource detection (not recommended).
body	body	api.coderepobinding.v1.SaveRequest_Body	true	none

Example responses

200 Response

{
  "message": "string"
}

Responses

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

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

DeleteCodeRepoBinding

DELETE /api/v1/products/{product_name}/coderepobindings/{coderepo_binding_name}

Parameters

Name	In	Type	Required	Description
product_name	path	string	true	none
coderepo_binding_name	path	string	true	none
insecure_skip_check	query	boolean	false	none

Example responses

200 Response

{
  "message": "string"
}

Responses

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

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

Schemas

api.coderepobinding.v1.DeleteReply

{
  "message": "string"
}

Represents a response to a DeleteRequest message.

Properties

Name	Type	Required	Restrictions	Description
message	string	false	none	Msg is a message confirming the delete.

api.coderepobinding.v1.GetReply

{
  "product": "string",
  "name": "string",
  "projects": [
    "string"
  ],
  "permissions": "string",
  "coderepo": "string"
}

Properties

Name	Type	Required	Restrictions	Description
product	string	false	none	The Code repo is authorized to this product or projects under it.
name	string	false	none	CodeRepoBinding resource name.
projects	[string]	false	none	If the project list is empty, it means that the code repo is authorized to the product. If the project list has values, it means that the code repo is authorized to the specified projects.
permissions	string	false	none	Authorization Permissions, readwrite or readonly.
coderepo	string	false	none	Authorized Code Repository.

api.coderepobinding.v1.ListsReply

{
  "items": [
    {
      "product": "string",
      "name": "string",
      "projects": [
        "string"
      ],
      "permissions": "string",
      "coderepo": "string"
    }
  ]
}

Define the ListsReply message, which includes the repeated items field.

Properties

Name	Type	Required	Restrictions	Description
items	[api.coderepobinding.v1.GetReply]	false	none	none

api.coderepobinding.v1.SaveReply

{
  "message": "string"
}

Define the SaveReply message, which includes the msg field.

Properties

Name	Type	Required	Restrictions	Description
message	string	false	none	Msg is a message confirming the save.

api.coderepobinding.v1.SaveRequest_Body

{
  "product": "string",
  "projects": [
    "string"
  ],
  "permissions": "string",
  "coderepo": "string"
}

Properties

Name	Type	Required	Restrictions	Description
product	string	false	none	The Code repo is authorized to this product or projects under it.
projects	[string]	false	none	If the project list is empty, it means that the code repo is authorized to the product. If the project list has values, it means that the code repo is authorized to the specified projects.
permissions	string	false	none	Authorization Permissions, readwrite or readonly.
coderepo	string	false	none	Authorized Code Repository.