This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the API.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", + "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", "statusCodes": [ { "httpStatusCode": "201", @@ -210139,7 +210127,7 @@ } ], "previews": [], - "descriptionHTML": "Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", + "descriptionHTML": "Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", "statusCodes": [ { "httpStatusCode": "200", @@ -330274,7 +330262,7 @@ }, "response": { "statusCode": "200", - "contentType": "application/json", + "contentType": "text/plain", "description": "Example response
", "example": "Responsive is better than fast", "schema": { @@ -403083,7 +403071,7 @@ } ], "previews": [], - "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", + "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", "statusCodes": [ { "httpStatusCode": "200", @@ -424850,7 +424838,7 @@ "type": "string", "name": "event", "in": "body", - "description": "The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.
The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", + "descriptionHTML": "Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", "statusCodes": [ { "httpStatusCode": "200", @@ -428050,7 +428038,7 @@ } ], "previews": [], - "descriptionHTML": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"
", + "descriptionHTML": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -428489,7 +428477,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { @@ -428797,7 +428785,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
The reaction type to add to the team discussion comment.
", + "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", @@ -429405,7 +429393,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { @@ -429846,7 +429834,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
The reaction type to add to the team discussion.
", + "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", @@ -430443,7 +430431,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", "in": "query", "required": false, "schema": { @@ -430874,7 +430862,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a commit comment.
", + "descriptionHTML": "List the reactions to a commit comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -430927,7 +430915,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the commit comment.
", + "description": "The reaction type to add to the commit comment.
", "isRequired": true, "enum": [ "+1", @@ -431475,7 +431463,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -431603,7 +431591,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", "in": "query", "required": false, "schema": { @@ -431910,7 +431898,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to an issue comment.
", + "descriptionHTML": "List the reactions to an issue comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -431963,7 +431951,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the issue comment.
", + "description": "The reaction type to add to the issue comment.
", "isRequired": true, "enum": [ "+1", @@ -432511,7 +432499,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -432639,7 +432627,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", "in": "query", "required": false, "schema": { @@ -432946,7 +432934,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to an issue.
", + "descriptionHTML": "List the reactions to an issue.
", "statusCodes": [ { "httpStatusCode": "200", @@ -433003,7 +432991,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the issue.
", + "description": "The reaction type to add to the issue.
", "isRequired": true, "enum": [ "+1", @@ -433551,7 +433539,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", @@ -433679,7 +433667,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", "in": "query", "required": false, "schema": { @@ -433986,7 +433974,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a pull request review comment.
", + "descriptionHTML": "List the reactions to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -434039,7 +434027,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the pull request review comment.
", + "description": "The reaction type to add to the pull request review comment.
", "isRequired": true, "enum": [ "+1", @@ -434587,7 +434575,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -434715,7 +434703,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
", "in": "query", "required": false, "schema": { @@ -435020,7 +435008,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a release.
", + "descriptionHTML": "List the reactions to a release.
", "statusCodes": [ { "httpStatusCode": "200", @@ -435073,7 +435061,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the release.
", + "description": "The reaction type to add to the release.
", "isRequired": true, "enum": [ "+1", @@ -435619,7 +435607,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", "statusCodes": [ { "httpStatusCode": "204", @@ -435747,7 +435735,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { @@ -436054,7 +436042,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
The reaction type to add to the team discussion comment.
", + "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", @@ -436386,7 +436374,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { @@ -436728,7 +436716,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
The reaction type to add to the team discussion.
", + "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", @@ -437050,7 +437038,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
", + "descriptionHTML": "Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
", "statusCodes": [ { "httpStatusCode": "200", @@ -443235,7 +443223,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", + "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", @@ -473221,7 +473209,7 @@ } ], "previews": [], - "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", + "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", @@ -500851,2332 +500839,6 @@ } ], "repository-advisories": [ - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/security-advisories", - "title": "List repository security advisories for an organization", - "category": "security-advisories", - "subcategory": "repository-advisories", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "sort", - "description": "The property to sort the results by.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "published" - ], - "default": "created" - } - }, - { - "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "The number of advisories to return per page.
", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "state", - "description": "Filter by the state of the repository advisories. Only advisories of this state will be returned.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "triage", - "draft", - "published", - "closed" - ] - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "ghsa_id": "GHSA-abcd-1234-efgh", - "cve_id": "CVE-2050-00000", - "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh", - "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh", - "summary": "A short summary of the advisory.", - "description": "A detailed description of what the advisory entails.", - "severity": "critical", - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "publisher": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-abcd-1234-efgh" - }, - { - "type": "CVE", - "value": "CVE-2050-00000" - } - ], - "state": "published", - "created_at": "2020-01-01T00:00:00Z", - "updated_at": "2020-01-02T00:00:00Z", - "published_at": "2020-01-03T00:00:00Z", - "closed_at": null, - "withdrawn_at": null, - "submission": null, - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "a-package" - }, - "vulnerable_version_range": ">= 1.0.0, < 1.0.1", - "patched_versions": "1.0.1", - "vulnerable_functions": [ - "function1" - ] - }, - { - "package": { - "ecosystem": "pip", - "name": "another-package" - }, - "vulnerable_version_range": ">= 1.0.0, < 1.0.2", - "patched_versions": "1.0.2", - "vulnerable_functions": [ - "function2" - ] - } - ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", - "score": 9.8 - }, - "cwes": [ - { - "cwe_id": "CWE-123", - "name": "A CWE" - } - ], - "cwe_ids": [ - "CWE-123" - ], - "credits": [ - { - "login": "octocat", - "type": "analyst" - } - ], - "credits_detailed": [ - { - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "type": "analyst", - "state": "accepted" - } - ], - "collaborating_users": [ - { - "login": "octokitten", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octokitten_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octokitten", - "html_url": "https://github.com/octokitten", - "followers_url": "https://api.github.com/users/octokitten/followers", - "following_url": "https://api.github.com/users/octokitten/following{/other_user}", - "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", - "organizations_url": "https://api.github.com/users/octokitten/orgs", - "repos_url": "https://api.github.com/users/octokitten/repos", - "events_url": "https://api.github.com/users/octokitten/events{/privacy}", - "received_events_url": "https://api.github.com/users/octokitten/received_events", - "type": "User", - "site_admin": false - } - ], - "collaborating_teams": [ - { - "name": "Justice League", - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "permission": "admin", - "parent": null - } - ] - }, - { - "ghsa_id": "GHSA-1234-5678-9012", - "cve_id": "CVE-2051-0000", - "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012", - "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-1234-5678-9012", - "summary": "A short summary of the advisory.", - "description": "A detailed description of what the advisory entails.", - "severity": "low", - "author": { - "login": "monauser", - "id": 2, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/monauser", - "html_url": "https://github.com/monauser", - "followers_url": "https://api.github.com/users/monauser/followers", - "following_url": "https://api.github.com/users/monauser/following{/other_user}", - "gists_url": "https://api.github.com/users/monauser/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monauser/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monauser/subscriptions", - "organizations_url": "https://api.github.com/users/monauser/orgs", - "repos_url": "https://api.github.com/users/monauser/repos", - "events_url": "https://api.github.com/users/monauser/events{/privacy}", - "received_events_url": "https://api.github.com/users/monauser/received_events", - "type": "User", - "site_admin": false - }, - "publisher": { - "login": "monalisa", - "id": 3, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": false - }, - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-1234-5678-9012" - }, - { - "type": "CVE", - "value": "CVE-2051-00000" - } - ], - "state": "published", - "created_at": "2020-01-03T00:00:00Z", - "updated_at": "2020-01-04T00:00:00Z", - "published_at": "2020-01-04T00:00:00Z", - "closed_at": null, - "withdrawn_at": null, - "submission": [ - { - "accepted": true - } - ], - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "a-package" - }, - "vulnerable_version_range": ">= 1.0.0, < 1.0.1", - "patched_versions": "1.0.1", - "vulnerable_functions": [ - "function1" - ] - }, - { - "package": { - "ecosystem": "pip", - "name": "another-package" - }, - "vulnerable_version_range": ">= 1.0.0, < 1.0.2", - "patched_versions": "1.0.2", - "vulnerable_functions": [ - "function2" - ] - } - ], - "cvss": { - "vector_string": "AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N", - "score": 1.6 - }, - "cwes": [ - { - "cwe_id": "CWE-456", - "name": "A CWE 2.0" - } - ], - "cwe_ids": [ - "CWE-456" - ], - "credits": [ - { - "login": "monauser", - "type": "reporter" - } - ], - "credits_detailed": [ - { - "user": { - "login": "monauser", - "id": 2, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/monauser", - "html_url": "https://github.com/monauser", - "followers_url": "https://api.github.com/users/monauser/followers", - "following_url": "https://api.github.com/users/monauser/following{/other_user}", - "gists_url": "https://api.github.com/users/monauser/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monauser/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monauser/subscriptions", - "organizations_url": "https://api.github.com/users/monauser/orgs", - "repos_url": "https://api.github.com/users/monauser/repos", - "events_url": "https://api.github.com/users/monauser/events{/privacy}", - "received_events_url": "https://api.github.com/users/monauser/received_events", - "type": "User", - "site_admin": false - }, - "type": "reporter", - "state": "accepted" - } - ], - "collaborating_users": [ - { - "login": "octokitten", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octokitten_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octokitten", - "html_url": "https://github.com/octokitten", - "followers_url": "https://api.github.com/users/octokitten/followers", - "following_url": "https://api.github.com/users/octokitten/following{/other_user}", - "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", - "organizations_url": "https://api.github.com/users/octokitten/orgs", - "repos_url": "https://api.github.com/users/octokitten/repos", - "events_url": "https://api.github.com/users/octokitten/events{/privacy}", - "received_events_url": "https://api.github.com/users/octokitten/received_events", - "type": "User", - "site_admin": false - } - ], - "collaborating_teams": [ - { - "name": "Justice League", - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "permission": "admin", - "parent": null - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "description": "A repository security advisory.", - "type": "object", - "properties": { - "ghsa_id": { - "type": "string", - "description": "The GitHub Security Advisory ID.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The Common Vulnerabilities and Exposures (CVE) ID." - }, - "url": { - "type": "string", - "description": "The API URL for the advisory." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL for the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short summary of the advisory.", - "maxLength": 1024 - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "A detailed description of what the advisory entails.", - "maxLength": 65535 - }, - "severity": { - "type": [ - "string", - "null" - ], - "description": "The severity of the advisory.", - "enum": [ - "critical", - "high", - "medium", - "low", - null - ] - }, - "author": { - "readOnly": true, - "description": "The author of the advisory.", - "allOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ], - "type": [ - "null" - ] - }, - "publisher": { - "readOnly": true, - "description": "The publisher of the advisory.", - "allOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ], - "type": [ - "null" - ] - }, - "identifiers": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of identifier.", - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The identifier value." - } - }, - "required": [ - "type", - "value" - ] - }, - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the advisory.", - "enum": [ - "published", - "closed", - "withdrawn", - "draft", - "triage" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was created, in ISO 8601 format.", - "readOnly": true - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", - "readOnly": true - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was published, in ISO 8601 format.", - "readOnly": true - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was closed, in ISO 8601 format.", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", - "readOnly": true - }, - "submission": { - "type": [ - "object", - "null" - ], - "readOnly": true, - "properties": { - "accepted": { - "type": "boolean", - "description": "Whether a private vulnerability report was accepted by the repository's administrators.", - "readOnly": true - } - }, - "required": [ - "accepted" - ] - }, - "vulnerabilities": { - "type": [ - "array", - "null" - ], - "items": { - "description": "A product affected by the vulnerability detailed in a repository security advisory.", - "type": "object", - "properties": { - "package": { - "description": "The name of the package affected by the vulnerability.", - "type": [ - "object", - "null" - ], - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "enum": [ - "rubygems", - "npm", - "pip", - "maven", - "nuget", - "composer", - "go", - "rust", - "erlang", - "actions", - "pub", - "other", - "swift" - ] - }, - "name": { - "type": [ - "string", - "null" - ], - "description": "The unique package name within its ecosystem." - } - }, - "required": [ - "ecosystem", - "name" - ] - }, - "vulnerable_version_range": { - "type": [ - "string", - "null" - ], - "description": "The range of the package versions affected by the vulnerability." - }, - "patched_versions": { - "type": [ - "string", - "null" - ], - "description": "The package version(s) that resolve the vulnerability." - }, - "vulnerable_functions": { - "type": [ - "array", - "null" - ], - "description": "The functions in the package that are affected.", - "items": { - "type": "string" - } - } - }, - "required": [ - "package", - "vulnerable_version_range", - "patched_versions", - "vulnerable_functions" - ], - "additionalProperties": false - } - }, - "cvss": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS vector." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cwes": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "cwe_id": { - "type": "string", - "description": "The Common Weakness Enumeration (CWE) identifier." - }, - "name": { - "type": "string", - "description": "The name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ] - }, - "readOnly": true - }, - "cwe_ids": { - "type": [ - "array", - "null" - ], - "description": "A list of only the CWE IDs.", - "items": { - "type": "string" - } - }, - "credits": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "login": { - "type": "string", - "description": "The username of the user credited." - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - } - } - } - }, - "credits_detailed": { - "type": [ - "array", - "null" - ], - "items": { - "description": "A credit given to a user for a repository security advisory.", - "type": "object", - "properties": { - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - }, - "state": { - "type": "string", - "description": "The state of the user's acceptance of the credit.", - "enum": [ - "accepted", - "declined", - "pending" - ] - } - }, - "required": [ - "user", - "type", - "state" - ], - "additionalProperties": false - }, - "readOnly": true - }, - "collaborating_users": { - "type": [ - "array", - "null" - ], - "description": "A list of users that collaborate on the advisory.", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "collaborating_teams": { - "type": [ - "array", - "null" - ], - "description": "A list of teams that collaborate on the advisory.", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } - }, - "private_fork": { - "readOnly": true, - "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", - "allOf": [ - { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" - ] - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } - ], - "type": [ - "null" - ] - } - }, - "required": [ - "ghsa_id", - "cve_id", - "url", - "html_url", - "summary", - "description", - "severity", - "author", - "publisher", - "identifiers", - "state", - "created_at", - "updated_at", - "published_at", - "closed_at", - "withdrawn_at", - "submission", - "vulnerabilities", - "cvss", - "cwes", - "cwe_ids", - "credits", - "credits_detailed", - "collaborating_users", - "collaborating_teams", - "private_fork" - ], - "additionalProperties": false - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Lists repository security advisories for an organization.
\nTo use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the repo scope or repository_advisories:write permission.
OK
" - }, - { - "httpStatusCode": "400", - "description": "Bad Request
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ] - }, { "serverUrl": "https://api.github.com", "verb": "get", diff --git a/src/rest/data/ghae/schema.json b/src/rest/data/ghae/schema.json index 9c5bc1695d..e0d83c12a3 100644 --- a/src/rest/data/ghae/schema.json +++ b/src/rest/data/ghae/schema.json @@ -118716,7 +118716,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the API.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", + "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", "statusCodes": [ { "httpStatusCode": "201", @@ -133952,7 +133952,7 @@ } ], "previews": [], - "descriptionHTML": "Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", + "descriptionHTML": "Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", "statusCodes": [ { "httpStatusCode": "200", @@ -245686,7 +245686,7 @@ }, "response": { "statusCode": "200", - "contentType": "application/json", + "contentType": "text/plain", "description": "Example response
", "example": "Responsive is better than fast", "schema": { @@ -288131,7 +288131,7 @@ } ], "previews": [], - "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub AE creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub AE has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", + "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub AE creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub AE has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", "statusCodes": [ { "httpStatusCode": "200", @@ -309548,7 +309548,7 @@ "type": "string", "name": "event", "in": "body", - "description": "The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.
The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", + "descriptionHTML": "Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", "statusCodes": [ { "httpStatusCode": "200", @@ -312748,7 +312748,7 @@ } ], "previews": [], - "descriptionHTML": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"
", + "descriptionHTML": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -313163,7 +313163,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { @@ -313470,7 +313470,7 @@ } } ], - "descriptionHTML": "List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
The reaction type to add to the team discussion comment.
", + "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", @@ -314080,7 +314080,7 @@ } } ], - "descriptionHTML": "Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { @@ -314525,7 +314525,7 @@ } } ], - "descriptionHTML": "List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
The reaction type to add to the team discussion.
", + "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", @@ -315124,7 +315124,7 @@ } } ], - "descriptionHTML": "Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", "in": "query", "required": false, "schema": { @@ -315559,7 +315559,7 @@ } } ], - "descriptionHTML": "List the reactions to a commit comment.
", + "descriptionHTML": "List the reactions to a commit comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -315571,7 +315571,7 @@ } ], "previews": [ - "An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
The reaction type to add to the commit comment.
", + "description": "The reaction type to add to the commit comment.
", "isRequired": true, "enum": [ "+1", @@ -316162,7 +316162,7 @@ } } ], - "descriptionHTML": "Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -316259,7 +316259,7 @@ } ], "previews": [ - "An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", "in": "query", "required": false, "schema": { @@ -316605,7 +316605,7 @@ } } ], - "descriptionHTML": "List the reactions to an issue comment.
", + "descriptionHTML": "List the reactions to an issue comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -316617,7 +316617,7 @@ } ], "previews": [ - "An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
The reaction type to add to the issue comment.
", + "description": "The reaction type to add to the issue comment.
", "isRequired": true, "enum": [ "+1", @@ -317208,7 +317208,7 @@ } } ], - "descriptionHTML": "Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -317301,7 +317301,7 @@ } ], "previews": [ - "An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", "in": "query", "required": false, "schema": { @@ -317647,7 +317647,7 @@ } } ], - "descriptionHTML": "List the reactions to an issue.
", + "descriptionHTML": "List the reactions to an issue.
", "statusCodes": [ { "httpStatusCode": "200", @@ -317663,7 +317663,7 @@ } ], "previews": [ - "An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
The reaction type to add to the issue.
", + "description": "The reaction type to add to the issue.
", "isRequired": true, "enum": [ "+1", @@ -318254,7 +318254,7 @@ } } ], - "descriptionHTML": "Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", @@ -318347,7 +318347,7 @@ } ], "previews": [ - "An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", "in": "query", "required": false, "schema": { @@ -318693,7 +318693,7 @@ } } ], - "descriptionHTML": "List the reactions to a pull request review comment.
", + "descriptionHTML": "List the reactions to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -318705,7 +318705,7 @@ } ], "previews": [ - "An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
The reaction type to add to the pull request review comment.
", + "description": "The reaction type to add to the pull request review comment.
", "isRequired": true, "enum": [ "+1", @@ -319296,7 +319296,7 @@ } } ], - "descriptionHTML": "Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -319389,7 +319389,7 @@ } ], "previews": [ - "An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Returns a single reaction type. Omit this parameter to list all reactions to a release.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
", "in": "query", "required": false, "schema": { @@ -319733,7 +319733,7 @@ } } ], - "descriptionHTML": "List the reactions to a release.
", + "descriptionHTML": "List the reactions to a release.
", "statusCodes": [ { "httpStatusCode": "200", @@ -319749,7 +319749,7 @@ } ], "previews": [ - "An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
The reaction type to add to the release.
", + "description": "The reaction type to add to the release.
", "isRequired": true, "enum": [ "+1", @@ -320338,7 +320338,7 @@ } } ], - "descriptionHTML": "Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", "statusCodes": [ { "httpStatusCode": "204", @@ -320431,7 +320431,7 @@ } ], "previews": [ - "An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept header:
application/vnd.github.squirrel-girl-preview\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub AE expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub AE expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
\nThis API supports files up to 1 megabyte in size.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
\nThis API supports files up to 1 megabyte in size.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", + "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", @@ -353727,7 +353727,7 @@ } ], "previews": [], - "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", + "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index b7efdf75fe..34b4ce286a 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -164170,8 +164170,7 @@ "python" ], "query_suite": "default", - "updated_at": "2023-01-19T11:21:34Z", - "schedule": "weekly" + "updated_at": "2023-01-19T11:21:34Z" }, "schema": { "description": "Configuration for code scanning default setup.", @@ -164222,17 +164221,6 @@ "examples": [ "2023-12-06T14:20:20.000Z" ] - }, - "schedule": { - "description": "The frequency of the periodic analysis.", - "type": [ - "string", - "null" - ], - "enum": [ - "weekly", - null - ] } } } @@ -206431,7 +206419,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the API.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", + "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", "statusCodes": [ { "httpStatusCode": "201", @@ -221838,7 +221826,7 @@ } ], "previews": [], - "descriptionHTML": "Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", + "descriptionHTML": "Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", "statusCodes": [ { "httpStatusCode": "200", @@ -343829,7 +343817,7 @@ }, "response": { "statusCode": "200", - "contentType": "application/json", + "contentType": "text/plain", "description": "Example response
", "example": "Responsive is better than fast", "schema": { @@ -420129,7 +420117,7 @@ } ], "previews": [], - "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", + "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", "statusCodes": [ { "httpStatusCode": "200", @@ -441896,7 +441884,7 @@ "type": "string", "name": "event", "in": "body", - "description": "The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.
The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", + "descriptionHTML": "Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", "statusCodes": [ { "httpStatusCode": "200", @@ -445096,7 +445084,7 @@ } ], "previews": [], - "descriptionHTML": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"
", + "descriptionHTML": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -445535,7 +445523,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { @@ -445843,7 +445831,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
The reaction type to add to the team discussion comment.
", + "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", @@ -446451,7 +446439,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { @@ -446892,7 +446880,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
The reaction type to add to the team discussion.
", + "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", @@ -447489,7 +447477,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", "in": "query", "required": false, "schema": { @@ -447920,7 +447908,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a commit comment.
", + "descriptionHTML": "List the reactions to a commit comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -447973,7 +447961,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the commit comment.
", + "description": "The reaction type to add to the commit comment.
", "isRequired": true, "enum": [ "+1", @@ -448521,7 +448509,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -448649,7 +448637,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", "in": "query", "required": false, "schema": { @@ -448956,7 +448944,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to an issue comment.
", + "descriptionHTML": "List the reactions to an issue comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -449009,7 +448997,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the issue comment.
", + "description": "The reaction type to add to the issue comment.
", "isRequired": true, "enum": [ "+1", @@ -449557,7 +449545,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -449685,7 +449673,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", "in": "query", "required": false, "schema": { @@ -449992,7 +449980,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to an issue.
", + "descriptionHTML": "List the reactions to an issue.
", "statusCodes": [ { "httpStatusCode": "200", @@ -450049,7 +450037,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the issue.
", + "description": "The reaction type to add to the issue.
", "isRequired": true, "enum": [ "+1", @@ -450597,7 +450585,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", @@ -450725,7 +450713,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", "in": "query", "required": false, "schema": { @@ -451032,7 +451020,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a pull request review comment.
", + "descriptionHTML": "List the reactions to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -451085,7 +451073,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the pull request review comment.
", + "description": "The reaction type to add to the pull request review comment.
", "isRequired": true, "enum": [ "+1", @@ -451633,7 +451621,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -451761,7 +451749,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
", "in": "query", "required": false, "schema": { @@ -452066,7 +452054,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a release.
", + "descriptionHTML": "List the reactions to a release.
", "statusCodes": [ { "httpStatusCode": "200", @@ -452119,7 +452107,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the release.
", + "description": "The reaction type to add to the release.
", "isRequired": true, "enum": [ "+1", @@ -452665,7 +452653,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", "statusCodes": [ { "httpStatusCode": "204", @@ -452793,7 +452781,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { @@ -453100,7 +453088,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
The reaction type to add to the team discussion comment.
", + "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", @@ -453432,7 +453420,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { @@ -453774,7 +453762,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
The reaction type to add to the team discussion.
", + "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", @@ -454096,7 +454084,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
", + "descriptionHTML": "Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
", "statusCodes": [ { "httpStatusCode": "200", @@ -460281,7 +460269,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", + "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", @@ -490268,7 +490256,7 @@ } ], "previews": [], - "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", + "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", @@ -520384,2332 +520372,6 @@ } ], "repository-advisories": [ - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/security-advisories", - "title": "List repository security advisories for an organization", - "category": "security-advisories", - "subcategory": "repository-advisories", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "sort", - "description": "The property to sort the results by.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "published" - ], - "default": "created" - } - }, - { - "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "The number of advisories to return per page.
", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "state", - "description": "Filter by the state of the repository advisories. Only advisories of this state will be returned.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "triage", - "draft", - "published", - "closed" - ] - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "ghsa_id": "GHSA-abcd-1234-efgh", - "cve_id": "CVE-2050-00000", - "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh", - "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh", - "summary": "A short summary of the advisory.", - "description": "A detailed description of what the advisory entails.", - "severity": "critical", - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "publisher": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-abcd-1234-efgh" - }, - { - "type": "CVE", - "value": "CVE-2050-00000" - } - ], - "state": "published", - "created_at": "2020-01-01T00:00:00Z", - "updated_at": "2020-01-02T00:00:00Z", - "published_at": "2020-01-03T00:00:00Z", - "closed_at": null, - "withdrawn_at": null, - "submission": null, - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "a-package" - }, - "vulnerable_version_range": ">= 1.0.0, < 1.0.1", - "patched_versions": "1.0.1", - "vulnerable_functions": [ - "function1" - ] - }, - { - "package": { - "ecosystem": "pip", - "name": "another-package" - }, - "vulnerable_version_range": ">= 1.0.0, < 1.0.2", - "patched_versions": "1.0.2", - "vulnerable_functions": [ - "function2" - ] - } - ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", - "score": 9.8 - }, - "cwes": [ - { - "cwe_id": "CWE-123", - "name": "A CWE" - } - ], - "cwe_ids": [ - "CWE-123" - ], - "credits": [ - { - "login": "octocat", - "type": "analyst" - } - ], - "credits_detailed": [ - { - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "type": "analyst", - "state": "accepted" - } - ], - "collaborating_users": [ - { - "login": "octokitten", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octokitten_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octokitten", - "html_url": "https://github.com/octokitten", - "followers_url": "https://api.github.com/users/octokitten/followers", - "following_url": "https://api.github.com/users/octokitten/following{/other_user}", - "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", - "organizations_url": "https://api.github.com/users/octokitten/orgs", - "repos_url": "https://api.github.com/users/octokitten/repos", - "events_url": "https://api.github.com/users/octokitten/events{/privacy}", - "received_events_url": "https://api.github.com/users/octokitten/received_events", - "type": "User", - "site_admin": false - } - ], - "collaborating_teams": [ - { - "name": "Justice League", - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "permission": "admin", - "parent": null - } - ] - }, - { - "ghsa_id": "GHSA-1234-5678-9012", - "cve_id": "CVE-2051-0000", - "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012", - "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-1234-5678-9012", - "summary": "A short summary of the advisory.", - "description": "A detailed description of what the advisory entails.", - "severity": "low", - "author": { - "login": "monauser", - "id": 2, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/monauser", - "html_url": "https://github.com/monauser", - "followers_url": "https://api.github.com/users/monauser/followers", - "following_url": "https://api.github.com/users/monauser/following{/other_user}", - "gists_url": "https://api.github.com/users/monauser/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monauser/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monauser/subscriptions", - "organizations_url": "https://api.github.com/users/monauser/orgs", - "repos_url": "https://api.github.com/users/monauser/repos", - "events_url": "https://api.github.com/users/monauser/events{/privacy}", - "received_events_url": "https://api.github.com/users/monauser/received_events", - "type": "User", - "site_admin": false - }, - "publisher": { - "login": "monalisa", - "id": 3, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": false - }, - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-1234-5678-9012" - }, - { - "type": "CVE", - "value": "CVE-2051-00000" - } - ], - "state": "published", - "created_at": "2020-01-03T00:00:00Z", - "updated_at": "2020-01-04T00:00:00Z", - "published_at": "2020-01-04T00:00:00Z", - "closed_at": null, - "withdrawn_at": null, - "submission": [ - { - "accepted": true - } - ], - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "a-package" - }, - "vulnerable_version_range": ">= 1.0.0, < 1.0.1", - "patched_versions": "1.0.1", - "vulnerable_functions": [ - "function1" - ] - }, - { - "package": { - "ecosystem": "pip", - "name": "another-package" - }, - "vulnerable_version_range": ">= 1.0.0, < 1.0.2", - "patched_versions": "1.0.2", - "vulnerable_functions": [ - "function2" - ] - } - ], - "cvss": { - "vector_string": "AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N", - "score": 1.6 - }, - "cwes": [ - { - "cwe_id": "CWE-456", - "name": "A CWE 2.0" - } - ], - "cwe_ids": [ - "CWE-456" - ], - "credits": [ - { - "login": "monauser", - "type": "reporter" - } - ], - "credits_detailed": [ - { - "user": { - "login": "monauser", - "id": 2, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/monauser", - "html_url": "https://github.com/monauser", - "followers_url": "https://api.github.com/users/monauser/followers", - "following_url": "https://api.github.com/users/monauser/following{/other_user}", - "gists_url": "https://api.github.com/users/monauser/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monauser/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monauser/subscriptions", - "organizations_url": "https://api.github.com/users/monauser/orgs", - "repos_url": "https://api.github.com/users/monauser/repos", - "events_url": "https://api.github.com/users/monauser/events{/privacy}", - "received_events_url": "https://api.github.com/users/monauser/received_events", - "type": "User", - "site_admin": false - }, - "type": "reporter", - "state": "accepted" - } - ], - "collaborating_users": [ - { - "login": "octokitten", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octokitten_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octokitten", - "html_url": "https://github.com/octokitten", - "followers_url": "https://api.github.com/users/octokitten/followers", - "following_url": "https://api.github.com/users/octokitten/following{/other_user}", - "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", - "organizations_url": "https://api.github.com/users/octokitten/orgs", - "repos_url": "https://api.github.com/users/octokitten/repos", - "events_url": "https://api.github.com/users/octokitten/events{/privacy}", - "received_events_url": "https://api.github.com/users/octokitten/received_events", - "type": "User", - "site_admin": false - } - ], - "collaborating_teams": [ - { - "name": "Justice League", - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "permission": "admin", - "parent": null - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "description": "A repository security advisory.", - "type": "object", - "properties": { - "ghsa_id": { - "type": "string", - "description": "The GitHub Security Advisory ID.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The Common Vulnerabilities and Exposures (CVE) ID." - }, - "url": { - "type": "string", - "description": "The API URL for the advisory." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL for the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short summary of the advisory.", - "maxLength": 1024 - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "A detailed description of what the advisory entails.", - "maxLength": 65535 - }, - "severity": { - "type": [ - "string", - "null" - ], - "description": "The severity of the advisory.", - "enum": [ - "critical", - "high", - "medium", - "low", - null - ] - }, - "author": { - "readOnly": true, - "description": "The author of the advisory.", - "allOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ], - "type": [ - "null" - ] - }, - "publisher": { - "readOnly": true, - "description": "The publisher of the advisory.", - "allOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ], - "type": [ - "null" - ] - }, - "identifiers": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of identifier.", - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The identifier value." - } - }, - "required": [ - "type", - "value" - ] - }, - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the advisory.", - "enum": [ - "published", - "closed", - "withdrawn", - "draft", - "triage" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was created, in ISO 8601 format.", - "readOnly": true - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", - "readOnly": true - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was published, in ISO 8601 format.", - "readOnly": true - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was closed, in ISO 8601 format.", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", - "readOnly": true - }, - "submission": { - "type": [ - "object", - "null" - ], - "readOnly": true, - "properties": { - "accepted": { - "type": "boolean", - "description": "Whether a private vulnerability report was accepted by the repository's administrators.", - "readOnly": true - } - }, - "required": [ - "accepted" - ] - }, - "vulnerabilities": { - "type": [ - "array", - "null" - ], - "items": { - "description": "A product affected by the vulnerability detailed in a repository security advisory.", - "type": "object", - "properties": { - "package": { - "description": "The name of the package affected by the vulnerability.", - "type": [ - "object", - "null" - ], - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "enum": [ - "rubygems", - "npm", - "pip", - "maven", - "nuget", - "composer", - "go", - "rust", - "erlang", - "actions", - "pub", - "other", - "swift" - ] - }, - "name": { - "type": [ - "string", - "null" - ], - "description": "The unique package name within its ecosystem." - } - }, - "required": [ - "ecosystem", - "name" - ] - }, - "vulnerable_version_range": { - "type": [ - "string", - "null" - ], - "description": "The range of the package versions affected by the vulnerability." - }, - "patched_versions": { - "type": [ - "string", - "null" - ], - "description": "The package version(s) that resolve the vulnerability." - }, - "vulnerable_functions": { - "type": [ - "array", - "null" - ], - "description": "The functions in the package that are affected.", - "items": { - "type": "string" - } - } - }, - "required": [ - "package", - "vulnerable_version_range", - "patched_versions", - "vulnerable_functions" - ], - "additionalProperties": false - } - }, - "cvss": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS vector." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cwes": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "cwe_id": { - "type": "string", - "description": "The Common Weakness Enumeration (CWE) identifier." - }, - "name": { - "type": "string", - "description": "The name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ] - }, - "readOnly": true - }, - "cwe_ids": { - "type": [ - "array", - "null" - ], - "description": "A list of only the CWE IDs.", - "items": { - "type": "string" - } - }, - "credits": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "login": { - "type": "string", - "description": "The username of the user credited." - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - } - } - } - }, - "credits_detailed": { - "type": [ - "array", - "null" - ], - "items": { - "description": "A credit given to a user for a repository security advisory.", - "type": "object", - "properties": { - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - }, - "state": { - "type": "string", - "description": "The state of the user's acceptance of the credit.", - "enum": [ - "accepted", - "declined", - "pending" - ] - } - }, - "required": [ - "user", - "type", - "state" - ], - "additionalProperties": false - }, - "readOnly": true - }, - "collaborating_users": { - "type": [ - "array", - "null" - ], - "description": "A list of users that collaborate on the advisory.", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "collaborating_teams": { - "type": [ - "array", - "null" - ], - "description": "A list of teams that collaborate on the advisory.", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } - }, - "private_fork": { - "readOnly": true, - "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", - "allOf": [ - { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" - ] - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } - ], - "type": [ - "null" - ] - } - }, - "required": [ - "ghsa_id", - "cve_id", - "url", - "html_url", - "summary", - "description", - "severity", - "author", - "publisher", - "identifiers", - "state", - "created_at", - "updated_at", - "published_at", - "closed_at", - "withdrawn_at", - "submission", - "vulnerabilities", - "cvss", - "cwes", - "cwe_ids", - "credits", - "credits_detailed", - "collaborating_users", - "collaborating_teams", - "private_fork" - ], - "additionalProperties": false - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Lists repository security advisories for an organization.
\nTo use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the repo scope or repository_advisories:write permission.
OK
" - }, - { - "httpStatusCode": "400", - "description": "Bad Request
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ] - }, { "serverUrl": "https://api.github.com", "verb": "get", diff --git a/src/rest/data/ghes-3.10-2022-11-28/schema.json b/src/rest/data/ghes-3.10-2022-11-28/schema.json index f36bcd16ec..f899d73768 100644 --- a/src/rest/data/ghes-3.10-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.10-2022-11-28/schema.json @@ -162093,7 +162093,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the API.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", + "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", "statusCodes": [ { "httpStatusCode": "201", @@ -177499,7 +177499,7 @@ } ], "previews": [], - "descriptionHTML": "Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", + "descriptionHTML": "Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", "statusCodes": [ { "httpStatusCode": "200", @@ -204182,7 +204182,7 @@ } ], "previews": [], - "descriptionHTML": "Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.
", + "descriptionHTML": "Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.
", "statusCodes": [ { "httpStatusCode": "200", @@ -311082,7 +311082,7 @@ }, "response": { "statusCode": "200", - "contentType": "application/json", + "contentType": "text/plain", "description": "Example response
", "example": "Responsive is better than fast", "schema": { @@ -381431,7 +381431,7 @@ } ], "previews": [], - "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", + "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", "statusCodes": [ { "httpStatusCode": "200", @@ -403198,7 +403198,7 @@ "type": "string", "name": "event", "in": "body", - "description": "The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.
The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", + "descriptionHTML": "Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", "statusCodes": [ { "httpStatusCode": "200", @@ -406398,7 +406398,7 @@ } ], "previews": [], - "descriptionHTML": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"
", + "descriptionHTML": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -406813,7 +406813,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { @@ -407121,7 +407121,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
The reaction type to add to the team discussion comment.
", + "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", @@ -407729,7 +407729,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { @@ -408170,7 +408170,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
The reaction type to add to the team discussion.
", + "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", @@ -408767,7 +408767,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", "in": "query", "required": false, "schema": { @@ -409198,7 +409198,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a commit comment.
", + "descriptionHTML": "List the reactions to a commit comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -409251,7 +409251,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the commit comment.
", + "description": "The reaction type to add to the commit comment.
", "isRequired": true, "enum": [ "+1", @@ -409799,7 +409799,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -409927,7 +409927,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", "in": "query", "required": false, "schema": { @@ -410234,7 +410234,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to an issue comment.
", + "descriptionHTML": "List the reactions to an issue comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -410287,7 +410287,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the issue comment.
", + "description": "The reaction type to add to the issue comment.
", "isRequired": true, "enum": [ "+1", @@ -410835,7 +410835,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -410963,7 +410963,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", "in": "query", "required": false, "schema": { @@ -411270,7 +411270,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to an issue.
", + "descriptionHTML": "List the reactions to an issue.
", "statusCodes": [ { "httpStatusCode": "200", @@ -411327,7 +411327,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the issue.
", + "description": "The reaction type to add to the issue.
", "isRequired": true, "enum": [ "+1", @@ -411875,7 +411875,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", @@ -412003,7 +412003,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", "in": "query", "required": false, "schema": { @@ -412310,7 +412310,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a pull request review comment.
", + "descriptionHTML": "List the reactions to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -412363,7 +412363,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the pull request review comment.
", + "description": "The reaction type to add to the pull request review comment.
", "isRequired": true, "enum": [ "+1", @@ -412911,7 +412911,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -413039,7 +413039,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
", "in": "query", "required": false, "schema": { @@ -413344,7 +413344,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a release.
", + "descriptionHTML": "List the reactions to a release.
", "statusCodes": [ { "httpStatusCode": "200", @@ -413397,7 +413397,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the release.
", + "description": "The reaction type to add to the release.
", "isRequired": true, "enum": [ "+1", @@ -413943,7 +413943,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", "statusCodes": [ { "httpStatusCode": "204", @@ -414071,7 +414071,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { @@ -414378,7 +414378,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
The reaction type to add to the team discussion comment.
", + "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", @@ -414710,7 +414710,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { @@ -415052,7 +415052,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
The reaction type to add to the team discussion.
", + "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", @@ -415374,7 +415374,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
", + "descriptionHTML": "Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
", "statusCodes": [ { "httpStatusCode": "200", @@ -421509,7 +421509,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", + "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", @@ -451125,7 +451125,7 @@ } ], "previews": [], - "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", + "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.6/schema.json b/src/rest/data/ghes-3.6/schema.json index 7aa0cef053..f01b572c31 100644 --- a/src/rest/data/ghes-3.6/schema.json +++ b/src/rest/data/ghes-3.6/schema.json @@ -153335,7 +153335,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the API.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", + "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", "statusCodes": [ { "httpStatusCode": "201", @@ -168531,7 +168531,7 @@ } ], "previews": [], - "descriptionHTML": "Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", + "descriptionHTML": "Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", "statusCodes": [ { "httpStatusCode": "200", @@ -186870,7 +186870,7 @@ } ], "previews": [], - "descriptionHTML": "Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.
", + "descriptionHTML": "Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.
", "statusCodes": [ { "httpStatusCode": "200", @@ -292858,7 +292858,7 @@ }, "response": { "statusCode": "200", - "contentType": "application/json", + "contentType": "text/plain", "description": "Example response
", "example": "Responsive is better than fast", "schema": { @@ -343675,7 +343675,7 @@ } ], "previews": [], - "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", + "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", "statusCodes": [ { "httpStatusCode": "200", @@ -365352,7 +365352,7 @@ "type": "string", "name": "event", "in": "body", - "description": "The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.
The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", + "descriptionHTML": "Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", "statusCodes": [ { "httpStatusCode": "200", @@ -368552,7 +368552,7 @@ } ], "previews": [], - "descriptionHTML": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"
", + "descriptionHTML": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -368967,7 +368967,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { @@ -369275,7 +369275,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
The reaction type to add to the team discussion comment.
", + "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", @@ -369883,7 +369883,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { @@ -370324,7 +370324,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
The reaction type to add to the team discussion.
", + "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", @@ -370921,7 +370921,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", "in": "query", "required": false, "schema": { @@ -371352,7 +371352,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a commit comment.
", + "descriptionHTML": "List the reactions to a commit comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -371405,7 +371405,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the commit comment.
", + "description": "The reaction type to add to the commit comment.
", "isRequired": true, "enum": [ "+1", @@ -371953,7 +371953,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -372081,7 +372081,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", "in": "query", "required": false, "schema": { @@ -372388,7 +372388,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to an issue comment.
", + "descriptionHTML": "List the reactions to an issue comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -372441,7 +372441,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the issue comment.
", + "description": "The reaction type to add to the issue comment.
", "isRequired": true, "enum": [ "+1", @@ -372989,7 +372989,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -373117,7 +373117,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", "in": "query", "required": false, "schema": { @@ -373424,7 +373424,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to an issue.
", + "descriptionHTML": "List the reactions to an issue.
", "statusCodes": [ { "httpStatusCode": "200", @@ -373481,7 +373481,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the issue.
", + "description": "The reaction type to add to the issue.
", "isRequired": true, "enum": [ "+1", @@ -374029,7 +374029,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", @@ -374157,7 +374157,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", "in": "query", "required": false, "schema": { @@ -374464,7 +374464,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a pull request review comment.
", + "descriptionHTML": "List the reactions to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -374517,7 +374517,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the pull request review comment.
", + "description": "The reaction type to add to the pull request review comment.
", "isRequired": true, "enum": [ "+1", @@ -375065,7 +375065,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -375193,7 +375193,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
", "in": "query", "required": false, "schema": { @@ -375498,7 +375498,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a release.
", + "descriptionHTML": "List the reactions to a release.
", "statusCodes": [ { "httpStatusCode": "200", @@ -375551,7 +375551,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the release.
", + "description": "The reaction type to add to the release.
", "isRequired": true, "enum": [ "+1", @@ -376097,7 +376097,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", "statusCodes": [ { "httpStatusCode": "204", @@ -376225,7 +376225,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { @@ -376532,7 +376532,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
The reaction type to add to the team discussion comment.
", + "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", @@ -376864,7 +376864,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { @@ -377206,7 +377206,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
The reaction type to add to the team discussion.
", + "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", @@ -377528,7 +377528,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
", + "descriptionHTML": "Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
", "statusCodes": [ { "httpStatusCode": "200", @@ -383639,7 +383639,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", + "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", @@ -412566,7 +412566,7 @@ } ], "previews": [], - "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", + "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.7/schema.json b/src/rest/data/ghes-3.7/schema.json index 04710ab465..a0da2be63c 100644 --- a/src/rest/data/ghes-3.7/schema.json +++ b/src/rest/data/ghes-3.7/schema.json @@ -155756,7 +155756,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the API.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", + "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", "statusCodes": [ { "httpStatusCode": "201", @@ -170977,7 +170977,7 @@ } ], "previews": [], - "descriptionHTML": "Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", + "descriptionHTML": "Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", "statusCodes": [ { "httpStatusCode": "200", @@ -189679,7 +189679,7 @@ } ], "previews": [], - "descriptionHTML": "Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.
", + "descriptionHTML": "Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.
", "statusCodes": [ { "httpStatusCode": "200", @@ -295783,7 +295783,7 @@ }, "response": { "statusCode": "200", - "contentType": "application/json", + "contentType": "text/plain", "description": "Example response
", "example": "Responsive is better than fast", "schema": { @@ -347305,7 +347305,7 @@ } ], "previews": [], - "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", + "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", "statusCodes": [ { "httpStatusCode": "200", @@ -369014,7 +369014,7 @@ "type": "string", "name": "event", "in": "body", - "description": "The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.
The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", + "descriptionHTML": "Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", "statusCodes": [ { "httpStatusCode": "200", @@ -372214,7 +372214,7 @@ } ], "previews": [], - "descriptionHTML": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"
", + "descriptionHTML": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -372629,7 +372629,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { @@ -372937,7 +372937,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
The reaction type to add to the team discussion comment.
", + "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", @@ -373545,7 +373545,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { @@ -373986,7 +373986,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
The reaction type to add to the team discussion.
", + "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", @@ -374583,7 +374583,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", "in": "query", "required": false, "schema": { @@ -375014,7 +375014,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a commit comment.
", + "descriptionHTML": "List the reactions to a commit comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -375067,7 +375067,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the commit comment.
", + "description": "The reaction type to add to the commit comment.
", "isRequired": true, "enum": [ "+1", @@ -375615,7 +375615,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -375743,7 +375743,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", "in": "query", "required": false, "schema": { @@ -376050,7 +376050,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to an issue comment.
", + "descriptionHTML": "List the reactions to an issue comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -376103,7 +376103,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the issue comment.
", + "description": "The reaction type to add to the issue comment.
", "isRequired": true, "enum": [ "+1", @@ -376651,7 +376651,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -376779,7 +376779,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", "in": "query", "required": false, "schema": { @@ -377086,7 +377086,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to an issue.
", + "descriptionHTML": "List the reactions to an issue.
", "statusCodes": [ { "httpStatusCode": "200", @@ -377143,7 +377143,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the issue.
", + "description": "The reaction type to add to the issue.
", "isRequired": true, "enum": [ "+1", @@ -377691,7 +377691,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", @@ -377819,7 +377819,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", "in": "query", "required": false, "schema": { @@ -378126,7 +378126,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a pull request review comment.
", + "descriptionHTML": "List the reactions to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -378179,7 +378179,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the pull request review comment.
", + "description": "The reaction type to add to the pull request review comment.
", "isRequired": true, "enum": [ "+1", @@ -378727,7 +378727,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -378855,7 +378855,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
", "in": "query", "required": false, "schema": { @@ -379160,7 +379160,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a release.
", + "descriptionHTML": "List the reactions to a release.
", "statusCodes": [ { "httpStatusCode": "200", @@ -379213,7 +379213,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the release.
", + "description": "The reaction type to add to the release.
", "isRequired": true, "enum": [ "+1", @@ -379759,7 +379759,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", "statusCodes": [ { "httpStatusCode": "204", @@ -379887,7 +379887,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { @@ -380194,7 +380194,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
The reaction type to add to the team discussion comment.
", + "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", @@ -380526,7 +380526,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { @@ -380868,7 +380868,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
The reaction type to add to the team discussion.
", + "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", @@ -381190,7 +381190,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
", + "descriptionHTML": "Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
", "statusCodes": [ { "httpStatusCode": "200", @@ -387301,7 +387301,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", + "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", @@ -416366,7 +416366,7 @@ } ], "previews": [], - "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", + "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.8/schema.json b/src/rest/data/ghes-3.8/schema.json index fc80bf5259..4dc76f3a20 100644 --- a/src/rest/data/ghes-3.8/schema.json +++ b/src/rest/data/ghes-3.8/schema.json @@ -159143,7 +159143,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the API.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", + "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", "statusCodes": [ { "httpStatusCode": "201", @@ -174364,7 +174364,7 @@ } ], "previews": [], - "descriptionHTML": "Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", + "descriptionHTML": "Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", "statusCodes": [ { "httpStatusCode": "200", @@ -199692,7 +199692,7 @@ } ], "previews": [], - "descriptionHTML": "Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.
", + "descriptionHTML": "Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.
", "statusCodes": [ { "httpStatusCode": "200", @@ -305820,7 +305820,7 @@ }, "response": { "statusCode": "200", - "contentType": "application/json", + "contentType": "text/plain", "description": "Example response
", "example": "Responsive is better than fast", "schema": { @@ -357470,7 +357470,7 @@ } ], "previews": [], - "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", + "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", "statusCodes": [ { "httpStatusCode": "200", @@ -379179,7 +379179,7 @@ "type": "string", "name": "event", "in": "body", - "description": "The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.
The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", + "descriptionHTML": "Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", "statusCodes": [ { "httpStatusCode": "200", @@ -382379,7 +382379,7 @@ } ], "previews": [], - "descriptionHTML": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"
", + "descriptionHTML": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -382794,7 +382794,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { @@ -383102,7 +383102,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
The reaction type to add to the team discussion comment.
", + "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", @@ -383710,7 +383710,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { @@ -384151,7 +384151,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
The reaction type to add to the team discussion.
", + "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", @@ -384748,7 +384748,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", "in": "query", "required": false, "schema": { @@ -385179,7 +385179,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a commit comment.
", + "descriptionHTML": "List the reactions to a commit comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -385232,7 +385232,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the commit comment.
", + "description": "The reaction type to add to the commit comment.
", "isRequired": true, "enum": [ "+1", @@ -385780,7 +385780,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -385908,7 +385908,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", "in": "query", "required": false, "schema": { @@ -386215,7 +386215,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to an issue comment.
", + "descriptionHTML": "List the reactions to an issue comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -386268,7 +386268,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the issue comment.
", + "description": "The reaction type to add to the issue comment.
", "isRequired": true, "enum": [ "+1", @@ -386816,7 +386816,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -386944,7 +386944,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", "in": "query", "required": false, "schema": { @@ -387251,7 +387251,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to an issue.
", + "descriptionHTML": "List the reactions to an issue.
", "statusCodes": [ { "httpStatusCode": "200", @@ -387308,7 +387308,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the issue.
", + "description": "The reaction type to add to the issue.
", "isRequired": true, "enum": [ "+1", @@ -387856,7 +387856,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", @@ -387984,7 +387984,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", "in": "query", "required": false, "schema": { @@ -388291,7 +388291,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a pull request review comment.
", + "descriptionHTML": "List the reactions to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -388344,7 +388344,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the pull request review comment.
", + "description": "The reaction type to add to the pull request review comment.
", "isRequired": true, "enum": [ "+1", @@ -388892,7 +388892,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -389020,7 +389020,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
", "in": "query", "required": false, "schema": { @@ -389325,7 +389325,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a release.
", + "descriptionHTML": "List the reactions to a release.
", "statusCodes": [ { "httpStatusCode": "200", @@ -389378,7 +389378,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the release.
", + "description": "The reaction type to add to the release.
", "isRequired": true, "enum": [ "+1", @@ -389924,7 +389924,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", "statusCodes": [ { "httpStatusCode": "204", @@ -390052,7 +390052,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { @@ -390359,7 +390359,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
The reaction type to add to the team discussion comment.
", + "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", @@ -390691,7 +390691,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { @@ -391033,7 +391033,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
The reaction type to add to the team discussion.
", + "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", @@ -391355,7 +391355,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
", + "descriptionHTML": "Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
", "statusCodes": [ { "httpStatusCode": "200", @@ -397490,7 +397490,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", + "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", @@ -426555,7 +426555,7 @@ } ], "previews": [], - "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", + "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.9-2022-11-28/schema.json b/src/rest/data/ghes-3.9-2022-11-28/schema.json index b780343bb0..2dce4e4559 100644 --- a/src/rest/data/ghes-3.9-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.9-2022-11-28/schema.json @@ -160810,7 +160810,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the API.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", + "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", "statusCodes": [ { "httpStatusCode": "201", @@ -176163,7 +176163,7 @@ } ], "previews": [], - "descriptionHTML": "Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", + "descriptionHTML": "Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", "statusCodes": [ { "httpStatusCode": "200", @@ -201934,7 +201934,7 @@ } ], "previews": [], - "descriptionHTML": "Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.
", + "descriptionHTML": "Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.
", "statusCodes": [ { "httpStatusCode": "200", @@ -308509,7 +308509,7 @@ }, "response": { "statusCode": "200", - "contentType": "application/json", + "contentType": "text/plain", "description": "Example response
", "example": "Responsive is better than fast", "schema": { @@ -375363,7 +375363,7 @@ } ], "previews": [], - "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", + "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", "statusCodes": [ { "httpStatusCode": "200", @@ -397082,7 +397082,7 @@ "type": "string", "name": "event", "in": "body", - "description": "The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.
The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", + "descriptionHTML": "Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", "statusCodes": [ { "httpStatusCode": "200", @@ -400282,7 +400282,7 @@ } ], "previews": [], - "descriptionHTML": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"
", + "descriptionHTML": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -400697,7 +400697,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { @@ -401005,7 +401005,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
The reaction type to add to the team discussion comment.
", + "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", @@ -401613,7 +401613,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { @@ -402054,7 +402054,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
The reaction type to add to the team discussion.
", + "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", @@ -402651,7 +402651,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", "in": "query", "required": false, "schema": { @@ -403082,7 +403082,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a commit comment.
", + "descriptionHTML": "List the reactions to a commit comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -403135,7 +403135,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the commit comment.
", + "description": "The reaction type to add to the commit comment.
", "isRequired": true, "enum": [ "+1", @@ -403683,7 +403683,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -403811,7 +403811,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", "in": "query", "required": false, "schema": { @@ -404118,7 +404118,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to an issue comment.
", + "descriptionHTML": "List the reactions to an issue comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -404171,7 +404171,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the issue comment.
", + "description": "The reaction type to add to the issue comment.
", "isRequired": true, "enum": [ "+1", @@ -404719,7 +404719,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -404847,7 +404847,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", "in": "query", "required": false, "schema": { @@ -405154,7 +405154,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to an issue.
", + "descriptionHTML": "List the reactions to an issue.
", "statusCodes": [ { "httpStatusCode": "200", @@ -405211,7 +405211,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the issue.
", + "description": "The reaction type to add to the issue.
", "isRequired": true, "enum": [ "+1", @@ -405759,7 +405759,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", @@ -405887,7 +405887,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", "in": "query", "required": false, "schema": { @@ -406194,7 +406194,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a pull request review comment.
", + "descriptionHTML": "List the reactions to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -406247,7 +406247,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the pull request review comment.
", + "description": "The reaction type to add to the pull request review comment.
", "isRequired": true, "enum": [ "+1", @@ -406795,7 +406795,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -406923,7 +406923,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
", "in": "query", "required": false, "schema": { @@ -407228,7 +407228,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a release.
", + "descriptionHTML": "List the reactions to a release.
", "statusCodes": [ { "httpStatusCode": "200", @@ -407281,7 +407281,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the release.
", + "description": "The reaction type to add to the release.
", "isRequired": true, "enum": [ "+1", @@ -407827,7 +407827,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", "statusCodes": [ { "httpStatusCode": "204", @@ -407955,7 +407955,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { @@ -408262,7 +408262,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
The reaction type to add to the team discussion comment.
", + "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", @@ -408594,7 +408594,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { @@ -408936,7 +408936,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
The reaction type to add to the team discussion.
", + "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", @@ -409258,7 +409258,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
", + "descriptionHTML": "Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
", "statusCodes": [ { "httpStatusCode": "200", @@ -415393,7 +415393,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", + "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", @@ -444825,7 +444825,7 @@ } ], "previews": [], - "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", + "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 626fcca787..b0c2afa51a 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -36,5 +36,5 @@ ] } }, - "sha": "005aa1dea12af0c9c55be923c81916ac089c6236" + "sha": "45ba714d4fde4f522d5cad95427eea033423da8f" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index c855dab907..aff46a8a77 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -9437,7 +9437,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -10335,7 +10335,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -11231,7 +11231,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -14340,7 +14340,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The commit comment resource.
", + "description": "The commit comment resource.
", "isRequired": true, "childParamsGroups": [ { @@ -18939,7 +18939,7 @@ "type": "object", "name": "key", "in": "body", - "description": "The deploy key resource.
The deploy key resource.
The deploy key resource.
The deploy key resource.
The deployment.
", + "description": "The deployment.
", "isRequired": true, "childParamsGroups": [ { @@ -30006,7 +30006,7 @@ "type": "object", "name": "deployment", "in": "body", - "description": "The deployment.
", + "description": "The deployment.
", "isRequired": true, "childParamsGroups": [ { @@ -30736,7 +30736,7 @@ "type": "object", "name": "deployment_status", "in": "body", - "description": "The deployment status.
", + "description": "The deployment status.
", "isRequired": true, "childParamsGroups": [ { @@ -47952,7 +47952,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -48483,7 +48483,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -48537,7 +48537,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -49069,7 +49069,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -49145,7 +49145,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -49677,7 +49677,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -49867,7 +49867,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -51212,7 +51212,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true }, { @@ -51280,7 +51280,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -52947,7 +52947,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -54342,7 +54342,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -56088,7 +56088,7 @@ { "type": "object or null", "name": "old_issue", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -58102,7 +58102,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -59445,7 +59445,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -60846,7 +60846,7 @@ { "type": "object", "name": "new_issue", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -62872,7 +62872,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -64334,7 +64334,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -65679,7 +65679,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -67142,7 +67142,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -79963,7 +79963,7 @@ "type": "object", "name": "build", "in": "body", - "description": "The List GitHub Pages builds itself.
", + "description": "The List GitHub Pages builds itself.
", "isRequired": true, "childParamsGroups": [ { @@ -139354,7 +139354,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -142796,7 +142796,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -146259,7 +146259,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -166151,7 +166151,7 @@ "type": "array of objects", "name": "commits", "in": "body", - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.
An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.
The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -168943,7 +168943,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -169551,7 +169551,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -170244,7 +170244,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -184094,7 +184094,7 @@ "status": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Commit statuses\" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.
", + "summaryHtml": "This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Statuses\" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.
", "bodyParameters": [ { "type": "string or null", diff --git a/src/webhooks/data/ghae/schema.json b/src/webhooks/data/ghae/schema.json index 9737fe9ef4..da498ea5ba 100644 --- a/src/webhooks/data/ghae/schema.json +++ b/src/webhooks/data/ghae/schema.json @@ -9437,7 +9437,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -10335,7 +10335,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -11231,7 +11231,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -14340,7 +14340,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The commit comment resource.
", + "description": "The commit comment resource.
", "isRequired": true, "childParamsGroups": [ { @@ -18939,7 +18939,7 @@ "type": "object", "name": "key", "in": "body", - "description": "The deploy key resource.
The deploy key resource.
The deploy key resource.
The deploy key resource.
The deployment.
", + "description": "The deployment.
", "isRequired": true, "childParamsGroups": [ { @@ -30006,7 +30006,7 @@ "type": "object", "name": "deployment", "in": "body", - "description": "The deployment.
", + "description": "The deployment.
", "isRequired": true, "childParamsGroups": [ { @@ -30736,7 +30736,7 @@ "type": "object", "name": "deployment_status", "in": "body", - "description": "The deployment status.
", + "description": "The deployment status.
", "isRequired": true, "childParamsGroups": [ { @@ -46709,7 +46709,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -47240,7 +47240,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -47294,7 +47294,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -47826,7 +47826,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -47902,7 +47902,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -48434,7 +48434,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -48624,7 +48624,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -49969,7 +49969,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true }, { @@ -50037,7 +50037,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -51704,7 +51704,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -53099,7 +53099,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -54845,7 +54845,7 @@ { "type": "object or null", "name": "old_issue", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -56859,7 +56859,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -58202,7 +58202,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -59603,7 +59603,7 @@ { "type": "object", "name": "new_issue", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -61629,7 +61629,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -63091,7 +63091,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -64436,7 +64436,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -65899,7 +65899,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -76959,7 +76959,7 @@ "type": "object", "name": "build", "in": "body", - "description": "The List GitHub Pages builds itself.
", + "description": "The List GitHub Pages builds itself.
", "isRequired": true, "childParamsGroups": [ { @@ -126800,7 +126800,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -130242,7 +130242,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -133705,7 +133705,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -153597,7 +153597,7 @@ "type": "array of objects", "name": "commits", "in": "body", - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.
An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.
The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -156389,7 +156389,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -156984,7 +156984,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -157677,7 +157677,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -164011,7 +164011,7 @@ "status": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Commit statuses\" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.
", + "summaryHtml": "This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Statuses\" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.
", "bodyParameters": [ { "type": "string or null", diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index a494a27a5d..86f63a70f4 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -9437,7 +9437,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -10335,7 +10335,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -11231,7 +11231,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -14340,7 +14340,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The commit comment resource.
", + "description": "The commit comment resource.
", "isRequired": true, "childParamsGroups": [ { @@ -18939,7 +18939,7 @@ "type": "object", "name": "key", "in": "body", - "description": "The deploy key resource.
The deploy key resource.
The deploy key resource.
The deploy key resource.
The deployment.
", + "description": "The deployment.
", "isRequired": true, "childParamsGroups": [ { @@ -30006,7 +30006,7 @@ "type": "object", "name": "deployment", "in": "body", - "description": "The deployment.
", + "description": "The deployment.
", "isRequired": true, "childParamsGroups": [ { @@ -30736,7 +30736,7 @@ "type": "object", "name": "deployment_status", "in": "body", - "description": "The deployment status.
", + "description": "The deployment status.
", "isRequired": true, "childParamsGroups": [ { @@ -47952,7 +47952,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -48483,7 +48483,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -48537,7 +48537,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -49069,7 +49069,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -49145,7 +49145,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -49677,7 +49677,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -49867,7 +49867,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -51212,7 +51212,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true }, { @@ -51280,7 +51280,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -52947,7 +52947,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -54342,7 +54342,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -56088,7 +56088,7 @@ { "type": "object or null", "name": "old_issue", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -58102,7 +58102,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -59445,7 +59445,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -60846,7 +60846,7 @@ { "type": "object", "name": "new_issue", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -62872,7 +62872,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -64334,7 +64334,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -65679,7 +65679,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -67142,7 +67142,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -79963,7 +79963,7 @@ "type": "object", "name": "build", "in": "body", - "description": "The List GitHub Pages builds itself.
", + "description": "The List GitHub Pages builds itself.
", "isRequired": true, "childParamsGroups": [ { @@ -139354,7 +139354,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -142796,7 +142796,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -146259,7 +146259,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -166151,7 +166151,7 @@ "type": "array of objects", "name": "commits", "in": "body", - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.
An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.
The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -168943,7 +168943,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -169551,7 +169551,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -170244,7 +170244,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -184094,7 +184094,7 @@ "status": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Commit statuses\" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.
", + "summaryHtml": "This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Statuses\" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.
", "bodyParameters": [ { "type": "string or null", diff --git a/src/webhooks/data/ghes-3.10/schema.json b/src/webhooks/data/ghes-3.10/schema.json index 2f1d8d240a..821abdaaf1 100644 --- a/src/webhooks/data/ghes-3.10/schema.json +++ b/src/webhooks/data/ghes-3.10/schema.json @@ -9515,7 +9515,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -10413,7 +10413,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -11309,7 +11309,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -14418,7 +14418,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The commit comment resource.
", + "description": "The commit comment resource.
", "isRequired": true, "childParamsGroups": [ { @@ -17853,7 +17853,7 @@ "type": "object", "name": "key", "in": "body", - "description": "The deploy key resource.
The deploy key resource.
The deploy key resource.
The deploy key resource.
The deployment.
", + "description": "The deployment.
", "isRequired": true, "childParamsGroups": [ { @@ -28920,7 +28920,7 @@ "type": "object", "name": "deployment", "in": "body", - "description": "The deployment.
", + "description": "The deployment.
", "isRequired": true, "childParamsGroups": [ { @@ -29650,7 +29650,7 @@ "type": "object", "name": "deployment_status", "in": "body", - "description": "The deployment status.
", + "description": "The deployment status.
", "isRequired": true, "childParamsGroups": [ { @@ -46921,7 +46921,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -47452,7 +47452,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -47506,7 +47506,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -48038,7 +48038,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -48114,7 +48114,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -48646,7 +48646,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -48836,7 +48836,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -50181,7 +50181,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true }, { @@ -50249,7 +50249,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -51916,7 +51916,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -53311,7 +53311,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -55057,7 +55057,7 @@ { "type": "object or null", "name": "old_issue", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -57071,7 +57071,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -58414,7 +58414,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -59815,7 +59815,7 @@ { "type": "object", "name": "new_issue", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -61841,7 +61841,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -63303,7 +63303,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -64648,7 +64648,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -66111,7 +66111,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -77171,7 +77171,7 @@ "type": "object", "name": "build", "in": "body", - "description": "The List GitHub Pages builds itself.
", + "description": "The List GitHub Pages builds itself.
", "isRequired": true, "childParamsGroups": [ { @@ -130131,7 +130131,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -133573,7 +133573,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -137036,7 +137036,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -156928,7 +156928,7 @@ "type": "array of objects", "name": "commits", "in": "body", - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.
An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.
The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -159720,7 +159720,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -160328,7 +160328,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -161021,7 +161021,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -169035,7 +169035,7 @@ "status": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Commit statuses\" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.
", + "summaryHtml": "This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Statuses\" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.
", "bodyParameters": [ { "type": "string or null", diff --git a/src/webhooks/data/ghes-3.7/schema.json b/src/webhooks/data/ghes-3.7/schema.json index 37442cfb32..f32124f200 100644 --- a/src/webhooks/data/ghes-3.7/schema.json +++ b/src/webhooks/data/ghes-3.7/schema.json @@ -9216,7 +9216,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -10114,7 +10114,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -11010,7 +11010,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -14119,7 +14119,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The commit comment resource.
", + "description": "The commit comment resource.
", "isRequired": true, "childParamsGroups": [ { @@ -17554,7 +17554,7 @@ "type": "object", "name": "key", "in": "body", - "description": "The deploy key resource.
The deploy key resource.
The deploy key resource.
The deploy key resource.
The deployment.
", + "description": "The deployment.
", "isRequired": true, "childParamsGroups": [ { @@ -24882,7 +24882,7 @@ "type": "object", "name": "deployment", "in": "body", - "description": "The deployment.
", + "description": "The deployment.
", "isRequired": true, "childParamsGroups": [ { @@ -25612,7 +25612,7 @@ "type": "object", "name": "deployment_status", "in": "body", - "description": "The deployment status.
", + "description": "The deployment status.
", "isRequired": true, "childParamsGroups": [ { @@ -41733,7 +41733,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -42264,7 +42264,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -42318,7 +42318,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -42850,7 +42850,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -42926,7 +42926,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -43458,7 +43458,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -43648,7 +43648,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -44993,7 +44993,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true }, { @@ -45061,7 +45061,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -46728,7 +46728,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -48123,7 +48123,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -49869,7 +49869,7 @@ { "type": "object or null", "name": "old_issue", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -51883,7 +51883,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -53226,7 +53226,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -54627,7 +54627,7 @@ { "type": "object", "name": "new_issue", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -56653,7 +56653,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -58115,7 +58115,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -59460,7 +59460,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -60923,7 +60923,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -71945,7 +71945,7 @@ "type": "object", "name": "build", "in": "body", - "description": "The List GitHub Pages builds itself.
", + "description": "The List GitHub Pages builds itself.
", "isRequired": true, "childParamsGroups": [ { @@ -120899,7 +120899,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -124341,7 +124341,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -127804,7 +127804,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -147696,7 +147696,7 @@ "type": "array of objects", "name": "commits", "in": "body", - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.
An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.
The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -150488,7 +150488,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -151083,7 +151083,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -151776,7 +151776,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -159746,7 +159746,7 @@ "status": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Commit statuses\" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.
", + "summaryHtml": "This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Statuses\" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.
", "bodyParameters": [ { "type": "string or null", diff --git a/src/webhooks/data/ghes-3.8/schema.json b/src/webhooks/data/ghes-3.8/schema.json index 8e080cca43..c894cdf756 100644 --- a/src/webhooks/data/ghes-3.8/schema.json +++ b/src/webhooks/data/ghes-3.8/schema.json @@ -9216,7 +9216,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -10114,7 +10114,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -11010,7 +11010,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -14119,7 +14119,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The commit comment resource.
", + "description": "The commit comment resource.
", "isRequired": true, "childParamsGroups": [ { @@ -17554,7 +17554,7 @@ "type": "object", "name": "key", "in": "body", - "description": "The deploy key resource.
The deploy key resource.
The deploy key resource.
The deploy key resource.
The deployment.
", + "description": "The deployment.
", "isRequired": true, "childParamsGroups": [ { @@ -24882,7 +24882,7 @@ "type": "object", "name": "deployment", "in": "body", - "description": "The deployment.
", + "description": "The deployment.
", "isRequired": true, "childParamsGroups": [ { @@ -25612,7 +25612,7 @@ "type": "object", "name": "deployment_status", "in": "body", - "description": "The deployment status.
", + "description": "The deployment status.
", "isRequired": true, "childParamsGroups": [ { @@ -41733,7 +41733,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -42264,7 +42264,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -42318,7 +42318,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -42850,7 +42850,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -42926,7 +42926,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -43458,7 +43458,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -43648,7 +43648,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -44993,7 +44993,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true }, { @@ -45061,7 +45061,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -46728,7 +46728,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -48123,7 +48123,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -49869,7 +49869,7 @@ { "type": "object or null", "name": "old_issue", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -51883,7 +51883,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -53226,7 +53226,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -54627,7 +54627,7 @@ { "type": "object", "name": "new_issue", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -56653,7 +56653,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -58115,7 +58115,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -59460,7 +59460,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -60923,7 +60923,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -71945,7 +71945,7 @@ "type": "object", "name": "build", "in": "body", - "description": "The List GitHub Pages builds itself.
", + "description": "The List GitHub Pages builds itself.
", "isRequired": true, "childParamsGroups": [ { @@ -120899,7 +120899,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -124341,7 +124341,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -127804,7 +127804,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -147696,7 +147696,7 @@ "type": "array of objects", "name": "commits", "in": "body", - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.
An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.
The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -150488,7 +150488,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -151083,7 +151083,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -151776,7 +151776,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -159774,7 +159774,7 @@ "status": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Commit statuses\" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.
", + "summaryHtml": "This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Statuses\" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.
", "bodyParameters": [ { "type": "string or null", diff --git a/src/webhooks/data/ghes-3.9/schema.json b/src/webhooks/data/ghes-3.9/schema.json index e934f2e8d0..e82106fc8f 100644 --- a/src/webhooks/data/ghes-3.9/schema.json +++ b/src/webhooks/data/ghes-3.9/schema.json @@ -9436,7 +9436,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -10334,7 +10334,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -11230,7 +11230,7 @@ "type": "object", "name": "check_suite", "in": "body", - "description": "The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -14339,7 +14339,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The commit comment resource.
", + "description": "The commit comment resource.
", "isRequired": true, "childParamsGroups": [ { @@ -17774,7 +17774,7 @@ "type": "object", "name": "key", "in": "body", - "description": "The deploy key resource.
The deploy key resource.
The deploy key resource.
The deploy key resource.
The deployment.
", + "description": "The deployment.
", "isRequired": true, "childParamsGroups": [ { @@ -25102,7 +25102,7 @@ "type": "object", "name": "deployment", "in": "body", - "description": "The deployment.
", + "description": "The deployment.
", "isRequired": true, "childParamsGroups": [ { @@ -25832,7 +25832,7 @@ "type": "object", "name": "deployment_status", "in": "body", - "description": "The deployment status.
", + "description": "The deployment status.
", "isRequired": true, "childParamsGroups": [ { @@ -43103,7 +43103,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -43634,7 +43634,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -43688,7 +43688,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -44220,7 +44220,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -44296,7 +44296,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -44828,7 +44828,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -45018,7 +45018,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -46363,7 +46363,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true }, { @@ -46431,7 +46431,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -48098,7 +48098,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -49493,7 +49493,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -51239,7 +51239,7 @@ { "type": "object or null", "name": "old_issue", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -53253,7 +53253,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -54596,7 +54596,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -55997,7 +55997,7 @@ { "type": "object", "name": "new_issue", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -58023,7 +58023,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -59485,7 +59485,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -60830,7 +60830,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -62293,7 +62293,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -73315,7 +73315,7 @@ "type": "object", "name": "build", "in": "body", - "description": "The List GitHub Pages builds itself.
", + "description": "The List GitHub Pages builds itself.
", "isRequired": true, "childParamsGroups": [ { @@ -124913,7 +124913,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -128355,7 +128355,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -131818,7 +131818,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -151710,7 +151710,7 @@ "type": "array of objects", "name": "commits", "in": "body", - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.
An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.
The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -154502,7 +154502,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -155110,7 +155110,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -155803,7 +155803,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -163801,7 +163801,7 @@ "status": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Commit statuses\" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.
", + "summaryHtml": "This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Statuses\" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.
", "bodyParameters": [ { "type": "string or null", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 902b5ad68f..acefeb2865 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "005aa1dea12af0c9c55be923c81916ac089c6236" + "sha": "45ba714d4fde4f522d5cad95427eea033423da8f" } \ No newline at end of file