Skip to content

Commit

Permalink
build: update endpoints.json for octokit/routse v26.18.0
Browse files Browse the repository at this point in the history
  • Loading branch information
gr2m committed Jan 24, 2020
1 parent 79153ba commit 992de8f
Showing 1 changed file with 58 additions and 15 deletions.
73 changes: 58 additions & 15 deletions scripts/update-endpoints/generated/endpoints.json
Expand Up @@ -497,7 +497,7 @@
},
{
"name": "Revoke a grant for an application",
"scope": "apps",
"scope": "oauthAuthorizations",
"id": "revokeGrantForApplication",
"method": "DELETE",
"url": "/applications/{client_id}/grants/{access_token}",
Expand Down Expand Up @@ -765,7 +765,7 @@
},
{
"name": "Check an authorization",
"scope": "apps",
"scope": "oauthAuthorizations",
"id": "checkAuthorization",
"method": "GET",
"url": "/applications/{client_id}/tokens/{access_token}",
Expand Down Expand Up @@ -876,7 +876,7 @@
},
{
"name": "Reset an authorization",
"scope": "apps",
"scope": "oauthAuthorizations",
"id": "resetAuthorization",
"method": "POST",
"url": "/applications/{client_id}/tokens/{access_token}",
Expand Down Expand Up @@ -977,7 +977,7 @@
},
{
"name": "Revoke an authorization for an application",
"scope": "apps",
"scope": "oauthAuthorizations",
"id": "revokeAuthorizationForApplication",
"method": "DELETE",
"url": "/applications/{client_id}/tokens/{access_token}",
Expand Down Expand Up @@ -21111,13 +21111,8 @@
"isLegacy": false,
"description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://developer.github.com/v3/activity/events/types/#repositorydispatchevent).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. For a test example, see the [input example](https://developer.github.com/v3/repos/#example-4).\n\nTo give you write access to the repository, you must use a personal access token with the `repo` scope. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)\" in the GitHub Help documentation.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.",
"documentationUrl": "https://developer.github.com/v3/repos/#create-a-repository-dispatch-event",
"previews": [{ "name": "everest" }],
"headers": [
{
"name": "accept",
"value": "application/vnd.github.everest-preview+json"
}
],
"previews": [],
"headers": [],
"parameters": [
{
"name": "owner",
Expand Down Expand Up @@ -21545,7 +21540,7 @@
"url": "/repos/{owner}/{repo}/forks",
"isDeprecated": false,
"isLegacy": false,
"description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://github.com/contact).",
"description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com).",
"documentationUrl": "https://developer.github.com/v3/repos/forks/#create-a-fork",
"previews": [],
"headers": [],
Expand Down Expand Up @@ -23629,7 +23624,7 @@
"url": "/repos/{owner}/{repo}/import",
"isDeprecated": false,
"isLegacy": false,
"description": "View the progress of an import.\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://github.com/contact) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://developer.github.com/v3/migrations/source_imports/#cancel-an-import) and [retry](https://developer.github.com/v3/migrations/source_imports/#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.",
"description": "View the progress of an import.\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://developer.github.com/v3/migrations/source_imports/#cancel-an-import) and [retry](https://developer.github.com/v3/migrations/source_imports/#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.",
"documentationUrl": "https://developer.github.com/v3/migrations/source_imports/#get-import-progress",
"previews": [],
"headers": [],
Expand Down Expand Up @@ -39447,7 +39442,7 @@
"before": { "scope": "teams", "id": "getMember" },
"after": { "scope": "teams", "id": "getMemberLegacy" },
"date": "2020-01-16",
"note": "The path for \"Get team member\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes"
"note": "\"Get team member\" is now \"Get team member (Legacy)\""
}
},
{
Expand Down Expand Up @@ -39564,7 +39559,7 @@
"before": { "scope": "teams", "id": "addMember" },
"after": { "scope": "teams", "id": "addMemberLegacy" },
"date": "2020-01-16",
"note": "The path for \"Add team member\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes"
"note": "\"Add team member\" is now \"Add team member (Legacy)\""
}
},
{
Expand Down Expand Up @@ -39610,6 +39605,54 @@
"responses": [],
"renamed": null
},
{
"name": "Remove team member (Legacy)",
"scope": "teams",
"id": "removeMember",
"method": "DELETE",
"url": "/teams/{team_id}/members/{username}",
"isDeprecated": true,
"isLegacy": true,
"description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership](https://developer.github.com/v3/teams/members/#remove-team-membership) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"",
"documentationUrl": "https://developer.github.com/v3/teams/members/#remove-team-member-legacy",
"previews": [],
"headers": [],
"parameters": [
{
"name": "team_id",
"description": "team_id parameter",
"in": "PATH",
"type": "integer",
"required": true,
"enum": null,
"allowNull": false,
"mapToData": null,
"validation": null,
"alias": null,
"deprecated": null
},
{
"name": "username",
"description": "username parameter",
"in": "PATH",
"type": "string",
"required": true,
"enum": null,
"allowNull": false,
"mapToData": null,
"validation": null,
"alias": null,
"deprecated": null
}
],
"responses": [],
"renamed": {
"before": { "scope": "teams", "id": "removeMember" },
"after": { "scope": "teams", "id": "removeMemberLegacy" },
"date": "2020-01-16",
"note": "\"Remove team member\" is now \"Remove team member (Legacy)\""
}
},
{
"name": "Get team membership (Legacy)",
"scope": "teams",
Expand Down

0 comments on commit 992de8f

Please sign in to comment.