Перейти к содержимому

Справочник по API

Изучите конечные точки, параметры, тела запросов и схемы ответов для этого выпуска Repovio.

Эта ссылка, доступная только для чтения, создается на основе выбранной версии приложения. Используйте поле поиска, чтобы найти конечную точку; разверните сведения о схеме для вложенных полей и при необходимости загрузите полный OpenAPI JSON.

Документацию, предоставляемую вашей установкой, см. в Доступ через API.

Конечные точки 114

Скачать OpenAPI JSON

health

GET/api/health

Get application health status

Аутентификация

По этому контракту аутентификация не требуется.

Ответы

200 The API process, database, and persisted provider synchronization state.

auth

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Тело запроса

Необходимый
application/json
UpdateProfileDto · object
Характеристики
Схема JSON

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Тело запроса

Необходимый
multipart/form-data
object
Характеристики
Схема JSON

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Тело запроса

Необходимый
application/json
RemoteAvatarDto · object
Характеристики
Схема JSON

Ответы

201

Аутентификация

По этому контракту аутентификация не требуется.

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Тело запроса

Необходимый
application/json
UpdateOidcConfigDto · object
Характеристики
Схема JSON

Ответы

200

Аутентификация

По этому контракту аутентификация не требуется.

Тело запроса

Необходимый
application/json
OidcExchangeDto · object
Характеристики
Схема JSON

Ответы

200

Аутентификация

По этому контракту аутентификация не требуется.

Параметры

query
return_toНеобходимыйstring
Схема JSON

Ответы

200

Аутентификация

По этому контракту аутентификация не требуется.

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Тело запроса

Необходимый
application/json
UpdatePasswordDto · object
Характеристики
Схема JSON

Ответы

201

Аутентификация

По этому контракту аутентификация не требуется.

Тело запроса

Необходимый
application/json
SetupDto · object
Характеристики
Схема JSON

Ответы

200

Аутентификация

По этому контракту аутентификация не требуется.

Ответы

200

Аутентификация

По этому контракту аутентификация не требуется.

Тело запроса

Необходимый
application/json
SignInDto · object
Характеристики
Схема JSON

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

204

notifications

GET/api/v1/browser-push

Get browser-push availability and enrollment status

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Тело запроса

Необходимый
application/json
RegisterBrowserPushSubscriptionDto · object
Характеристики
Схема JSON

Ответы

204

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Тело запроса

Необходимый
application/json
RemoveBrowserPushSubscriptionDto · object
Характеристики
Схема JSON

Ответы

204

GET/api/v1/notification-channels

List visible notification channels

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200

POST/api/v1/notification-channels

Create a notification channel

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Тело запроса

Необходимый
application/json
CreateNotificationChannelDto · object
Характеристики
Схема JSON

Ответы

200

PATCH/api/v1/notification-channels/{id}

Update a notification channel

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Тело запроса

Необходимый
application/json
UpdateNotificationChannelDto · object
Характеристики
Схема JSON

Ответы

200

DELETE/api/v1/notification-channels/{id}

Delete a notification channel

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Ответы

204

POST/api/v1/notification-channels/{id}/test

Test one notification channel

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200

POST/api/v1/notification-channels/preview

Preview workflow notification subscriptions

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Тело запроса

Необходимый
application/json
NotificationRulePreviewInputDto · object
Характеристики
Схема JSON

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

query
page
anyOf
number
string
Схема JSON
query
perPage
anyOf
number
string
Схема JSON
query
fieldsstring
Схема JSON
query
whereNotificationChannelWhere · object
Характеристики
Схема JSON
query
orderBy
anyOf
NotificationChannelOrderBy · object
Характеристики
array
Элементы массива
NotificationChannelOrderBy · object
Характеристики
Схема JSON
query
selectNotificationChannelSelect · object
Характеристики
Схема JSON
query
includeNotificationChannelInclude · object
Характеристики
Схема JSON
query
cursorstring
Характеристики
Схема JSON
query
distinct
anyOf
string

["id","createdAt","updatedAt","name","type","enabled"]

array
Элементы массива
string

["id","createdAt","updatedAt","name","type","enabled"]

Схема JSON
query
searchstring
Схема JSON

Ответы

200 Visible notification channels.

GET/api/v1/notification-deliveries

List visible notification delivery history

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

query
repositoryIdНеобходимыйstring
Схема JSON

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

query
page
anyOf
number
string
Схема JSON
query
perPage
anyOf
number
string
Схема JSON
query
fieldsstring
Схема JSON
query
whereNotificationDeliveryWhere · object
Характеристики
Схема JSON
query
orderBy
anyOf
NotificationDeliveryOrderBy · object
Характеристики
array
Элементы массива
NotificationDeliveryOrderBy · object
Характеристики
Схема JSON
query
selectNotificationDeliverySelect · object
Характеристики
Схема JSON
query
includeNotificationDeliveryInclude · object
Характеристики
Схема JSON
query
cursorstring
Характеристики
Схема JSON
query
distinct
anyOf
string

["id","createdAt","updatedAt","kind","eventType","status","nextAttemptAt","notificationChannelId","repositoryId"]

array
Элементы массива
string

["id","createdAt","updatedAt","kind","eventType","status","nextAttemptAt","notificationChannelId","repositoryId"]

Схема JSON
query
searchstring
Схема JSON

Ответы

200 Authorized notification delivery history.

dashboard

GET/api/v1/dashboard/awaiting-approval

List workflow runs awaiting provider approval

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200 Visible workflow runs awaiting approval.

GET/api/v1/dashboard/failures

List the 15 newest workflow contexts whose latest terminal run failed

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200 Visible latest failed workflow runs.

GET/api/v1/dashboard/latest-runs

List the ten newest visible workflow runs

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200 The ten newest visible workflow runs.

GET/api/v1/dashboard/repositories

Get visible repository workflow health

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

query
fromНеобходимыйstring
Схема JSON
query
toНеобходимыйstring
Схема JSON

Ответы

200 Permission-aware repository health aggregates.

GET/api/v1/dashboard/summary

Get visible workflow health summary

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

query
fromНеобходимыйstring
Схема JSON
query
toНеобходимыйstring
Схема JSON

Ответы

200 Permission-aware workflow health summary.

GET/api/v1/dashboard/trend

Get success and error workflow-run trend buckets

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

query
fromНеобходимыйstring
Схема JSON
query
toНеобходимыйstring
Схема JSON
query
bucket
anyOf
string

["hour"]

string

["day"]

string

["week"]

Схема JSON

Ответы

200 Visible workflow-run trend buckets.

GitHubApp

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Тело запроса

Необходимый
application/json
SaveGitHubAppDto · object
Характеристики
Схема JSON

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

204

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Тело запроса

Необходимый
application/json
ConnectGitHubAppDto · object
Характеристики
Схема JSON

Ответы

201

issues

GET/api/v1/issues

Query visible issues

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

query
page
anyOf
number
string
Схема JSON
query
perPage
anyOf
number
string
Схема JSON
query
fieldsstring
Схема JSON
query
whereIssueWhere · object
Характеристики
Схема JSON
query
orderBy
anyOf
IssueOrderBy · object
Характеристики
array
Элементы массива
IssueOrderBy · object
Характеристики
Схема JSON
query
selectIssueSelect · object
Характеристики
Схема JSON
query
includeIssueInclude · object
Характеристики
Схема JSON
query
cursorstring
Характеристики
Схема JSON
query
distinct
anyOf
string

["id","createdAt","updatedAt","number","title","body","state","url","providerCreatedAt","providerUpdatedAt","closedAt","milestone","repositoryId"]

array
Элементы массива
string

["id","createdAt","updatedAt","number","title","body","state","url","providerCreatedAt","providerUpdatedAt","closedAt","milestone","repositoryId"]

Схема JSON
query
searchstringnullable
Схема JSON
query
labelsnullable
anyOf
string
array
Элементы массива
string
Схема JSON

Ответы

200 Visible provider issues.
400 Invalid issue query.
401
403

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200

jobs

GET/api/v1/jobs/repository-sync

Query visible repository synchronization jobs

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

query
page
anyOf
number
string
Схема JSON
query
perPage
anyOf
number
string
Схема JSON
query
fieldsstring
Схема JSON
query
whereRepositoryWhere · object
Характеристики
Схема JSON
query
orderBy
anyOf
RepositoryOrderBy · object
Характеристики
array
Элементы массива
RepositoryOrderBy · object
Характеристики
Схема JSON
query
selectRepositorySelect · object
Характеристики
Схема JSON
query
includeRepositoryInclude · object
Характеристики
Схема JSON
query
cursorobject
Характеристики
Схема JSON
query
distinct
anyOf
string

["id","createdAt","updatedAt","providerRepositoryId","owner","name","url","enabled","lastSyncAt","providerAccountId","workflowRunRetentionDays","issueRetentionDays","pullRequestRetentionDays"]

array
Элементы массива
string

["id","createdAt","updatedAt","providerRepositoryId","owner","name","url","enabled","lastSyncAt","providerAccountId","workflowRunRetentionDays","issueRetentionDays","pullRequestRetentionDays"]

Схема JSON
query
searchstring
Схема JSON

Ответы

200 Visible repository synchronization jobs.
400 Invalid repository synchronization job query.
401
403

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
repositoryIdНеобходимыйstring
Схема JSON

Ответы

202

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

202

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200

mcp-tokens

GET/api/v1/mcp-tokens

List safe MCP token metadata

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

query
userIdstring · uuidnullable
Схема JSON

Ответы

200

POST/api/v1/mcp-tokens

Create a user-owned MCP token

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Тело запроса

Необходимый
application/json
CreateMcpAccessTokenDto · object
Характеристики
Схема JSON

Ответы

201

DELETE/api/v1/mcp-tokens/{id}

Revoke an MCP token

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Ответы

204

ProviderAccounts

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

query
page
anyOf
number
string
Схема JSON
query
perPage
anyOf
number
string
Схема JSON
query
fieldsstring
Схема JSON
query
whereProviderAccountWhere · object
Характеристики
Схема JSON
query
orderBy
anyOf
ProviderAccountOrderBy · object
Характеристики
array
Элементы массива
ProviderAccountOrderBy · object
Характеристики
Схема JSON
query
selectProviderAccountSelect · object
Характеристики
Схема JSON
query
includeProviderAccountInclude · object
Характеристики
Схема JSON
query
cursorstring
Характеристики
Схема JSON
query
distinct
anyOf
string

["authenticationMethod","githubInstallationState","id","createdAt","updatedAt","providerType","displayName","baseUrl","enabled","lastSyncAt"]

array
Элементы массива
string

["authenticationMethod","githubInstallationState","id","createdAt","updatedAt","providerType","displayName","baseUrl","enabled","lastSyncAt"]

Схема JSON
query
searchstring
Схема JSON

Ответы

200 Configured provider accounts.
400 Invalid provider-account query.
401
403

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Тело запроса

Необходимый
application/json
CreateProviderAccountDto · object
Характеристики
Схема JSON

Ответы

201

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Тело запроса

Необходимый
application/json
UpdateProviderAccountDto · object
Характеристики
Схема JSON

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Ответы

204

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Тело запроса

Необходимый
application/json
CreateTrackedRepositoryDto · object
Характеристики
Схема JSON

Ответы

201

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Тело запроса

Необходимый
application/json
StartProviderOAuthDto · object
Характеристики
Схема JSON

Ответы

201

ProviderOAuth

Аутентификация

По этому контракту аутентификация не требуется.

Параметры

query
stateНеобходимыйstring
Схема JSON
query
codestringnullable
Схема JSON
query
errorstringnullable
Схема JSON
query
error_descriptionstringnullable
Схема JSON
query
error_uristringnullable
Схема JSON

Ответы

200

pull-requests

GET/api/v1/pull-requests

Query visible pull requests

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

query
page
anyOf
number
string
Схема JSON
query
perPage
anyOf
number
string
Схема JSON
query
fieldsstring
Схема JSON
query
wherePullRequestWhere · object
Характеристики
Схема JSON
query
orderBy
anyOf
PullRequestOrderBy · object
Характеристики
array
Элементы массива
PullRequestOrderBy · object
Характеристики
Схема JSON
query
selectPullRequestSelect · object
Характеристики
Схема JSON
query
includePullRequestInclude · object
Характеристики
Схема JSON
query
cursorstring
Характеристики
Схема JSON
query
distinct
anyOf
string

["id","createdAt","updatedAt","number","title","body","state","draft","sourceBranch","targetBranch","url","providerCreatedAt","providerUpdatedAt","closedAt","mergedAt","workflowStatus","workflowApprovalRequired","repositoryId"]

array
Элементы массива
string

["id","createdAt","updatedAt","number","title","body","state","draft","sourceBranch","targetBranch","url","providerCreatedAt","providerUpdatedAt","closedAt","mergedAt","workflowStatus","workflowApprovalRequired","repositoryId"]

Схема JSON
query
searchstringnullable
Схема JSON
query
labelsnullable
anyOf
string
array
Элементы массива
string
Схема JSON

Ответы

200 Visible provider pull requests.
400 Invalid pull-request query.
401
403

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200

Repositories

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

query
page
anyOf
number
string
Схема JSON
query
perPage
anyOf
number
string
Схема JSON
query
fieldsstring
Схема JSON
query
whereRepositoryWhere · object
Характеристики
Схема JSON
query
orderBy
anyOf
RepositoryOrderBy · object
Характеристики
array
Элементы массива
RepositoryOrderBy · object
Характеристики
Схема JSON
query
selectRepositorySelect · object
Характеристики
Схема JSON
query
includeRepositoryInclude · object
Характеристики
Схема JSON
query
cursorstring
Характеристики
Схема JSON
query
distinct
anyOf
string

["id","createdAt","updatedAt","providerRepositoryId","owner","name","url","enabled","lastSyncAt","providerAccountId","workflowRunRetentionDays","issueRetentionDays","pullRequestRetentionDays"]

array
Элементы массива
string

["id","createdAt","updatedAt","providerRepositoryId","owner","name","url","enabled","lastSyncAt","providerAccountId","workflowRunRetentionDays","issueRetentionDays","pullRequestRetentionDays"]

Схема JSON
query
searchstring
Схема JSON

Ответы

200 Tracked repositories.
400 Invalid repository query.
401
403

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Тело запроса

Необходимый
application/json
UpdateRepositoryDto · object
Характеристики
Схема JSON

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON
path
userIdНеобходимыйstring
Схема JSON

Тело запроса

Необходимый
application/json
UpsertRepositoryMembershipDto · object
Характеристики
Схема JSON

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON
path
userIdНеобходимыйstring
Схема JSON

Ответы

204

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Тело запроса

Необходимый
application/json
SetRepositoryWebhookSecretDto · object
Характеристики
Схема JSON

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Ответы

204

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Тело запроса

Необходимый
application/json
CreateWorkflowFilterDto · object
Характеристики
Схема JSON

Ответы

201

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON
path
filterIdНеобходимыйstring
Схема JSON

Ответы

204

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200

RepositoryRefresh

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Ответы

201

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Ответы

202

RepositoryGroups

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
repositoryIdНеобходимыйstring
Схема JSON

Ответы

200
400
401
403

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
repositoryIdНеобходимыйstring
Схема JSON
path
groupIdНеобходимыйstring
Схема JSON

Тело запроса

Необходимый
application/json
SaveRepositoryGroupDto · object
Характеристики
Схема JSON

Ответы

200
400
401
403

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
repositoryIdНеобходимыйstring
Схема JSON
path
groupIdНеобходимыйstring
Схема JSON

Ответы

204
400
401
403

security-alerts

GET/api/v1/security-alerts

Query visible security alerts

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

query
page
anyOf
number
string
Схема JSON
query
perPage
anyOf
number
string
Схема JSON
query
fieldsstring
Схема JSON
query
whereSecurityAlertWhere · object
Характеристики
Схема JSON
query
orderBy
anyOf
SecurityAlertOrderBy · object
Характеристики
array
Элементы массива
SecurityAlertOrderBy · object
Характеристики
Схема JSON
query
selectSecurityAlertSelect · object
Характеристики
Схема JSON
query
includeSecurityAlertInclude · object
Характеристики
Схема JSON
query
cursorstring
Характеристики
Схема JSON
query
distinct
anyOf
string

["id","createdAt","updatedAt","kind","state","severity","title","scanner","providerCreatedAt","providerUpdatedAt","resolvedAt","resolution","packageName","ecosystem","manifest","ruleId","tool","secretType","secretProvider","repositoryId"]

array
Элементы массива
string

["id","createdAt","updatedAt","kind","state","severity","title","scanner","providerCreatedAt","providerUpdatedAt","resolvedAt","resolution","packageName","ecosystem","manifest","ruleId","tool","secretType","secretProvider","repositoryId"]

Схема JSON
query
searchstring
Схема JSON

Ответы

200 Visible normalized security alerts.
400 Invalid security-alert query.
401
403

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200

settings

GET/api/v1/settings

Get global application settings

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200

PATCH/api/v1/settings

Update global application settings

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Тело запроса

Необходимый
application/json
UpdateApplicationSettingsDto · object
Характеристики
Схема JSON

Ответы

200
403 System administrator access is required.

UserGroups

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

query
page
anyOf
number
string
Схема JSON
query
perPage
anyOf
number
string
Схема JSON
query
fieldsstring
Схема JSON
query
whereUserGroupWhere · object
Характеристики
Схема JSON
query
orderBy
anyOf
UserGroupOrderBy · object
Характеристики
array
Элементы массива
UserGroupOrderBy · object
Характеристики
Схема JSON
query
selectUserGroupSelect · object
Характеристики
Схема JSON
query
includeUserGroupInclude · object
Схема JSON
query
cursorstring
Характеристики
Схема JSON
query
distinct
anyOf
string

["id","name","createdAt","updatedAt"]

array
Элементы массива
string

["id","name","createdAt","updatedAt"]

Схема JSON

Ответы

200
400
401
403

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Тело запроса

Необходимый
application/json
SaveUserGroupDto · object
Характеристики
Схема JSON

Ответы

200
400
401
403

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Тело запроса

Необходимый
application/json
SaveUserGroupDto · object
Характеристики
Схема JSON

Ответы

200
400
401
403

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Ответы

204
400
401
403

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON
query
page
anyOf
number
string
Схема JSON
query
perPage
anyOf
number
string
Схема JSON
query
fieldsstring
Схема JSON
query
whereUserWhere · object
Характеристики
Схема JSON
query
orderBy
anyOf
UserOrderBy · object
Характеристики
array
Элементы массива
UserOrderBy · object
Характеристики
Схема JSON
query
selectUserSelect · object
Характеристики
Схема JSON
query
includeUserInclude · object
Схема JSON
query
cursorstring
Характеристики
Схема JSON
query
distinct
anyOf
string

["id","createdAt","updatedAt","username","firstName","lastName","authProvider","role"]

array
Элементы массива
string

["id","createdAt","updatedAt","username","firstName","lastName","authProvider","role"]

Схема JSON

Ответы

200
400
401
403

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON
path
userIdНеобходимыйstring
Схема JSON

Ответы

204
400
401
403

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON
path
userIdНеобходимыйstring
Схема JSON

Ответы

204
400
401
403

Users

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

query
page
anyOf
number
string
Схема JSON
query
perPage
anyOf
number
string
Схема JSON
query
fieldsstring
Схема JSON
query
whereUserWhere · object
Характеристики
Схема JSON
query
orderBy
anyOf
UserOrderBy · object
Характеристики
array
Элементы массива
UserOrderBy · object
Характеристики
Схема JSON
query
selectUserSelect · object
Характеристики
Схема JSON
query
includeUserInclude · object
Схема JSON
query
cursorstring
Характеристики
Схема JSON
query
distinct
anyOf
string

["id","createdAt","updatedAt","username","firstName","lastName","authProvider","role"]

array
Элементы массива
string

["id","createdAt","updatedAt","username","firstName","lastName","authProvider","role"]

Схема JSON

Ответы

200 System users.
400 Invalid user query.
401
403

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Тело запроса

Необходимый
application/json
CreateUserDto · object
Характеристики
Схема JSON

Ответы

201

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Ответы

200

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

path
idНеобходимыйstring
Схема JSON

Тело запроса

Необходимый
application/json
ResetUserPasswordDto · object
Характеристики
Схема JSON

Ответы

204
400
401
403
404 User not found.

version

GET/api/v1/version/latest

Get the latest released Repovio version

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Ответы

200

webhooks

POST/api/v1/webhooks/forgejo/{repositoryId}

Accept a signed Forgejo webhook delivery

Аутентификация

По этому контракту аутентификация не требуется.

Параметры

path
repositoryIdНеобходимыйstring · uuid
Схема JSON

Ответы

202 The delivery was accepted for asynchronous synchronization.

POST/api/v1/webhooks/gitea/{repositoryId}

Accept a signed Gitea webhook delivery

Аутентификация

По этому контракту аутентификация не требуется.

Параметры

path
repositoryIdНеобходимыйstring · uuid
Схема JSON

Ответы

202 The delivery was accepted for asynchronous synchronization.

POST/api/v1/webhooks/github-app

Accept a signed GitHub App delivery

Аутентификация

По этому контракту аутентификация не требуется.

Ответы

202 The App delivery was durably accepted.

POST/api/v1/webhooks/github/{repositoryId}

Accept a signed GitHub webhook delivery

Аутентификация

По этому контракту аутентификация не требуется.

Параметры

path
repositoryIdНеобходимыйstring · uuid
Схема JSON

Ответы

202 The delivery was accepted for asynchronous synchronization.

POST/api/v1/webhooks/gitlab/{repositoryId}

Accept a signed GitLab webhook delivery

Аутентификация

По этому контракту аутентификация не требуется.

Параметры

path
repositoryIdНеобходимыйstring · uuid
Схема JSON

Ответы

202 The delivery was accepted for asynchronous synchronization.

POST/api/webhooks/forgejo/{repositoryId}

Accept a signed Forgejo webhook delivery

Аутентификация

По этому контракту аутентификация не требуется.

Параметры

path
repositoryIdНеобходимыйstring · uuid
Схема JSON

Ответы

202 The delivery was accepted for asynchronous synchronization.

POST/api/webhooks/gitea/{repositoryId}

Accept a signed Gitea webhook delivery

Аутентификация

По этому контракту аутентификация не требуется.

Параметры

path
repositoryIdНеобходимыйstring · uuid
Схема JSON

Ответы

202 The delivery was accepted for asynchronous synchronization.

POST/api/webhooks/github-app

Accept a signed GitHub App delivery

Аутентификация

По этому контракту аутентификация не требуется.

Ответы

202 The App delivery was durably accepted.

POST/api/webhooks/github/{repositoryId}

Accept a signed GitHub webhook delivery

Аутентификация

По этому контракту аутентификация не требуется.

Параметры

path
repositoryIdНеобходимыйstring · uuid
Схема JSON

Ответы

202 The delivery was accepted for asynchronous synchronization.

POST/api/webhooks/gitlab/{repositoryId}

Accept a signed GitLab webhook delivery

Аутентификация

По этому контракту аутентификация не требуется.

Параметры

path
repositoryIdНеобходимыйstring · uuid
Схема JSON

Ответы

202 The delivery was accepted for asynchronous synchronization.

workflow-runs

GET/api/v1/workflow-runs

Query visible workflow runs

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

query
page
anyOf
number
string
Схема JSON
query
perPage
anyOf
number
string
Схема JSON
query
fieldsstring
Схема JSON
query
whereWorkflowRunWhere · object
Характеристики
Схема JSON
query
orderBy
anyOf
WorkflowRunOrderBy · object
Характеристики
array
Элементы массива
WorkflowRunOrderBy · object
Характеристики
Схема JSON
query
selectWorkflowRunSelect · object
Характеристики
Схема JSON
query
includeWorkflowRunInclude · object
Характеристики
Схема JSON
query
cursorstring
Характеристики
Схема JSON
query
distinct
anyOf
string

["id","createdAt","updatedAt","providerRunId","workflowName","displayTitle","url","providerCreatedAt","startedAt","completedAt","durationMs","status","awaitingApproval","event","scopeKey","workflowId","repositoryId"]

array
Элементы массива
string

["id","createdAt","updatedAt","providerRunId","workflowName","displayTitle","url","providerCreatedAt","startedAt","completedAt","durationMs","status","awaitingApproval","event","scopeKey","workflowId","repositoryId"]

Схема JSON
query
searchstring
Схема JSON

Ответы

200 Visible workflow runs.
400 Invalid workflow-run query.
401
403

GET/api/v1/workflow-runs/needs-attention

Query visible workflow runs that need attention

Аутентификация

  • Альтернатива 1 (требуются все перечисленные схемы)

    bearer · http · bearer

Параметры

query
page
anyOf
number
string
Схема JSON
query
perPage
anyOf
number
string
Схема JSON
query
fieldsstring
Схема JSON
query
whereWorkflowRunWhere · object
Характеристики
Схема JSON
query
orderBy
anyOf
WorkflowRunOrderBy · object
Характеристики
array
Элементы массива
WorkflowRunOrderBy · object
Характеристики
Схема JSON
query
selectWorkflowRunSelect · object
Характеристики
Схема JSON
query
includeWorkflowRunInclude · object
Характеристики
Схема JSON
query
cursorstring
Характеристики
Схема JSON
query
distinct
anyOf
string

["id","createdAt","updatedAt","providerRunId","workflowName","displayTitle","url","providerCreatedAt","startedAt","completedAt","durationMs","status","awaitingApproval","event","scopeKey","workflowId","repositoryId"]

array
Элементы массива
string

["id","createdAt","updatedAt","providerRunId","workflowName","displayTitle","url","providerCreatedAt","startedAt","completedAt","durationMs","status","awaitingApproval","event","scopeKey","workflowId","repositoryId"]

Схема JSON
query
searchstring
Схема JSON

Ответы

200 Visible latest terminal workflow failures.
400 Invalid needs-attention workflow-run query.
401
403