{ "name": "UpdateGithubPagesInfo", "fully_qualified_name": "GithubApi.UpdateGithubPagesInfo@0.1.0", "description": "Update information for a GitHub Pages site.\n\nUse this tool to update settings or information for a GitHub Pages site on a repository. The user must have appropriate permissions, such as repository administrator, maintainer, or 'manage GitHub Pages settings' permission. Requires a token with 'repo' scope or Pages write permission. GitHub Apps need 'administration:write' and 'pages:write' permissions.", "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 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." }, "inferrable": true, "http_endpoint_parameter_name": "repo" }, { "name": "github_pages_configuration", "required": true, "description": "A JSON object containing configuration details for the GitHub Pages site. Include fields such as 'build_type', 'cname', 'https_enforced', and 'source'.", "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "build_type": { "val_type": "string", "inner_val_type": null, "enum": [ "legacy", "workflow" ], "properties": null, "inner_properties": null, "description": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch." }, "cname": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.8/articles/using-a-custom-domain-with-github-pages/).\"" }, "https_enforced": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Specify whether HTTPS should be enforced for the repository." }, "source": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": null } }, "inner_properties": null, "description": "" }, "inferrable": true, "http_endpoint_parameter_name": "requestBody" } ] }, "output": { "description": "Response from the API endpoint 'repos/update-information-about-pages-site'.", "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}/pages", "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": "requestBody", "tool_parameter_name": "github_pages_configuration", "description": "", "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "build_type": { "val_type": "string", "inner_val_type": null, "enum": [ "legacy", "workflow" ], "properties": null, "inner_properties": null, "description": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch." }, "cname": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.8/articles/using-a-custom-domain-with-github-pages/).\"" }, "https_enforced": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Specify whether HTTPS should be enforced for the repository." }, "source": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": null } }, "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 \"cname\": \"octocatblog.com\",\n \"source\": {\n \"branch\": \"main\",\n \"path\": \"/\"\n }\n }\n }\n },\n \"schema\": {\n \"anyOf\": [\n {\n \"required\": [\n \"build_type\"\n ]\n },\n {\n \"required\": [\n \"source\"\n ]\n },\n {\n \"required\": [\n \"cname\"\n ]\n },\n {\n \"required\": [\n \"public\"\n ]\n },\n {\n \"required\": [\n \"https_enforced\"\n ]\n }\n ],\n \"properties\": {\n \"build_type\": {\n \"description\": \"The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.\",\n \"enum\": [\n \"legacy\",\n \"workflow\"\n ],\n \"type\": \"string\"\n },\n \"cname\": {\n \"description\": \"Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \\\"[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.8/articles/using-a-custom-domain-with-github-pages/).\\\"\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"https_enforced\": {\n \"description\": \"Specify whether HTTPS should be enforced for the repository.\",\n \"type\": \"boolean\"\n },\n \"source\": {\n \"anyOf\": [\n {\n \"description\": \"Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\\\"gh-pages\\\"`, `\\\"master\\\"`, and `\\\"master /docs\\\"`.\",\n \"enum\": [\n \"gh-pages\",\n \"master\",\n \"master /docs\"\n ],\n \"type\": \"string\"\n },\n {\n \"description\": \"Update the source for the repository. Must include the branch name and path.\",\n \"properties\": {\n \"branch\": {\n \"description\": \"The repository branch used to publish your site's source files.\",\n \"type\": \"string\"\n },\n \"path\": {\n \"description\": \"The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.\",\n \"enum\": [\n \"/\",\n \"/docs\"\n ],\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"branch\",\n \"path\"\n ],\n \"type\": \"object\"\n }\n ]\n }\n },\n \"type\": \"object\"\n }\n }\n },\n \"required\": true\n}", "use_request_body_schema_mode": true, "validate_request_body_schema": true } }