414 lines
18 KiB
JSON
414 lines
18 KiB
JSON
{
|
|
"name": "StartOrgMigration",
|
|
"fully_qualified_name": "GithubApi.StartOrgMigration@0.1.0",
|
|
"description": "Initiates a migration archive for a GitHub organization.\n\nUse this tool to start the process of generating a migration archive for a specified GitHub organization. This is useful for moving or backing up repositories and data from an organization.",
|
|
"toolkit": {
|
|
"name": "ArcadeGithubApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "organization_name",
|
|
"required": true,
|
|
"description": "The name of the GitHub organization. The name is not case sensitive.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The organization name. The name is not case sensitive."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "org"
|
|
},
|
|
{
|
|
"name": "repositories_to_migrate",
|
|
"required": true,
|
|
"description": "A list of repository names to be included in the migration process.",
|
|
"value_schema": {
|
|
"val_type": "array",
|
|
"inner_val_type": "string",
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A list of arrays indicating which repositories should be migrated."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "repositories"
|
|
},
|
|
{
|
|
"name": "exclude_items",
|
|
"required": false,
|
|
"description": "Specify related items to exclude from the response for performance optimization, e.g., [\"repositories\"].",
|
|
"value_schema": {
|
|
"val_type": "array",
|
|
"inner_val_type": "string",
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "exclude"
|
|
},
|
|
{
|
|
"name": "exclude_attachments",
|
|
"required": false,
|
|
"description": "Set to true to exclude attachments from the migration, reducing archive file size.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size)."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "exclude_attachments"
|
|
},
|
|
{
|
|
"name": "exclude_git_data",
|
|
"required": false,
|
|
"description": "Set to true to exclude repository git data from the migration, reducing archive size. Useful for metadata-only migrations.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates whether the repository git data should be excluded from the migration."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "exclude_git_data"
|
|
},
|
|
{
|
|
"name": "exclude_metadata",
|
|
"required": false,
|
|
"description": "Set to true to exclude metadata, including only git source. Useful for reducing file complexity.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates whether metadata should be excluded and only git source should be included for the migration."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "exclude_metadata"
|
|
},
|
|
{
|
|
"name": "exclude_owner_projects",
|
|
"required": false,
|
|
"description": "Indicate whether projects owned by the organization or users should be excluded from the migration.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates whether projects owned by the organization or users should be excluded. from the migration."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "exclude_owner_projects"
|
|
},
|
|
{
|
|
"name": "exclude_releases",
|
|
"required": false,
|
|
"description": "Set to true to exclude releases from the migration archive, reducing file size.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size)."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "exclude_releases"
|
|
},
|
|
{
|
|
"name": "lock_repositories",
|
|
"required": false,
|
|
"description": "Set to true to lock repositories during migration, preventing changes.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "lock_repositories"
|
|
},
|
|
{
|
|
"name": "only_include_org_metadata",
|
|
"required": false,
|
|
"description": "Specify whether only organization metadata is included, keeping the repositories array empty and ignoring other flags.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags)."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "org_metadata_only"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'migrations/start-for-org'.",
|
|
"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/orgs/{org}/migrations",
|
|
"http_method": "POST",
|
|
"headers": {},
|
|
"parameters": [
|
|
{
|
|
"name": "org",
|
|
"tool_parameter_name": "organization_name",
|
|
"description": "The organization name. The name is not case sensitive.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The organization name. The name is not case sensitive."
|
|
},
|
|
"accepted_as": "path",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "exclude",
|
|
"tool_parameter_name": "exclude_items",
|
|
"description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.",
|
|
"value_schema": {
|
|
"val_type": "array",
|
|
"inner_val_type": "string",
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "exclude_attachments",
|
|
"tool_parameter_name": "exclude_attachments",
|
|
"description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size)."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "exclude_git_data",
|
|
"tool_parameter_name": "exclude_git_data",
|
|
"description": "Indicates whether the repository git data should be excluded from the migration.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates whether the repository git data should be excluded from the migration."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "exclude_metadata",
|
|
"tool_parameter_name": "exclude_metadata",
|
|
"description": "Indicates whether metadata should be excluded and only git source should be included for the migration.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates whether metadata should be excluded and only git source should be included for the migration."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "exclude_owner_projects",
|
|
"tool_parameter_name": "exclude_owner_projects",
|
|
"description": "Indicates whether projects owned by the organization or users should be excluded. from the migration.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates whether projects owned by the organization or users should be excluded. from the migration."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "exclude_releases",
|
|
"tool_parameter_name": "exclude_releases",
|
|
"description": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size).",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size)."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "lock_repositories",
|
|
"tool_parameter_name": "lock_repositories",
|
|
"description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "org_metadata_only",
|
|
"tool_parameter_name": "only_include_org_metadata",
|
|
"description": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags)."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "repositories",
|
|
"tool_parameter_name": "repositories_to_migrate",
|
|
"description": "A list of arrays indicating which repositories should be migrated.",
|
|
"value_schema": {
|
|
"val_type": "array",
|
|
"inner_val_type": "string",
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A list of arrays indicating which repositories should be migrated."
|
|
},
|
|
"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 \"lock_repositories\": true,\n \"repositories\": [\n \"github/Hello-World\"\n ]\n }\n }\n },\n \"schema\": {\n \"properties\": {\n \"exclude\": {\n \"description\": \"Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\\\"repositories\\\"`.\",\n \"items\": {\n \"enum\": [\n \"repositories\"\n ],\n \"type\": \"string\"\n },\n \"type\": \"array\"\n },\n \"exclude_attachments\": {\n \"default\": false,\n \"description\": \"Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).\",\n \"example\": true,\n \"type\": \"boolean\"\n },\n \"exclude_git_data\": {\n \"default\": false,\n \"description\": \"Indicates whether the repository git data should be excluded from the migration.\",\n \"type\": \"boolean\"\n },\n \"exclude_metadata\": {\n \"default\": false,\n \"description\": \"Indicates whether metadata should be excluded and only git source should be included for the migration.\",\n \"type\": \"boolean\"\n },\n \"exclude_owner_projects\": {\n \"default\": false,\n \"description\": \"Indicates whether projects owned by the organization or users should be excluded. from the migration.\",\n \"example\": true,\n \"type\": \"boolean\"\n },\n \"exclude_releases\": {\n \"default\": false,\n \"description\": \"Indicates whether releases should be excluded from the migration (to reduce migration archive file size).\",\n \"example\": true,\n \"type\": \"boolean\"\n },\n \"lock_repositories\": {\n \"default\": false,\n \"description\": \"Indicates whether repositories should be locked (to prevent manipulation) while migrating data.\",\n \"example\": true,\n \"type\": \"boolean\"\n },\n \"org_metadata_only\": {\n \"default\": false,\n \"description\": \"Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).\",\n \"example\": true,\n \"type\": \"boolean\"\n },\n \"repositories\": {\n \"description\": \"A list of arrays indicating which repositories should be migrated.\",\n \"items\": {\n \"type\": \"string\"\n },\n \"type\": \"array\"\n }\n },\n \"required\": [\n \"repositories\"\n ],\n \"type\": \"object\"\n }\n }\n },\n \"required\": true\n}",
|
|
"use_request_body_schema_mode": false,
|
|
"validate_request_body_schema": false
|
|
}
|
|
}
|