arcade-mcp/toolkits/github_api/arcade_github_api/wrapper_tools/LockGithubIssue.json
jottakka de742ff4f1
[MOAR][Asana][Github] Adding GitHub and Asana starter toolkits (#663)
Co-authored-by: Francisco Liberal <francisco@arcade.dev>
2025-10-30 18:21:34 -03:00

226 lines
8.1 KiB
JSON

{
"name": "LockGithubIssue",
"fully_qualified_name": "GithubApi.LockGithubIssue@0.1.0",
"description": "Lock a GitHub issue or pull request conversation.\n\nUse this tool to prevent further interactions with a specific GitHub issue or pull request by locking its conversation. It requires push access to 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 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 in which the issue or pull request exists. 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."
},
"inferrable": true,
"http_endpoint_parameter_name": "repo"
},
{
"name": "issue_number",
"required": true,
"description": "The number that identifies the GitHub issue to lock.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The number that identifies the issue."
},
"inferrable": true,
"http_endpoint_parameter_name": "issue_number"
},
{
"name": "issue_lock_reason",
"required": false,
"description": "The reason for locking the conversation. Acceptable values: 'off-topic', 'too heated', 'resolved', 'spam'.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"off-topic",
"too heated",
"resolved",
"spam"
],
"properties": null,
"inner_properties": null,
"description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n * `off-topic` \n * `too heated` \n * `resolved` \n * `spam`"
},
"inferrable": true,
"http_endpoint_parameter_name": "lock_reason"
}
]
},
"output": {
"description": "Response from the API endpoint 'issues/lock'.",
"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}/issues/{issue_number}/lock",
"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": "issue_number",
"tool_parameter_name": "issue_number",
"description": "The number that identifies the issue.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The number that identifies the issue."
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "lock_reason",
"tool_parameter_name": "issue_lock_reason",
"description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n * `off-topic` \n * `too heated` \n * `resolved` \n * `spam`",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"off-topic",
"too heated",
"resolved",
"spam"
],
"properties": null,
"inner_properties": null,
"description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n * `off-topic` \n * `too heated` \n * `resolved` \n * `spam`"
},
"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 \"default\": {\n \"summary\": \"Example of locking an issue as off-topic\",\n \"value\": {\n \"lock_reason\": \"off-topic\"\n }\n }\n },\n \"schema\": {\n \"nullable\": true,\n \"properties\": {\n \"lock_reason\": {\n \"description\": \"The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \\n * `off-topic` \\n * `too heated` \\n * `resolved` \\n * `spam`\",\n \"enum\": [\n \"off-topic\",\n \"too heated\",\n \"resolved\",\n \"spam\"\n ],\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
}
}