Справочник API публикуется на английском языке.

Save GitHub bot review configuration

PUT/api/chat-endpoints/{endpointId}/github/configuration
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Save GitHub bot review configuration.

Compares the configuration revision and rechecks members, sponsors, repositories, and agent tool governance. Does not change the bot's assigned agent or enable formal reviews implicitly.

Авторизация

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Как работают ключи.

Параметры пути

endpointIdstring (uuid)ОбязательныйThe endpoint's id.

Тело запроса

application/json · обязательно

expectedRevisionintegerОбязательный≥ 0
configurationobjectОбязательный
configuration.versionnumberОбязательныйone of: 1
configuration.toolsEnabledbooleanОбязательный
configuration.responsibleUserIdstringОбязательныйat least 1 character
configuration.memberAccessstringОбязательныйone of: "all_linked", "selected"
configuration.peoplearray<object>Обязательный
configuration.defaultsobjectОбязательный
configuration.defaults.invocationstringОбязательныйone of: "mentions_only", "linked_authors", "allowed_authors"
configuration.defaults.eventsarray<string>Обязательныйitems one of: "opened", "synchronize", "reopened", "ready_for_review", "mention", "comment"
configuration.defaults.issueOpenedbooleanНеобязательный
configuration.defaults.issueOpenedInstructionsstringНеобязательныйat most 12000 characters
configuration.defaults.reviewDraftsbooleanОбязательный
configuration.defaults.reviewBotAuthorsbooleanОбязательный
configuration.defaults.includeAuthorsarray<string>Обязательныйeach at most 256 characters
configuration.defaults.excludeAuthorsarray<string>Обязательныйeach at most 256 characters
configuration.defaults.targetBranchesarray<string>Обязательныйeach at most 256 characters
configuration.defaults.excludedBranchesarray<string>Обязательныйeach at most 256 characters
configuration.defaults.requiredLabelsarray<string>Обязательныйeach at most 256 characters
configuration.defaults.excludedLabelsarray<string>Обязательныйeach at most 256 characters
configuration.defaults.ignoredPathsarray<string>Обязательныйeach at most 256 characters
configuration.defaults.instructionsstringОбязательныйat most 24000 characters
configuration.defaults.promptsobjectОбязательный
configuration.defaults.findingCategoriesarray<string>Обязательныйeach at most 256 characters
configuration.defaults.minimumCommentSeveritystringОбязательныйone of: "info", "warning", "error"
configuration.defaults.publishSummarybooleanОбязательный
configuration.defaults.publishInlinebooleanОбязательный
configuration.defaults.allowApprovebooleanОбязательный
configuration.defaults.allowRequestChangesbooleanОбязательный
configuration.defaults.ratingThresholdnumber | anyОбязательный
configuration.repositoriesobject<string, object>Обязательный

Ответы

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).
502GitHub returned an invalid response or unavailable capability
503GitHub is temporarily unavailableA dependency is unavailable; retry with backoff.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Chat channels