323 lines
11 KiB
JSON
323 lines
11 KiB
JSON
{
|
|
"name": "MergeGithubPullRequest",
|
|
"fully_qualified_name": "GithubApi.MergeGithubPullRequest@0.1.0",
|
|
"description": "Merge a pull request on GitHub.\n\nThis tool merges a specified pull request on GitHub for a given repository. It should be called when a user wants to merge changes from a pull request into the main branch. Notifications will be triggered, and users should be mindful of secondary rate limits.",
|
|
"toolkit": {
|
|
"name": "ArcadeGithubApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "repository_owner",
|
|
"required": true,
|
|
"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."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "owner"
|
|
},
|
|
{
|
|
"name": "repository_name",
|
|
"required": true,
|
|
"description": "The name of the repository. It 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": "pull_request_number",
|
|
"required": true,
|
|
"description": "The unique number identifying the pull request to be merged.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The number that identifies the pull request."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "pull_number"
|
|
},
|
|
{
|
|
"name": "extra_commit_message",
|
|
"required": false,
|
|
"description": "Extra detail to append to the automatic commit message for the pull request.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Extra detail to append to automatic commit message."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "commit_message"
|
|
},
|
|
{
|
|
"name": "commit_title",
|
|
"required": false,
|
|
"description": "Title for the automatic commit message after merging the pull request.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Title for the automatic commit message."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "commit_title"
|
|
},
|
|
{
|
|
"name": "merge_method",
|
|
"required": false,
|
|
"description": "Specifies the method to merge the pull request. Options include 'merge', 'squash', or 'rebase'.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"merge",
|
|
"squash",
|
|
"rebase"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The merge method to use."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "merge_method"
|
|
},
|
|
{
|
|
"name": "pull_request_head_sha",
|
|
"required": false,
|
|
"description": "SHA of the pull request head that must match for the merge to proceed.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "SHA that pull request head must match to allow merge."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "sha"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'pulls/merge'.",
|
|
"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}/pulls/{pull_number}/merge",
|
|
"http_method": "PUT",
|
|
"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": "pull_number",
|
|
"tool_parameter_name": "pull_request_number",
|
|
"description": "The number that identifies the pull request.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The number that identifies the pull request."
|
|
},
|
|
"accepted_as": "path",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "commit_message",
|
|
"tool_parameter_name": "extra_commit_message",
|
|
"description": "Extra detail to append to automatic commit message.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Extra detail to append to automatic commit message."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "commit_title",
|
|
"tool_parameter_name": "commit_title",
|
|
"description": "Title for the automatic commit message.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Title for the automatic commit message."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "merge_method",
|
|
"tool_parameter_name": "merge_method",
|
|
"description": "The merge method to use.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"merge",
|
|
"squash",
|
|
"rebase"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The merge method to use."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "sha",
|
|
"tool_parameter_name": "pull_request_head_sha",
|
|
"description": "SHA that pull request head must match to allow merge.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "SHA that pull request head must match to allow merge."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"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 \"response-if-merge-was-successful\": {\n \"value\": {\n \"commit_message\": \"Add a new value to the merge_method enum\",\n \"commit_title\": \"Expand enum\"\n }\n }\n },\n \"schema\": {\n \"nullable\": true,\n \"properties\": {\n \"commit_message\": {\n \"description\": \"Extra detail to append to automatic commit message.\",\n \"type\": \"string\"\n },\n \"commit_title\": {\n \"description\": \"Title for the automatic commit message.\",\n \"type\": \"string\"\n },\n \"merge_method\": {\n \"description\": \"The merge method to use.\",\n \"enum\": [\n \"merge\",\n \"squash\",\n \"rebase\"\n ],\n \"type\": \"string\"\n },\n \"sha\": {\n \"description\": \"SHA that pull request head must match to allow merge.\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n }\n }\n },\n \"required\": false\n}",
|
|
"use_request_body_schema_mode": false,
|
|
"validate_request_body_schema": false
|
|
}
|
|
}
|