API referansı İngilizce yayımlanır.

Save GitHub bot review configuration

PUT/api/chat-endpoints/{endpointId}/github/configuration
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

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.

Yetkilendirme

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. Anahtarlar nasıl çalışır.

Yol parametreleri

endpointIdstring (uuid)ZorunluThe endpoint's id.

İstek gövdesi

application/json · zorunlu

expectedRevisionintegerZorunlu≥ 0
configurationobjectZorunlu
configuration.versionnumberZorunluone of: 1
configuration.toolsEnabledbooleanZorunlu
configuration.responsibleUserIdstringZorunluat least 1 character
configuration.memberAccessstringZorunluone of: "all_linked", "selected"
configuration.peoplearray<object>Zorunlu
configuration.defaultsobjectZorunlu
configuration.defaults.invocationstringZorunluone of: "mentions_only", "linked_authors", "allowed_authors"
configuration.defaults.eventsarray<string>Zorunluitems one of: "opened", "synchronize", "reopened", "ready_for_review", "mention", "comment"
configuration.defaults.issueOpenedbooleanİsteğe bağlı
configuration.defaults.issueOpenedInstructionsstringİsteğe bağlıat most 12000 characters
configuration.defaults.reviewDraftsbooleanZorunlu
configuration.defaults.reviewBotAuthorsbooleanZorunlu
configuration.defaults.includeAuthorsarray<string>Zorunlueach at most 256 characters
configuration.defaults.excludeAuthorsarray<string>Zorunlueach at most 256 characters
configuration.defaults.targetBranchesarray<string>Zorunlueach at most 256 characters
configuration.defaults.excludedBranchesarray<string>Zorunlueach at most 256 characters
configuration.defaults.requiredLabelsarray<string>Zorunlueach at most 256 characters
configuration.defaults.excludedLabelsarray<string>Zorunlueach at most 256 characters
configuration.defaults.ignoredPathsarray<string>Zorunlueach at most 256 characters
configuration.defaults.instructionsstringZorunluat most 24000 characters
configuration.defaults.promptsobjectZorunlu
configuration.defaults.findingCategoriesarray<string>Zorunlueach at most 256 characters
configuration.defaults.minimumCommentSeveritystringZorunluone of: "info", "warning", "error"
configuration.defaults.publishSummarybooleanZorunlu
configuration.defaults.publishInlinebooleanZorunlu
configuration.defaults.allowApprovebooleanZorunlu
configuration.defaults.allowRequestChangesbooleanZorunlu
configuration.defaults.ratingThresholdnumber | anyZorunlu
configuration.repositoriesobject<string, object>Zorunlu

Yanıtlar

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.

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Chat channels