-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: response schema improvements (#21)
- Loading branch information
1 parent
d7af57a
commit 639908a
Showing
32 changed files
with
4,453 additions
and
2,055 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,7 +11,7 @@ | |
| "termsOfService": "https://docs.github.com/articles/github-terms-of-service", | ||
| "contact": { | ||
| "name": "Support", | ||
| "url": "https://support.github.com" | ||
| "url": "https://support.github.com/contact" | ||
| } | ||
| }, | ||
| "tags": [ | ||
|
|
@@ -2831,31 +2831,7 @@ | |
| } | ||
| }, | ||
| "permissions": { | ||
| "type": "object", | ||
| "properties": { | ||
| "contents": { | ||
| "type": "string" | ||
| }, | ||
| "issues": { | ||
| "type": "string" | ||
| }, | ||
| "deployments": { | ||
| "type": "string" | ||
| }, | ||
| "single_file": { | ||
| "type": "string" | ||
| }, | ||
| "def_not_a_repo": { | ||
| "type": "string", | ||
| "example": "\"read\"" | ||
| } | ||
| }, | ||
| "example": { | ||
| "contents": "read", | ||
| "issues": "read", | ||
| "deployments": "write", | ||
| "single_file": "read" | ||
| } | ||
| "$ref": "#/components/schemas/app-permissions" | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -6254,7 +6230,7 @@ | |
| "/meta": { | ||
| "get": { | ||
| "summary": "Get GitHub Enterprise Server meta information", | ||
| "description": "This endpoint provides a list of GitHub's IP addresses. For more information, see \"[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/).\"", | ||
| "description": "", | ||
| "tags": [ | ||
| "meta" | ||
| ], | ||
|
|
@@ -17690,7 +17666,7 @@ | |
| }, | ||
| "post": { | ||
| "summary": "Create a fork", | ||
| "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://github.com/contact) or [GitHub Enterprise Server Premium Support](https://premium.githubsupport.com).", | ||
| "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact) or [GitHub Enterprise Server Premium Support](https://premium.githubsupport.com).", | ||
| "tags": [ | ||
| "repos" | ||
| ], | ||
|
|
@@ -27241,7 +27217,7 @@ | |
| }, | ||
| "post": { | ||
| "summary": "Upload a release asset", | ||
| "description": "This endpoint makes use of [a Hypermedia relation](https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#hypermedia) 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](https://docs.github.com/[email protected]/rest/reference/repos#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\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](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub 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.\n\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.\n\n**Notes:**\n* GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List assets for a release](https://docs.github.com/[email protected]/rest/reference/repos#list-assets-for-a-release)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://github.com/contact).\n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.", | ||
| "description": "This endpoint makes use of [a Hypermedia relation](https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#hypermedia) 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](https://docs.github.com/[email protected]/rest/reference/repos#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\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](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub 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.\n\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.\n\n**Notes:**\n* GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List assets for a release](https://docs.github.com/[email protected]/rest/reference/repos#list-assets-for-a-release)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact).\n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.", | ||
| "tags": [ | ||
| "repos" | ||
| ], | ||
|
|
@@ -41566,12 +41542,13 @@ | |
| "type": "boolean", | ||
| "example": true | ||
| }, | ||
| "installed_version": { | ||
| "type": "string", | ||
| "example": "2.18.0" | ||
| }, | ||
| "github_services_sha": { | ||
| "type": "string", | ||
| "example": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15" | ||
| }, | ||
| "installed_version": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "required": [ | ||
|
|
@@ -55549,7 +55526,8 @@ | |
| "unread": true, | ||
| "updated_at": "2014-11-07T22:01:45Z", | ||
| "last_read_at": "2014-11-07T22:01:45Z", | ||
| "url": "https://api.github.com/notifications/threads/1" | ||
| "url": "https://api.github.com/notifications/threads/1", | ||
| "subscription_url": "https://api.github.com/notifications/threads/1/subscription" | ||
| } | ||
| ] | ||
| }, | ||
|
|
@@ -55635,7 +55613,8 @@ | |
| "unread": true, | ||
| "updated_at": "2014-11-07T22:01:45Z", | ||
| "last_read_at": "2014-11-07T22:01:45Z", | ||
| "url": "https://api.github.com/notifications/threads/1" | ||
| "url": "https://api.github.com/notifications/threads/1", | ||
| "subscription_url": "https://api.github.com/notifications/threads/1/subscription" | ||
| } | ||
| }, | ||
| "thread-subscription": { | ||
|
|
@@ -61317,22 +61296,25 @@ | |
| "parents": [ | ||
| { | ||
| "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0", | ||
| "sha": "7d1b31e74ee336d15cbd21741bc88a537ed063a0" | ||
| "sha": "7d1b31e74ee336d15cbd21741bc88a537ed063a0", | ||
| "html_url": "https://github.com/octocat/Hello-World/commit/7d1b31e74ee336d15cbd21741bc88a537ed063a0" | ||
| } | ||
| ], | ||
| "verification": { | ||
| "verified": false, | ||
| "reason": "unsigned", | ||
| "signature": null, | ||
| "payload": null | ||
| } | ||
| }, | ||
| "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" | ||
| } | ||
| }, | ||
| "git-commit-2": { | ||
| "value": { | ||
| "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", | ||
| "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", | ||
| "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", | ||
| "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd", | ||
| "author": { | ||
| "date": "2014-11-07T22:01:45Z", | ||
| "name": "Monalisa Octocat", | ||
|
|
@@ -61351,7 +61333,8 @@ | |
| "parents": [ | ||
| { | ||
| "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", | ||
| "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5" | ||
| "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5", | ||
| "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" | ||
| } | ||
| ], | ||
| "verification": { | ||
|
|
@@ -63816,8 +63799,7 @@ | |
| "privacy": "closed", | ||
| "permission": "admin", | ||
| "members_url": "https://api.github.com/teams/1/members{/member}", | ||
| "repositories_url": "https://api.github.com/teams/1/repos", | ||
| "parent": null | ||
| "repositories_url": "https://api.github.com/teams/1/repos" | ||
| } | ||
| ] | ||
| } | ||
|
|
||
Oops, something went wrong.