{ "opencollection": "1.0.0", "info": { "name": "Gitea admin repository API", "version": "1.27.0+dev-89-gf52b6f3315" }, "items": [ { "info": { "name": "repository", "type": "folder" }, "items": [ { "info": { "name": "Migrate a remote git repository", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/migrate" }, "docs": "Migrate a remote git repository" }, { "info": { "name": "Search for repositories", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/search", "params": [ { "name": "q", "value": "", "type": "query", "description": "keyword" }, { "name": "topic", "value": "", "type": "query", "description": "Limit search to repositories with keyword as topic" }, { "name": "includeDesc", "value": "", "type": "query", "description": "include search of keyword within repository description" }, { "name": "uid", "value": "", "type": "query", "description": "search only for repos that the user with the given id owns or contributes to" }, { "name": "priority_owner_id", "value": "", "type": "query", "description": "repo owner to prioritize in the results" }, { "name": "team_id", "value": "", "type": "query", "description": "search only for repos that belong to the given team id" }, { "name": "starredBy", "value": "", "type": "query", "description": "search only for repos that the user with the given id has starred" }, { "name": "private", "value": "", "type": "query", "description": "include private repositories this user has access to (defaults to true)" }, { "name": "is_private", "value": "", "type": "query", "description": "show only pubic, private or all repositories (defaults to all)" }, { "name": "template", "value": "", "type": "query", "description": "include template repositories this user has access to (defaults to true)" }, { "name": "archived", "value": "", "type": "query", "description": "show only archived, non-archived or all repositories (defaults to all)" }, { "name": "mode", "value": "", "type": "query", "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"" }, { "name": "exclusive", "value": "", "type": "query", "description": "if `uid` is given, search only for repos that the user owns" }, { "name": "sort", "value": "", "type": "query", "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", \"git_size\", \"lfs_size\", \"stars\", \"forks\" and \"id\". Default is \"alpha\"" }, { "name": "order", "value": "", "type": "query", "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified." }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "Search for repositories" }, { "info": { "name": "Get a repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Get a repository" }, { "info": { "name": "Edit a repository's properties. Only fields that are set will be changed.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/repos/:owner/:repo", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo to edit" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo to edit" } ] }, "docs": "Edit a repository's properties. Only fields that are set will be changed." }, { "info": { "name": "Delete a repository", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo to delete" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo to delete" } ] }, "docs": "Delete a repository" }, { "info": { "name": "Lists all artifacts for a repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/actions/artifacts", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "name", "value": "", "type": "query", "description": "name of the artifact" } ] }, "docs": "Lists all artifacts for a repository" }, { "info": { "name": "Gets a specific artifact for a workflow run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/actions/artifacts/:artifact_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "artifact_id", "value": "", "type": "path", "description": "id of the artifact" } ] }, "docs": "Gets a specific artifact for a workflow run" }, { "info": { "name": "Deletes a specific artifact for a workflow run", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/actions/artifacts/:artifact_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "artifact_id", "value": "", "type": "path", "description": "id of the artifact" } ] }, "docs": "Deletes a specific artifact for a workflow run" }, { "info": { "name": "Downloads a specific artifact for a workflow run redirects to blob url", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/actions/artifacts/:artifact_id/zip", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "artifact_id", "value": "", "type": "path", "description": "id of the artifact" } ] }, "docs": "Downloads a specific artifact for a workflow run redirects to blob url" }, { "info": { "name": "Lists all jobs for a repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/actions/jobs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "status", "value": "", "type": "query", "description": "workflow status (pending, queued, in_progress, failure, success, skipped)" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "Lists all jobs for a repository" }, { "info": { "name": "Gets a specific workflow job for a workflow run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/actions/jobs/:job_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "job_id", "value": "", "type": "path", "description": "id of the job" } ] }, "docs": "Gets a specific workflow job for a workflow run" }, { "info": { "name": "Downloads the job logs for a workflow run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/actions/jobs/:job_id/logs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "job_id", "value": "", "type": "path", "description": "id of the job" } ] }, "docs": "Downloads the job logs for a workflow run" }, { "info": { "name": "Get repo-level runners", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/actions/runners", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "disabled", "value": "", "type": "query", "description": "filter by disabled status (true or false)" } ] }, "docs": "Get repo-level runners" }, { "info": { "name": "Get a repository's actions runner registration token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/actions/runners/registration-token", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Get a repository's actions runner registration token" }, { "info": { "name": "Get a repo-level runner", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/actions/runners/:runner_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "runner_id", "value": "", "type": "path", "description": "id of the runner" } ] }, "docs": "Get a repo-level runner" }, { "info": { "name": "Update a repo-level runner", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/repos/:owner/:repo/actions/runners/:runner_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "runner_id", "value": "", "type": "path", "description": "id of the runner" } ] }, "docs": "Update a repo-level runner" }, { "info": { "name": "Delete a repo-level runner", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/actions/runners/:runner_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "runner_id", "value": "", "type": "path", "description": "id of the runner" } ] }, "docs": "Delete a repo-level runner" }, { "info": { "name": "Lists all runs for a repository run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/actions/runs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "event", "value": "", "type": "query", "description": "workflow event name" }, { "name": "branch", "value": "", "type": "query", "description": "workflow branch" }, { "name": "status", "value": "", "type": "query", "description": "workflow status (pending, queued, in_progress, failure, success, skipped)" }, { "name": "actor", "value": "", "type": "query", "description": "triggered by user" }, { "name": "head_sha", "value": "", "type": "query", "description": "triggering sha of the workflow run" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "Lists all runs for a repository run" }, { "info": { "name": "Gets a specific workflow run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/actions/runs/:run", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "run", "value": "", "type": "path", "description": "id of the run" } ] }, "docs": "Gets a specific workflow run" }, { "info": { "name": "Delete a workflow run", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/actions/runs/:run", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "run", "value": "", "type": "path", "description": "runid of the workflow run" } ] }, "docs": "Delete a workflow run" }, { "info": { "name": "Lists all artifacts for a repository run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/actions/runs/:run/artifacts", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "run", "value": "", "type": "path", "description": "runid of the workflow run" }, { "name": "name", "value": "", "type": "query", "description": "name of the artifact" } ] }, "docs": "Lists all artifacts for a repository run" }, { "info": { "name": "Lists all jobs for a workflow run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/actions/runs/:run/jobs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "run", "value": "", "type": "path", "description": "runid of the workflow run" }, { "name": "status", "value": "", "type": "query", "description": "workflow status (pending, queued, in_progress, failure, success, skipped)" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "Lists all jobs for a workflow run" }, { "info": { "name": "Reruns a specific workflow job in a run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/actions/runs/:run/jobs/:job_id/rerun", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "run", "value": "", "type": "path", "description": "id of the run" }, { "name": "job_id", "value": "", "type": "path", "description": "id of the job" } ] }, "docs": "Reruns a specific workflow job in a run" }, { "info": { "name": "Reruns an entire workflow run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/actions/runs/:run/rerun", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "run", "value": "", "type": "path", "description": "id of the run" } ] }, "docs": "Reruns an entire workflow run" }, { "info": { "name": "Reruns all failed jobs in a workflow run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/actions/runs/:run/rerun-failed-jobs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "run", "value": "", "type": "path", "description": "id of the run" } ] }, "docs": "Reruns all failed jobs in a workflow run" }, { "info": { "name": "List an repo's actions secrets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/actions/secrets", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "List an repo's actions secrets" }, { "info": { "name": "Create or Update a secret value in a repository", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/repos/:owner/:repo/actions/secrets/:secretname", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repository" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "secretname", "value": "", "type": "path", "description": "name of the secret" } ] }, "docs": "Create or Update a secret value in a repository" }, { "info": { "name": "Delete a secret in a repository", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/actions/secrets/:secretname", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repository" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "secretname", "value": "", "type": "path", "description": "name of the secret" } ] }, "docs": "Delete a secret in a repository" }, { "info": { "name": "List a repository's action tasks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/actions/tasks", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results, default maximum page size is 50" } ] }, "docs": "List a repository's action tasks" }, { "info": { "name": "Get repo-level variables list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/actions/variables", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "Get repo-level variables list" }, { "info": { "name": "Get a repo-level variable", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/actions/variables/:variablename", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "variablename", "value": "", "type": "path", "description": "name of the variable" } ] }, "docs": "Get a repo-level variable" }, { "info": { "name": "Create a repo-level variable", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/actions/variables/:variablename", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "variablename", "value": "", "type": "path", "description": "name of the variable" } ] }, "docs": "Create a repo-level variable" }, { "info": { "name": "Update a repo-level variable", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/repos/:owner/:repo/actions/variables/:variablename", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "variablename", "value": "", "type": "path", "description": "name of the variable" } ] }, "docs": "Update a repo-level variable" }, { "info": { "name": "Delete a repo-level variable", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/actions/variables/:variablename", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repository" }, { "name": "variablename", "value": "", "type": "path", "description": "name of the variable" } ] }, "docs": "Delete a repo-level variable" }, { "info": { "name": "List repository workflows", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/actions/workflows", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "List repository workflows" }, { "info": { "name": "Get a workflow", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/actions/workflows/:workflow_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "workflow_id", "value": "", "type": "path", "description": "id of the workflow" } ] }, "docs": "Get a workflow" }, { "info": { "name": "Disable a workflow", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/repos/:owner/:repo/actions/workflows/:workflow_id/disable", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "workflow_id", "value": "", "type": "path", "description": "id of the workflow" } ] }, "docs": "Disable a workflow" }, { "info": { "name": "Create a workflow dispatch event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/actions/workflows/:workflow_id/dispatches", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "workflow_id", "value": "", "type": "path", "description": "id of the workflow" }, { "name": "return_run_details", "value": "", "type": "query", "description": "Whether the response should include the workflow run ID and URLs." } ] }, "docs": "Create a workflow dispatch event" }, { "info": { "name": "Enable a workflow", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/repos/:owner/:repo/actions/workflows/:workflow_id/enable", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "workflow_id", "value": "", "type": "path", "description": "id of the workflow" } ] }, "docs": "Enable a workflow" }, { "info": { "name": "List a repository's activity feeds", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/activities/feeds", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "date", "value": "", "type": "query", "description": "the date of the activities to be found" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "List a repository's activity feeds" }, { "info": { "name": "Get an archive of a repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/archive/:archive", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "archive", "value": "", "type": "path", "description": "the git reference for download with attached archive format (e.g. master.zip)" }, { "name": "path", "value": "", "type": "query", "description": "subpath of the repository to download" } ] }, "docs": "Get an archive of a repository" }, { "info": { "name": "Return all users that have write access and can be assigned to issues", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/assignees", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Return all users that have write access and can be assigned to issues" }, { "info": { "name": "Update avatar", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/avatar", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Update avatar" }, { "info": { "name": "Delete avatar", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/avatar", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Delete avatar" }, { "info": { "name": "List branch protections for a repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/branch_protections", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "List branch protections for a repository" }, { "info": { "name": "Create a branch protections for a repository", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/branch_protections", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Create a branch protections for a repository" }, { "info": { "name": "Update the priorities of branch protections for a repository.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/branch_protections/priority", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Update the priorities of branch protections for a repository." }, { "info": { "name": "Get a specific branch protection for the repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/branch_protections/:name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "name", "value": "", "type": "path", "description": "name of protected branch" } ] }, "docs": "Get a specific branch protection for the repository" }, { "info": { "name": "Edit a branch protections for a repository. Only fields that are set will be changed", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/repos/:owner/:repo/branch_protections/:name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "name", "value": "", "type": "path", "description": "name of protected branch" } ] }, "docs": "Edit a branch protections for a repository. Only fields that are set will be changed" }, { "info": { "name": "Delete a specific branch protection for the repository", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/branch_protections/:name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "name", "value": "", "type": "path", "description": "name of protected branch" } ] }, "docs": "Delete a specific branch protection for the repository" }, { "info": { "name": "List a repository's branches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/branches", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "List a repository's branches" }, { "info": { "name": "Create a branch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/branches", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Create a branch" }, { "info": { "name": "Retrieve a specific branch from a repository, including its effective branch protection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/branches/:branch", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "branch", "value": "", "type": "path", "description": "branch to get" } ] }, "docs": "Retrieve a specific branch from a repository, including its effective branch protection" }, { "info": { "name": "Update a branch reference to a new commit", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/repos/:owner/:repo/branches/:branch", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "branch", "value": "", "type": "path", "description": "name of the branch" } ] }, "docs": "Update a branch reference to a new commit" }, { "info": { "name": "Rename a branch", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/repos/:owner/:repo/branches/:branch", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "branch", "value": "", "type": "path", "description": "name of the branch" } ] }, "docs": "Rename a branch" }, { "info": { "name": "Delete a specific branch from a repository", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/branches/:branch", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "branch", "value": "", "type": "path", "description": "branch to delete" } ] }, "docs": "Delete a specific branch from a repository" }, { "info": { "name": "List a repository's collaborators", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/collaborators", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "List a repository's collaborators" }, { "info": { "name": "Check if a user is a collaborator of a repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/collaborators/:collaborator", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "collaborator", "value": "", "type": "path", "description": "username of the user to check for being a collaborator" } ] }, "docs": "Check if a user is a collaborator of a repository" }, { "info": { "name": "Add or Update a collaborator to a repository", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/repos/:owner/:repo/collaborators/:collaborator", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "collaborator", "value": "", "type": "path", "description": "username of the user to add or update as a collaborator" } ] }, "docs": "Add or Update a collaborator to a repository" }, { "info": { "name": "Delete a collaborator from a repository", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/collaborators/:collaborator", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "collaborator", "value": "", "type": "path", "description": "username of the collaborator to delete" } ] }, "docs": "Delete a collaborator from a repository" }, { "info": { "name": "Get repository permissions for a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/collaborators/:collaborator/permission", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "collaborator", "value": "", "type": "path", "description": "username of the collaborator whose permissions are to be obtained" } ] }, "docs": "Get repository permissions for a user" }, { "info": { "name": "Get a list of all commits from a repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/commits", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "sha", "value": "", "type": "query", "description": "SHA or branch to start listing commits from (usually 'master')" }, { "name": "path", "value": "", "type": "query", "description": "filepath of a file/dir" }, { "name": "since", "value": "", "type": "query", "description": "Only commits after this date will be returned (ISO 8601 format)" }, { "name": "until", "value": "", "type": "query", "description": "Only commits before this date will be returned (ISO 8601 format)" }, { "name": "stat", "value": "", "type": "query", "description": "include diff stats for every commit (disable for speedup, default 'true')" }, { "name": "verification", "value": "", "type": "query", "description": "include verification for every commit (disable for speedup, default 'true')" }, { "name": "files", "value": "", "type": "query", "description": "include a list of affected files for every commit (disable for speedup, default 'true')" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results (ignored if used with 'path')" }, { "name": "not", "value": "", "type": "query", "description": "commits that match the given specifier will not be listed." } ] }, "docs": "Get a list of all commits from a repository" }, { "info": { "name": "Get a commit's combined status, by branch/tag/commit reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/commits/:ref/status", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "ref", "value": "", "type": "path", "description": "name of branch/tag/commit" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "Get a commit's combined status, by branch/tag/commit reference" }, { "info": { "name": "Get a commit's statuses, by branch/tag/commit reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/commits/:ref/statuses", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "ref", "value": "", "type": "path", "description": "name of branch/tag/commit" }, { "name": "sort", "value": "", "type": "query", "description": "type of sort" }, { "name": "state", "value": "", "type": "query", "description": "type of state" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "Get a commit's statuses, by branch/tag/commit reference" }, { "info": { "name": "Get the merged pull request of the commit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/commits/:sha/pull", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "sha", "value": "", "type": "path", "description": "SHA of the commit to get" } ] }, "docs": "Get the merged pull request of the commit" }, { "info": { "name": "Get commit comparison information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/compare/:basehead", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "basehead", "value": "", "type": "path", "description": "compare two branches or commits" } ] }, "docs": "Get commit comparison information" }, { "info": { "name": "Gets the metadata of all the entries of the root dir.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/contents", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "ref", "value": "", "type": "query", "description": "The name of the commit/branch/tag. Default to the repository’s default branch." } ] }, "docs": "This API follows GitHub's design, and it is not easy to use. Recommend users to use our \"contents-ext\" API instead." }, { "info": { "name": "Modify multiple files in a repository", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/contents", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Modify multiple files in a repository" }, { "info": { "name": "The extended \"contents\" API, to get file metadata and/or content, or list a directory.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/contents-ext/:filepath", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "filepath", "value": "", "type": "path", "description": "path of the dir, file, symlink or submodule in the repo. Swagger requires path parameter to be \"required\", you can leave it empty or pass a single dot (\".\") to get the root directory." }, { "name": "ref", "value": "", "type": "query", "description": "the name of the commit/branch/tag, default to the repository’s default branch." }, { "name": "includes", "value": "", "type": "query", "description": "By default this API's response only contains file's metadata. Use comma-separated \"includes\" options to retrieve more fields. Option \"file_content\" will try to retrieve the file content, \"lfs_metadata\" will try to retrieve LFS metadata, \"commit_metadata\" will try to retrieve commit metadata, and \"commit_message\" will try to retrieve commit message." } ] }, "docs": "It guarantees that only one of the response fields is set if the request succeeds. Users can pass \"includes=file_content\" or \"includes=lfs_metadata\" to retrieve more fields. \"includes=file_content\" only works for single file, if you need to retrieve file contents in batch, use \"file-contents\" API after listing the directory." }, { "info": { "name": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/contents/:filepath", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "filepath", "value": "", "type": "path", "description": "path of the dir, file, symlink or submodule in the repo" }, { "name": "ref", "value": "", "type": "query", "description": "The name of the commit/branch/tag. Default to the repository’s default branch." } ] }, "docs": "This API follows GitHub's design, and it is not easy to use. Recommend users to use the \"contents-ext\" API instead." }, { "info": { "name": "Create a file in a repository", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/contents/:filepath", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "filepath", "value": "", "type": "path", "description": "path of the file to create" } ] }, "docs": "Create a file in a repository" }, { "info": { "name": "Update a file in a repository if SHA is set, or create the file if SHA is not set", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/repos/:owner/:repo/contents/:filepath", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "filepath", "value": "", "type": "path", "description": "path of the file to update" } ] }, "docs": "Update a file in a repository if SHA is set, or create the file if SHA is not set" }, { "info": { "name": "Delete a file in a repository", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/contents/:filepath", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "filepath", "value": "", "type": "path", "description": "path of the file to delete" } ] }, "docs": "Delete a file in a repository" }, { "info": { "name": "Apply diff patch to repository", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/diffpatch", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Apply diff patch to repository" }, { "info": { "name": "Get the EditorConfig definitions of a file in a repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/editorconfig/:filepath", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "filepath", "value": "", "type": "path", "description": "filepath of file to get" }, { "name": "ref", "value": "", "type": "query", "description": "The name of the commit/branch/tag. Default to the repository’s default branch." } ] }, "docs": "Get the EditorConfig definitions of a file in a repository" }, { "info": { "name": "Get the metadata and contents of requested files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/file-contents", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "ref", "value": "", "type": "query", "description": "The name of the commit/branch/tag. Default to the repository’s default branch." }, { "name": "body", "value": "", "type": "query", "description": "The JSON encoded body (see the POST request): {\"files\": [\"filename1\", \"filename2\"]}" } ] }, "docs": "See the POST method. This GET method supports using JSON encoded request body in query parameter." }, { "info": { "name": "Get the metadata and contents of requested files", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/file-contents", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "ref", "value": "", "type": "query", "description": "The name of the commit/branch/tag. Default to the repository’s default branch." } ] }, "docs": "Uses automatic pagination based on default page size and max response size and returns the maximum allowed number of files. Files which could not be retrieved are null. Files which are too large are being returned with `encoding == null`, `content == null` and `size > 0`, they can be requested separately by using the `download_url`." }, { "info": { "name": "List a repository's forks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/forks", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "List a repository's forks" }, { "info": { "name": "Fork a repository", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/forks", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo to fork" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo to fork" } ] }, "docs": "Fork a repository" }, { "info": { "name": "Gets the blob of a repository.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/git/blobs/:sha", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "sha", "value": "", "type": "path", "description": "sha of the commit" } ] }, "docs": "Gets the blob of a repository." }, { "info": { "name": "Get a single commit from a repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/git/commits/:sha", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "sha", "value": "", "type": "path", "description": "a git ref or commit sha" }, { "name": "stat", "value": "", "type": "query", "description": "include diff stats for every commit (disable for speedup, default 'true')" }, { "name": "verification", "value": "", "type": "query", "description": "include verification for every commit (disable for speedup, default 'true')" }, { "name": "files", "value": "", "type": "query", "description": "include a list of affected files for every commit (disable for speedup, default 'true')" } ] }, "docs": "Get a single commit from a repository" }, { "info": { "name": "Get a commit's diff or patch", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/git/commits/:sha.:diffType", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "sha", "value": "", "type": "path", "description": "SHA of the commit to get" }, { "name": "diffType", "value": "", "type": "path", "description": "whether the output is diff or patch" } ] }, "docs": "Get a commit's diff or patch" }, { "info": { "name": "Get a note corresponding to a single commit from a repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/git/notes/:sha", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "sha", "value": "", "type": "path", "description": "a git ref or commit sha" }, { "name": "verification", "value": "", "type": "query", "description": "include verification for every commit (disable for speedup, default 'true')" }, { "name": "files", "value": "", "type": "query", "description": "include a list of affected files for every commit (disable for speedup, default 'true')" } ] }, "docs": "Get a note corresponding to a single commit from a repository" }, { "info": { "name": "Get specified ref or filtered repository's refs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/git/refs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Get specified ref or filtered repository's refs" }, { "info": { "name": "Get specified ref or filtered repository's refs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/git/refs/:ref", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "ref", "value": "", "type": "path", "description": "part or full name of the ref" } ] }, "docs": "Get specified ref or filtered repository's refs" }, { "info": { "name": "Gets the tag object of an annotated tag (not lightweight tags)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/git/tags/:sha", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "sha", "value": "", "type": "path", "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags." } ] }, "docs": "Gets the tag object of an annotated tag (not lightweight tags)" }, { "info": { "name": "Gets the tree of a repository.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/git/trees/:sha", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "sha", "value": "", "type": "path", "description": "sha of the commit" }, { "name": "recursive", "value": "", "type": "query", "description": "show all directories and files" }, { "name": "page", "value": "", "type": "query", "description": "page number; the 'truncated' field in the response will be true if there are still more items after this page, false if the last page" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items per page" } ] }, "docs": "Gets the tree of a repository." }, { "info": { "name": "List the hooks in a repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/hooks", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "List the hooks in a repository" }, { "info": { "name": "Create a hook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/hooks", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Create a hook" }, { "info": { "name": "List the Git hooks in a repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/hooks/git", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "List the Git hooks in a repository" }, { "info": { "name": "Get a Git hook", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/hooks/git/:id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of the hook to get" } ] }, "docs": "Get a Git hook" }, { "info": { "name": "Edit a Git hook in a repository", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/repos/:owner/:repo/hooks/git/:id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of the hook to get" } ] }, "docs": "Edit a Git hook in a repository" }, { "info": { "name": "Delete a Git hook in a repository", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/hooks/git/:id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of the hook to get" } ] }, "docs": "Delete a Git hook in a repository" }, { "info": { "name": "Get a hook", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/hooks/:id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of the hook to get" } ] }, "docs": "Get a hook" }, { "info": { "name": "Edit a hook in a repository", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/repos/:owner/:repo/hooks/:id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "index of the hook" } ] }, "docs": "Edit a hook in a repository" }, { "info": { "name": "Delete a hook in a repository", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/hooks/:id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of the hook to delete" } ] }, "docs": "Delete a hook in a repository" }, { "info": { "name": "Test a push webhook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/hooks/:id/tests", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of the hook to test" }, { "name": "ref", "value": "", "type": "query", "description": "The name of the commit/branch/tag, indicates which commit will be loaded to the webhook payload." } ] }, "docs": "Test a push webhook" }, { "info": { "name": "Returns the issue config for a repo", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/issue_config", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Returns the issue config for a repo" }, { "info": { "name": "Returns the validation information for a issue config", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/issue_config/validate", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Returns the validation information for a issue config" }, { "info": { "name": "Get available issue templates for a repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/issue_templates", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Get available issue templates for a repository" }, { "info": { "name": "List a repo's pinned issues", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/issues/pinned", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "List a repo's pinned issues" }, { "info": { "name": "List a repository's keys", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/keys", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "key_id", "value": "", "type": "query", "description": "the key_id to search for" }, { "name": "fingerprint", "value": "", "type": "query", "description": "fingerprint of the key" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "List a repository's keys" }, { "info": { "name": "Add a key to a repository", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/keys", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Add a key to a repository" }, { "info": { "name": "Get a repository's key by id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/keys/:id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of the key to get" } ] }, "docs": "Get a repository's key by id" }, { "info": { "name": "Delete a key from a repository", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/keys/:id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of the key to delete" } ] }, "docs": "Delete a key from a repository" }, { "info": { "name": "Get languages and number of bytes of code written", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/languages", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Get languages and number of bytes of code written" }, { "info": { "name": "Get repo licenses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/licenses", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Get repo licenses" }, { "info": { "name": "Get a file or it's LFS object from a repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/media/:filepath", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "filepath", "value": "", "type": "path", "description": "path of the file to get, it should be \"{ref}/{filepath}\". If there is no ref could be inferred, it will be treated as the default branch" }, { "name": "ref", "value": "", "type": "query", "description": "The name of the commit/branch/tag. Default to the repository’s default branch" } ] }, "docs": "Get a file or it's LFS object from a repository" }, { "info": { "name": "Merge a branch from upstream", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/merge-upstream", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Merge a branch from upstream" }, { "info": { "name": "Sync a mirrored repository", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/mirror-sync", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo to sync" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo to sync" } ] }, "docs": "Sync a mirrored repository" }, { "info": { "name": "Returns if new Issue Pins are allowed", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/new_pin_allowed", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Returns if new Issue Pins are allowed" }, { "info": { "name": "List a repo's pull requests", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/pulls", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "Name of the repo" }, { "name": "base_branch", "value": "", "type": "query", "description": "Filter by target base branch of the pull request" }, { "name": "state", "value": "", "type": "query", "description": "State of pull request" }, { "name": "sort", "value": "", "type": "query", "description": "Type of sort" }, { "name": "milestone", "value": "", "type": "query", "description": "ID of the milestone" }, { "name": "labels", "value": "", "type": "query", "description": "Label IDs" }, { "name": "poster", "value": "", "type": "query", "description": "Filter by pull request author" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "Page size of results" } ] }, "docs": "List a repo's pull requests" }, { "info": { "name": "Create a pull request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/pulls", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Create a pull request" }, { "info": { "name": "Resolve a pull request review comment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/comments/:id/resolve", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of the review comment" } ] }, "docs": "Resolve a pull request review comment" }, { "info": { "name": "Unresolve a pull request review comment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/comments/:id/unresolve", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of the review comment" } ] }, "docs": "Unresolve a pull request review comment" }, { "info": { "name": "List a repo's pinned pull requests", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/pinned", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "List a repo's pinned pull requests" }, { "info": { "name": "Get a pull request by base and head", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/:base/:head", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "base", "value": "", "type": "path", "description": "base of the pull request to get" }, { "name": "head", "value": "", "type": "path", "description": "head of the pull request to get" } ] }, "docs": "Get a pull request by base and head" }, { "info": { "name": "Get a pull request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/:index", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "index", "value": "", "type": "path", "description": "index of the pull request to get" } ] }, "docs": "Get a pull request" }, { "info": { "name": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/:index", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "index", "value": "", "type": "path", "description": "index of the pull request to edit" } ] }, "docs": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored." }, { "info": { "name": "Get a pull request diff or patch", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/:index.:diffType", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "index", "value": "", "type": "path", "description": "index of the pull request to get" }, { "name": "diffType", "value": "", "type": "path", "description": "whether the output is diff or patch" }, { "name": "binary", "value": "", "type": "query", "description": "whether to include binary file changes. if true, the diff is applicable with `git apply`" } ] }, "docs": "Get a pull request diff or patch" }, { "info": { "name": "Get commits for a pull request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/:index/commits", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "index", "value": "", "type": "path", "description": "index of the pull request to get" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" }, { "name": "verification", "value": "", "type": "query", "description": "include verification for every commit (disable for speedup, default 'true')" }, { "name": "files", "value": "", "type": "query", "description": "include a list of affected files for every commit (disable for speedup, default 'true')" } ] }, "docs": "Get commits for a pull request" }, { "info": { "name": "Get changed files for a pull request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/:index/files", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "index", "value": "", "type": "path", "description": "index of the pull request to get" }, { "name": "skip-to", "value": "", "type": "query", "description": "skip to given file" }, { "name": "whitespace", "value": "", "type": "query", "description": "whitespace behavior" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "Get changed files for a pull request" }, { "info": { "name": "Check if a pull request has been merged", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/:index/merge", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "index", "value": "", "type": "path", "description": "index of the pull request" } ] }, "docs": "Check if a pull request has been merged" }, { "info": { "name": "Merge a pull request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/:index/merge", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "index", "value": "", "type": "path", "description": "index of the pull request to merge" } ] }, "docs": "Merge a pull request" }, { "info": { "name": "Cancel the scheduled auto merge for the given pull request", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/:index/merge", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "index", "value": "", "type": "path", "description": "index of the pull request to merge" } ] }, "docs": "Cancel the scheduled auto merge for the given pull request" }, { "info": { "name": "create review requests for a pull request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/:index/requested_reviewers", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "index", "value": "", "type": "path", "description": "index of the pull request" } ] }, "docs": "create review requests for a pull request" }, { "info": { "name": "cancel review requests for a pull request", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/:index/requested_reviewers", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "index", "value": "", "type": "path", "description": "index of the pull request" } ] }, "docs": "cancel review requests for a pull request" }, { "info": { "name": "List all reviews for a pull request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/:index/reviews", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "index", "value": "", "type": "path", "description": "index of the pull request" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "List all reviews for a pull request" }, { "info": { "name": "Create a review to a pull request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/:index/reviews", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "index", "value": "", "type": "path", "description": "index of the pull request" } ] }, "docs": "Create a review to a pull request" }, { "info": { "name": "Get a specific review for a pull request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/:index/reviews/:id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "index", "value": "", "type": "path", "description": "index of the pull request" }, { "name": "id", "value": "", "type": "path", "description": "id of the review" } ] }, "docs": "Get a specific review for a pull request" }, { "info": { "name": "Submit a pending review to a pull request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/:index/reviews/:id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "index", "value": "", "type": "path", "description": "index of the pull request" }, { "name": "id", "value": "", "type": "path", "description": "id of the review" } ] }, "docs": "Submit a pending review to a pull request" }, { "info": { "name": "Delete a specific review from a pull request", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/:index/reviews/:id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "index", "value": "", "type": "path", "description": "index of the pull request" }, { "name": "id", "value": "", "type": "path", "description": "id of the review" } ] }, "docs": "Delete a specific review from a pull request" }, { "info": { "name": "Get a specific review for a pull request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/:index/reviews/:id/comments", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "index", "value": "", "type": "path", "description": "index of the pull request" }, { "name": "id", "value": "", "type": "path", "description": "id of the review" } ] }, "docs": "Get a specific review for a pull request" }, { "info": { "name": "Dismiss a review for a pull request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/:index/reviews/:id/dismissals", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "index", "value": "", "type": "path", "description": "index of the pull request" }, { "name": "id", "value": "", "type": "path", "description": "id of the review" } ] }, "docs": "Dismiss a review for a pull request" }, { "info": { "name": "Cancel to dismiss a review for a pull request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/:index/reviews/:id/undismissals", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "index", "value": "", "type": "path", "description": "index of the pull request" }, { "name": "id", "value": "", "type": "path", "description": "id of the review" } ] }, "docs": "Cancel to dismiss a review for a pull request" }, { "info": { "name": "Merge PR's baseBranch into headBranch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/pulls/:index/update", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "index", "value": "", "type": "path", "description": "index of the pull request to get" }, { "name": "style", "value": "", "type": "query", "description": "how to update pull request" } ] }, "docs": "Merge PR's baseBranch into headBranch" }, { "info": { "name": "Get all push mirrors of the repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/push_mirrors", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "Get all push mirrors of the repository" }, { "info": { "name": "add a push mirror to the repository", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/push_mirrors", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "add a push mirror to the repository" }, { "info": { "name": "Sync all push mirrored repository", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/push_mirrors-sync", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo to sync" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo to sync" } ] }, "docs": "Sync all push mirrored repository" }, { "info": { "name": "Get push mirror of the repository by remoteName", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/push_mirrors/:name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "name", "value": "", "type": "path", "description": "remote name of push mirror" } ] }, "docs": "Get push mirror of the repository by remoteName" }, { "info": { "name": "deletes a push mirror from a repository by remoteName", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/push_mirrors/:name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "name", "value": "", "type": "path", "description": "remote name of the pushMirror" } ] }, "docs": "deletes a push mirror from a repository by remoteName" }, { "info": { "name": "Get a file from a repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/raw/:filepath", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "filepath", "value": "", "type": "path", "description": "path of the file to get, it should be \"{ref}/{filepath}\". If there is no ref could be inferred, it will be treated as the default branch" }, { "name": "ref", "value": "", "type": "query", "description": "The name of the commit/branch/tag. Default to the repository’s default branch" } ] }, "docs": "Get a file from a repository" }, { "info": { "name": "List a repo's releases", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/releases", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "draft", "value": "", "type": "query", "description": "filter (exclude / include) drafts, if you don't have repo write access none will show" }, { "name": "pre-release", "value": "", "type": "query", "description": "filter (exclude / include) pre-releases" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "List a repo's releases" }, { "info": { "name": "Create a release", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/releases", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Create a release" }, { "info": { "name": "Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/releases/latest", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at" }, { "info": { "name": "Get a release by tag name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/releases/tags/:tag", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "tag", "value": "", "type": "path", "description": "tag name of the release to get" } ] }, "docs": "Get a release by tag name" }, { "info": { "name": "Delete a release by tag name", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/releases/tags/:tag", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "tag", "value": "", "type": "path", "description": "tag name of the release to delete" } ] }, "docs": "Delete a release by tag name" }, { "info": { "name": "Get a release", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/releases/:id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of the release to get" } ] }, "docs": "Get a release" }, { "info": { "name": "Update a release", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/repos/:owner/:repo/releases/:id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of the release to edit" } ] }, "docs": "Update a release" }, { "info": { "name": "Delete a release", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/releases/:id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of the release to delete" } ] }, "docs": "Delete a release" }, { "info": { "name": "List release's attachments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/releases/:id/assets", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of the release" } ] }, "docs": "List release's attachments" }, { "info": { "name": "Create a release attachment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/releases/:id/assets", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of the release" }, { "name": "name", "value": "", "type": "query", "description": "name of the attachment" } ] }, "docs": "Create a release attachment" }, { "info": { "name": "Get a release attachment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/releases/:id/assets/:attachment_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of the release" }, { "name": "attachment_id", "value": "", "type": "path", "description": "id of the attachment to get" } ] }, "docs": "Get a release attachment" }, { "info": { "name": "Edit a release attachment", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/repos/:owner/:repo/releases/:id/assets/:attachment_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of the release" }, { "name": "attachment_id", "value": "", "type": "path", "description": "id of the attachment to edit" } ] }, "docs": "Edit a release attachment" }, { "info": { "name": "Delete a release attachment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/releases/:id/assets/:attachment_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of the release" }, { "name": "attachment_id", "value": "", "type": "path", "description": "id of the attachment to delete" } ] }, "docs": "Delete a release attachment" }, { "info": { "name": "Return all users that can be requested to review in this repo", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/reviewers", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Return all users that can be requested to review in this repo" }, { "info": { "name": "Get signing-key.gpg for given repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/signing-key.gpg", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Get signing-key.gpg for given repository" }, { "info": { "name": "Get signing-key.pub for given repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/signing-key.pub", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Get signing-key.pub for given repository" }, { "info": { "name": "List a repo's stargazers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/stargazers", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "List a repo's stargazers" }, { "info": { "name": "Get a commit's statuses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/statuses/:sha", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "sha", "value": "", "type": "path", "description": "sha of the commit" }, { "name": "sort", "value": "", "type": "query", "description": "type of sort" }, { "name": "state", "value": "", "type": "query", "description": "type of state" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "Get a commit's statuses" }, { "info": { "name": "Create a commit status", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/statuses/:sha", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "sha", "value": "", "type": "path", "description": "sha of the commit" } ] }, "docs": "Create a commit status" }, { "info": { "name": "List a repo's watchers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/subscribers", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "List a repo's watchers" }, { "info": { "name": "Check if the current user is watching a repo", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/subscription", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Check if the current user is watching a repo" }, { "info": { "name": "Watch a repo", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/repos/:owner/:repo/subscription", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Watch a repo" }, { "info": { "name": "Unwatch a repo", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/subscription", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Unwatch a repo" }, { "info": { "name": "List tag protections for a repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/tag_protections", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "List tag protections for a repository" }, { "info": { "name": "Create a tag protections for a repository", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/tag_protections", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Create a tag protections for a repository" }, { "info": { "name": "Get a specific tag protection for the repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/tag_protections/:id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of the tag protect to get" } ] }, "docs": "Get a specific tag protection for the repository" }, { "info": { "name": "Edit a tag protections for a repository. Only fields that are set will be changed", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/repos/:owner/:repo/tag_protections/:id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of protected tag" } ] }, "docs": "Edit a tag protections for a repository. Only fields that are set will be changed" }, { "info": { "name": "Delete a specific tag protection for the repository", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/tag_protections/:id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "id", "value": "", "type": "path", "description": "id of protected tag" } ] }, "docs": "Delete a specific tag protection for the repository" }, { "info": { "name": "List a repository's tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/tags", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results, default maximum page size is 50" } ] }, "docs": "List a repository's tags" }, { "info": { "name": "Create a new git tag in a repository", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/tags", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Create a new git tag in a repository" }, { "info": { "name": "Get the tag of a repository by tag name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/tags/:tag", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "tag", "value": "", "type": "path", "description": "name of tag" } ] }, "docs": "Get the tag of a repository by tag name" }, { "info": { "name": "Delete a repository's tag by name", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/tags/:tag", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "tag", "value": "", "type": "path", "description": "name of tag to delete" } ] }, "docs": "Delete a repository's tag by name" }, { "info": { "name": "List a repository's teams", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/teams", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "List a repository's teams" }, { "info": { "name": "Check if a team is assigned to a repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/teams/:team", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "team", "value": "", "type": "path", "description": "team name" } ] }, "docs": "Check if a team is assigned to a repository" }, { "info": { "name": "Add a team to a repository", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/repos/:owner/:repo/teams/:team", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "team", "value": "", "type": "path", "description": "team name" } ] }, "docs": "Add a team to a repository" }, { "info": { "name": "Delete a team from a repository", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/teams/:team", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "team", "value": "", "type": "path", "description": "team name" } ] }, "docs": "Delete a team from a repository" }, { "info": { "name": "List a repo's tracked times", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/times", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "user", "value": "", "type": "query", "description": "optional filter by user (available for issue managers)" }, { "name": "since", "value": "", "type": "query", "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format" }, { "name": "before", "value": "", "type": "query", "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "List a repo's tracked times" }, { "info": { "name": "List a user's tracked times in a repo", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/times/:user", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "user", "value": "", "type": "path", "description": "username of the user whose tracked times are to be listed" } ] }, "docs": "List a user's tracked times in a repo" }, { "info": { "name": "Get list of topics that a repository has", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/topics", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "Get list of topics that a repository has" }, { "info": { "name": "Replace list of topics for a repository", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/repos/:owner/:repo/topics", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Replace list of topics for a repository" }, { "info": { "name": "Add a topic to a repository", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/repos/:owner/:repo/topics/:topic", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "topic", "value": "", "type": "path", "description": "name of the topic to add" } ] }, "docs": "Add a topic to a repository" }, { "info": { "name": "Delete a topic from a repository", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/topics/:topic", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "topic", "value": "", "type": "path", "description": "name of the topic to delete" } ] }, "docs": "Delete a topic from a repository" }, { "info": { "name": "Transfer a repo ownership", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/transfer", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo to transfer" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo to transfer" } ] }, "docs": "Transfer a repo ownership" }, { "info": { "name": "Accept a repo transfer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/transfer/accept", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo to transfer" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo to transfer" } ] }, "docs": "Accept a repo transfer" }, { "info": { "name": "Reject a repo transfer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/transfer/reject", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo to transfer" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo to transfer" } ] }, "docs": "Reject a repo transfer" }, { "info": { "name": "Create a wiki page", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:owner/:repo/wiki/new", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" } ] }, "docs": "Create a wiki page" }, { "info": { "name": "Get a wiki page", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/wiki/page/:pageName", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "pageName", "value": "", "type": "path", "description": "name of the page" } ] }, "docs": "Get a wiki page" }, { "info": { "name": "Edit a wiki page", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/repos/:owner/:repo/wiki/page/:pageName", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "pageName", "value": "", "type": "path", "description": "name of the page" } ] }, "docs": "Edit a wiki page" }, { "info": { "name": "Delete a wiki page", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/repos/:owner/:repo/wiki/page/:pageName", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "pageName", "value": "", "type": "path", "description": "name of the page" } ] }, "docs": "Delete a wiki page" }, { "info": { "name": "Get all wiki pages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/wiki/pages", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "Get all wiki pages" }, { "info": { "name": "Get revisions of a wiki page", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repos/:owner/:repo/wiki/revisions/:pageName", "params": [ { "name": "owner", "value": "", "type": "path", "description": "owner of the repo" }, { "name": "repo", "value": "", "type": "path", "description": "name of the repo" }, { "name": "pageName", "value": "", "type": "path", "description": "name of the page" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" } ] }, "docs": "Get revisions of a wiki page" }, { "info": { "name": "Create a repository using a template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repos/:template_owner/:template_repo/generate", "params": [ { "name": "template_owner", "value": "", "type": "path", "description": "owner of the template repository" }, { "name": "template_repo", "value": "", "type": "path", "description": "name of the template repository" } ] }, "docs": "Create a repository using a template" }, { "info": { "name": "Get a repository by id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repositories/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the repo to get" } ] }, "docs": "Get a repository by id" }, { "info": { "name": "search topics via keyword", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/topics/search", "params": [ { "name": "q", "value": "", "type": "query", "description": "keywords to search" }, { "name": "page", "value": "", "type": "query", "description": "page number of results to return (1-based)" }, { "name": "limit", "value": "", "type": "query", "description": "page size of results" } ] }, "docs": "search topics via keyword" }, { "info": { "name": "Create a repository", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/user/repos" }, "docs": "Create a repository" } ] } ], "bundled": true }