repositories
Open an operation to see its authentication, its parameters and the fields of its request and response.
9 operations
GET/v1/repositories
Connected repositories the user can see, by workspace.
/v1/repositoriesAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
workspace_idquery | string |
Response 200
| Name | Type | Description |
|---|---|---|
itemsrequired | array of object | |
items[].idrequired | string | |
items[].org_idrequired | string | |
items[].workspace_idrequired | string | |
items[].providerrequired | enum | Values github |
items[].installation_idrequired | integer | |
items[].github_repo_idrequired | integer | |
items[].full_namerequired | string | |
items[].default_branchrequired | string | |
items[].is_publicrequired | boolean | |
items[].release_strategyrequired | enum | Values semver | calver | manual |
items[].onboarding_pr_numberrequired | integer | |
items[].onboarding_pr_statusrequired | enum | Values none | open | merged | closed |
items[].index_statusrequired | enum | Values none | indexing | ready | failed |
items[].last_indexed_sharequired | string | |
items[].last_push_atrequired | string (date-time) | |
items[].last_activity_atrequired | string (date-time) | |
items[].test_command_detectedrequired | string | |
items[].stack_tagsrequired | array of string | |
items[].connected_atrequired | string (date-time) | |
items[].disconnected_atrequired | string (date-time) | |
items[].created_atrequired | string (date-time) | |
items[].html_urlrequired | string | |
items[].installationrequired | object | |
items[].installation.idrequired | string | |
items[].installation.account_loginrequired | string | |
items[].installation.suspendedrequired | boolean | |
items[].installation.deletedrequired | boolean | |
items[].onboardingrequired | object | |
items[].onboarding.requested_atrequired | string (date-time) | |
items[].onboarding.updated_atrequired | string (date-time) | |
items[].onboarding.commit_sharequired | string | |
items[].onboarding.errorrequired | string | |
items[].onboarding.pr_urlrequired | string | |
items[].onboarding.runs_onrequired | array of string | |
items[].onboarding.cloud_authrequired | object | |
items[].agent_keyrequired | object | |
items[].agent_key.last4required | string | |
items[].agent_key.set_atrequired | string (date-time) | |
items[].oss_enabledrequired | boolean |
POST/v1/repositories
Connects a repository of an installation to a workspace (plan limits apply).
/v1/repositoriesAuthentication: Dashboard session
Request body
| Name | Type | Description |
|---|---|---|
workspace_idrequired | string | |
installation_idrequired | string | |
github_repo_idrequired | integer |
Response 201
| Name | Type | Description |
|---|---|---|
idrequired | string | |
org_idrequired | string | |
workspace_idrequired | string | |
providerrequired | enum | Values github |
installation_idrequired | integer | |
github_repo_idrequired | integer | |
full_namerequired | string | |
default_branchrequired | string | |
is_publicrequired | boolean | |
release_strategyrequired | enum | Values semver | calver | manual |
onboarding_pr_numberrequired | integer | |
onboarding_pr_statusrequired | enum | Values none | open | merged | closed |
index_statusrequired | enum | Values none | indexing | ready | failed |
last_indexed_sharequired | string | |
last_push_atrequired | string (date-time) | |
last_activity_atrequired | string (date-time) | |
test_command_detectedrequired | string | |
stack_tagsrequired | array of string | |
connected_atrequired | string (date-time) | |
disconnected_atrequired | string (date-time) | |
created_atrequired | string (date-time) | |
html_urlrequired | string | |
installationrequired | object | |
installation.idrequired | string | |
installation.account_loginrequired | string | |
installation.suspendedrequired | boolean | |
installation.deletedrequired | boolean | |
onboardingrequired | object | |
onboarding.requested_atrequired | string (date-time) | |
onboarding.updated_atrequired | string (date-time) | |
onboarding.commit_sharequired | string | |
onboarding.errorrequired | string | |
onboarding.pr_urlrequired | string | |
onboarding.runs_onrequired | array of string | |
onboarding.cloud_authrequired | object | |
agent_keyrequired | object | |
agent_key.last4required | string | |
agent_key.set_atrequired | string (date-time) | |
oss_enabledrequired | boolean |
GET/v1/repositories/{id}
A connected repository with its onboarding, secret and open source activity.
/v1/repositories/{id}Authentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
idrequired | string | |
org_idrequired | string | |
workspace_idrequired | string | |
providerrequired | enum | Values github |
installation_idrequired | integer | |
github_repo_idrequired | integer | |
full_namerequired | string | |
default_branchrequired | string | |
is_publicrequired | boolean | |
release_strategyrequired | enum | Values semver | calver | manual |
onboarding_pr_numberrequired | integer | |
onboarding_pr_statusrequired | enum | Values none | open | merged | closed |
index_statusrequired | enum | Values none | indexing | ready | failed |
last_indexed_sharequired | string | |
last_push_atrequired | string (date-time) | |
last_activity_atrequired | string (date-time) | |
test_command_detectedrequired | string | |
stack_tagsrequired | array of string | |
connected_atrequired | string (date-time) | |
disconnected_atrequired | string (date-time) | |
created_atrequired | string (date-time) | |
html_urlrequired | string | |
installationrequired | object | |
installation.idrequired | string | |
installation.account_loginrequired | string | |
installation.suspendedrequired | boolean | |
installation.deletedrequired | boolean | |
onboardingrequired | object | |
onboarding.requested_atrequired | string (date-time) | |
onboarding.updated_atrequired | string (date-time) | |
onboarding.commit_sharequired | string | |
onboarding.errorrequired | string | |
onboarding.pr_urlrequired | string | |
onboarding.runs_onrequired | array of string | |
onboarding.cloud_authrequired | object | |
agent_keyrequired | object | |
agent_key.last4required | string | |
agent_key.set_atrequired | string (date-time) | |
oss_enabledrequired | boolean | |
threadsrequired | array of object | |
threads[].item_kindrequired | enum | Values issue | pull_request |
threads[].numberrequired | integer | |
threads[].html_urlrequired | string | |
threads[].statusrequired | string | |
threads[].ignored_reasonrequired | string | |
threads[].triggerrequired | string | |
threads[].ticket_idrequired | string | |
threads[].comment_urlrequired | string | |
threads[].proposed_labelsrequired | array of string | |
threads[].duplicate_of_numberrequired | integer | |
threads[].updated_atrequired | string (date-time) | |
guidelinesrequired | object | |
guidelines.contributing_pathrequired | string | |
guidelines.code_of_conduct_pathrequired | string | |
guidelines.automationrequired | enum | Values allowed | disclosure_required | refused |
guidelines.evidencerequired | object | |
guidelines.evidence.pathrequired | string | |
guidelines.evidence.excerptrequired | string | |
guidelines.sign_off_requiredrequired | boolean | |
guidelines.cla_requiredrequired | boolean | |
guidelines.conventional_commitsrequired | boolean | |
guidelines.issue_firstrequired | boolean | |
guidelines.checked_atrequired | string (date-time) |
DELETE/v1/repositories/{id}
Disconnects a repository; its code index cache is deleted.
/v1/repositories/{id}Authentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Response 200
The same fields as POST /v1/repositories.
PUT/v1/repositories/{id}/agent-key
Stores the agent key as the Actions secret LOOPBACK_AGENT_KEY (last 4 kept).
/v1/repositories/{id}/agent-keyAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Request body
| Name | Type | Description |
|---|---|---|
keyrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
last4required | string | |
set_atrequired | string (date-time) | |
createdrequired | boolean |
POST/v1/repositories/{id}/guidelines
Reads CONTRIBUTING and CODE_OF_CONDUCT of a public repository again.
/v1/repositories/{id}/guidelinesAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
contributing_pathrequired | string | |
code_of_conduct_pathrequired | string | |
automationrequired | enum | Values allowed | disclosure_required | refused |
evidencerequired | object | |
evidence.pathrequired | string | |
evidence.excerptrequired | string | |
sign_off_requiredrequired | boolean | |
cla_requiredrequired | boolean | |
conventional_commitsrequired | boolean | |
issue_firstrequired | boolean | |
checked_atrequired | string (date-time) |
POST/v1/repositories/{id}/labels
Creates the open source labels (loopback, no-loopback) in the repository.
/v1/repositories/{id}/labelsAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
labelsrequired | array of string |
POST/v1/repositories/{id}/onboarding-pr
Opens or updates the onboarding pull request "Add Loopback".
/v1/repositories/{id}/onboarding-prAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Request body
| Name | Type | Description |
|---|---|---|
runs_on | array of string | |
cloud_auth | object |
Response 202
| Name | Type | Description |
|---|---|---|
repositoryrequired | object | |
repository.idrequired | string | |
repository.org_idrequired | string | |
repository.workspace_idrequired | string | |
repository.providerrequired | enum | Values github |
repository.installation_idrequired | integer | |
repository.github_repo_idrequired | integer | |
repository.full_namerequired | string | |
repository.default_branchrequired | string | |
repository.is_publicrequired | boolean | |
repository.release_strategyrequired | enum | Values semver | calver | manual |
repository.onboarding_pr_numberrequired | integer | |
repository.onboarding_pr_statusrequired | enum | Values none | open | merged | closed |
repository.index_statusrequired | enum | Values none | indexing | ready | failed |
repository.last_indexed_sharequired | string | |
repository.last_push_atrequired | string (date-time) | |
repository.last_activity_atrequired | string (date-time) | |
repository.test_command_detectedrequired | string | |
repository.stack_tagsrequired | array of string | |
repository.connected_atrequired | string (date-time) | |
repository.disconnected_atrequired | string (date-time) | |
repository.created_atrequired | string (date-time) | |
repository.html_urlrequired | string | |
repository.installationrequired | object | |
repository.installation.idrequired | string | |
repository.installation.account_loginrequired | string | |
repository.installation.suspendedrequired | boolean | |
repository.installation.deletedrequired | boolean | |
repository.onboardingrequired | object | |
repository.onboarding.requested_atrequired | string (date-time) | |
repository.onboarding.updated_atrequired | string (date-time) | |
repository.onboarding.commit_sharequired | string | |
repository.onboarding.errorrequired | string | |
repository.onboarding.pr_urlrequired | string | |
repository.onboarding.runs_onrequired | array of string | |
repository.onboarding.cloud_authrequired | object | |
repository.agent_keyrequired | object | |
repository.agent_key.last4required | string | |
repository.agent_key.set_atrequired | string (date-time) | |
repository.oss_enabledrequired | boolean | |
queuedrequired | boolean |
POST/v1/repositories/{id}/refresh
Reads name, default branch and visibility from GitHub again.
/v1/repositories/{id}/refreshAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Response 200
The same fields as POST /v1/repositories.