{ "name": "SetCheckSuitePreferences", "fully_qualified_name": "GithubApi.SetCheckSuitePreferences@0.1.0", "description": "Set preferences for check suite creation in a repository.\n\nChanges the default automatic flow for creating check suites in a GitHub repository. Use this tool to enable or disable the automatic creation of check suites when code is pushed. Requires admin permissions in the repository.", "toolkit": { "name": "ArcadeGithubApi", "description": null, "version": "0.1.0" }, "input": { "parameters": [ { "name": "repository_owner", "required": true, "description": "The account owner of the repository. This value is not case sensitive.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The account owner of the repository. The name is not case sensitive." }, "inferrable": true, "http_endpoint_parameter_name": "owner" }, { "name": "repository_name", "required": true, "description": "The name of the GitHub repository. This value is not case sensitive.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The name of the repository. The name is not case sensitive." }, "inferrable": true, "http_endpoint_parameter_name": "repo" }, { "name": "auto_trigger_checks", "required": true, "description": "A JSON array to enable or disable automatic creation of CheckSuites. Each element contains an 'app_id' for the GitHub App and a 'setting' to specify whether to enable (true) or disable (false) automatic creation.", "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "auto_trigger_checks": { "val_type": "array", "inner_val_type": "json", "enum": null, "properties": null, "inner_properties": { "app_id": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The `id` of the GitHub App." }, "setting": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them." } }, "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default." } }, "inner_properties": null, "description": "" }, "inferrable": true, "http_endpoint_parameter_name": "requestBody" } ] }, "output": { "description": "Response from the API endpoint 'checks/set-suites-preferences'.", "available_modes": [ "value", "error", "null" ], "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": null } }, "requirements": { "authorization": { "provider_id": "arcade-github", "provider_type": "oauth2", "id": null, "oauth2": null }, "secrets": [ { "key": "GIT_SERVER_URL" } ], "metadata": null }, "deprecation_message": null, "metadata": { "object_type": "api_wrapper_tool", "version": "1.1.0", "description": "Tools that enable LLMs to interact directly with the GitHub API." }, "http_endpoint": { "metadata": { "object_type": "http_endpoint", "version": "1.2.0", "description": "" }, "url": "{git_server_url}/api/v3/repos/{owner}/{repo}/check-suites/preferences", "http_method": "PATCH", "headers": {}, "parameters": [ { "name": "owner", "tool_parameter_name": "repository_owner", "description": "The account owner of the repository. The name is not case sensitive.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The account owner of the repository. The name is not case sensitive." }, "accepted_as": "path", "required": true, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "repo", "tool_parameter_name": "repository_name", "description": "The name of the repository. The name is not case sensitive.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The name of the repository. The name is not case sensitive." }, "accepted_as": "path", "required": true, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "requestBody", "tool_parameter_name": "auto_trigger_checks", "description": "", "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "auto_trigger_checks": { "val_type": "array", "inner_val_type": "json", "enum": null, "properties": null, "inner_properties": { "app_id": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The `id` of the GitHub App." }, "setting": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them." } }, "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default." } }, "inner_properties": null, "description": "" }, "accepted_as": "body", "required": true, "deprecated": false, "default": null, "documentation_urls": [] } ], "documentation_urls": [], "secrets": [ { "arcade_key": "GIT_SERVER_URL", "parameter_name": "git_server_url", "accepted_as": "path", "formatted_value": null, "description": "", "is_auth_token": false }, { "arcade_key": "auth_token", "parameter_name": "Authorization", "accepted_as": "header", "formatted_value": "Bearer {authorization}", "description": "The OAuth token to use for authentication.", "is_auth_token": true } ], "request_body_spec": "{\n \"content\": {\n \"application/json\": {\n \"examples\": {\n \"default\": {\n \"value\": {\n \"auto_trigger_checks\": [\n {\n \"app_id\": 4,\n \"setting\": false\n }\n ]\n }\n }\n },\n \"schema\": {\n \"properties\": {\n \"auto_trigger_checks\": {\n \"description\": \"Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.\",\n \"items\": {\n \"properties\": {\n \"app_id\": {\n \"description\": \"The `id` of the GitHub App.\",\n \"type\": \"integer\"\n },\n \"setting\": {\n \"default\": true,\n \"description\": \"Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.\",\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"app_id\",\n \"setting\"\n ],\n \"type\": \"object\"\n },\n \"type\": \"array\"\n }\n },\n \"type\": \"object\"\n }\n }\n },\n \"required\": true\n}", "use_request_body_schema_mode": true, "validate_request_body_schema": true } }