Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\".
", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see \"About status checks\".
", "childParamsGroups": [ { "type": "string", @@ -144598,7 +144816,7 @@ { "type": "array of objects", "name": "annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\".
", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"About status checks\".
", "childParamsGroups": [ { "type": "string", @@ -210160,6 +210378,7 @@ "description": "A great team.", "privacy": "closed", "permission": "admin", + "notification_setting": "notifications_enabled", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null @@ -211719,6 +211938,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -211835,6 +212057,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -232126,6 +232355,304 @@ } ] } + ], + "sboms": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dependency-graph/sbom", + "title": "Export a software bill of materials (SBOM) for a repository.", + "category": "dependency-graph", + "subcategory": "sboms", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "sbom": { + "SPDXID": "SPDXRef-DOCUMENT", + "spdxVersion": "SPDX-2.3", + "creationInfo": { + "created": "2021-09-01T00:00:00Z", + "creators": [ + "Tool: GitHub.com-Dependency-Graph" + ] + }, + "name": "github/example", + "dataLicense": "CC0-1.0", + "documentDescribes": [ + "github/example" + ], + "documentNamespace": "https://github.com/github/example/dependency_graph/sbom-abcdef123456", + "packages": [ + { + "SPDXID": "SPDXRef-Package", + "name": "rubygems:rails", + "versionInfo": "1.0.0", + "downloadLocation": "NOASSERTION", + "filesAnalyzed": false, + "licenseConcluded": "NOASSERTION", + "licenseDeclared": "NOASSERTION" + } + ] + } + }, + "schema": { + "title": "Dependency Graph SPDX SBOM", + "description": "A schema for the SPDX JSON format returned by the Dependency Graph.", + "type": "object", + "properties": { + "sbom": { + "type": "object", + "properties": { + "SPDXID": { + "type": "string", + "description": "The SPDX identifier for the SPDX document.", + "examples": [ + "SPDXRef-DOCUMENT" + ] + }, + "spdxVersion": { + "type": "string", + "description": "The version of the SPDX specification that this document conforms to.", + "examples": [ + "SPDX-2.3" + ] + }, + "creationInfo": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "The date and time the SPDX document was created.", + "examples": [ + "2021-11-03T00:00:00Z" + ] + }, + "creators": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "description": "The tools that were used to generate the SPDX document." + } + }, + "required": [ + "created", + "creators" + ] + }, + "name": { + "type": "string", + "description": "The name of the SPDX document.", + "examples": [ + "github/github" + ] + }, + "dataLicense": { + "type": "string", + "description": "The license under which the SPDX document is licensed.", + "examples": [ + "CC0-1.0" + ] + }, + "documentDescribes": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "github/github" + ] + }, + "description": "The name of the repository that the SPDX document describes." + }, + "documentNamespace": { + "type": "string", + "description": "The namespace for the SPDX document.", + "examples": [ + "https://github.com/example/dependency_graph/sbom-123" + ] + }, + "packages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "SPDXID": { + "type": "string", + "description": "A unique SPDX identifier for the package.", + "examples": [ + "SPDXRef-Package" + ] + }, + "name": { + "type": "string", + "description": "The name of the package.", + "examples": [ + "rubygems:github/github" + ] + }, + "versionInfo": { + "type": "string", + "description": "The version of the package. If the package does not have an exact version specified,\na version range is given.", + "examples": [ + "1.0.0" + ] + }, + "downloadLocation": { + "type": "string", + "description": "The location where the package can be downloaded,\nor NOASSERTION if this has not been determined.", + "examples": [ + "NOASSERTION" + ] + }, + "filesAnalyzed": { + "type": "boolean", + "description": "Whether the package's file content has been subjected to\nanalysis during the creation of the SPDX document.", + "examples": [ + false + ] + }, + "licenseConcluded": { + "type": "string", + "description": "The license of the package as determined while creating the SPDX document.", + "examples": [ + "MIT" + ] + }, + "licenseDeclared": { + "type": "string", + "description": "The license of the package as declared by its author, or NOASSERTION if this information\nwas not available when the SPDX document was created.", + "examples": [ + "NOASSERTION" + ] + }, + "supplier": { + "type": "string", + "description": "The distribution source of this package, or NOASSERTION if this was not determined.", + "examples": [ + "NOASSERTION" + ] + }, + "externalRefs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "referenceCategory": { + "type": "string", + "description": "The category of reference to an external resource this reference refers to.", + "examples": [ + "PACKAGE-MANAGER" + ] + }, + "referenceLocator": { + "type": "string", + "description": "A locator for the particular external resource this reference refers to.", + "examples": [ + "pkg:gem/rails@6.0.1" + ] + }, + "referenceType": { + "type": "string", + "description": "The category of reference to an external resource this reference refers to.", + "examples": [ + "purl" + ] + } + }, + "required": [ + "referenceCategory", + "referenceLocator", + "referenceType" + ] + } + } + } + }, + "required": [ + "SPDXID", + "name", + "versionInfo", + "downloadLocation", + "filesAnalyzed", + "licenseConcluded", + "licenseDeclared", + "supplier" + ] + } + }, + "required": [ + "SPDXID", + "spdxVersion", + "creationInfo", + "name", + "dataLicense", + "documentDescribes", + "documentNamespace", + "packages" + ] + } + }, + "required": [ + "sbom" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Exports the software bill of materials (SBOM) for a repository in SPDX JSON format.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + } ] }, "deploy-keys": { @@ -235784,6 +236311,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -236137,6 +236665,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -236253,6 +236784,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -236509,6 +237047,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -236848,6 +237387,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -236964,6 +237506,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -237284,6 +237833,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -237623,6 +238173,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -237739,6 +238292,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -299384,6 +299944,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -299500,6 +300063,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -304348,6 +304918,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -304464,6 +305037,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -310312,6 +310892,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -310428,6 +311011,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -311373,6 +311963,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -311489,6 +312082,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -322378,6 +322978,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -322494,6 +323097,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -323439,6 +324049,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -323555,6 +324168,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -332247,8 +332867,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -335580,85 +336198,42 @@ "example": { "verifiable_password_authentication": true, "ssh_key_fingerprints": { - "SHA256_RSA": "uNiVztksCsDhcc0u9e8BujQXVUpKZIDTMczCvj3tD2s", - "SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ", - "SHA256_ECDSA": "p2QAMXNIC1TJYWeIOttrVc98/R1BUFWu3/LiyKgUfQM", - "SHA256_ED25519": "+DiY3wvvV6TuJJhbpZisF/zLDA0zPMSvHdkr4UvCOqU" + "SHA256_RSA": 1234567890, + "SHA256_DSA": 1234567890, + "SHA256_ECDSA": 1234567890, + "SHA256_ED25519": 1234567890 }, "ssh_keys": [ - "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl", - "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBEmKSENjQEezOmxkZMy7opKgwFB9nkt5YRrYMjNuG5N87uRgg6CLrbo5wAdT/y6v0mKV0U2w0WZ2YB/++Tpockg=", - "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCj7ndNxQowgcQnjshcLrqPEiiphnt+VTTvDP6mHBL9j1aNUkY4Ue1gvwnGLVlOhGeYrnZaMgRK6+PKCUXaDbC7qtbW8gIkhL7aGCsOr/C56SJMy/BCZfxd1nWzAOxSDPgVsmerOBYfNqltV9/hWCqBywINIR+5dIg6JTJ72pcEpEjcYgXkE2YEFXV1JHnsKgbLWNlhScqb2UmyRkQyytRLtL+38TGxkxCflmO+5Z8CSSNY7GidjMIZ7Q4zMjA2n1nGrlTDkzwDCsw+wqFPGQA179cnfGWOWRVruj16z6XyvxvjJwbz0wQZ75XK5tKSb7FNyeIEs4TT4jk+S4dhPeAUC5y+bDYirYgM4GC7uEnztnZyaVWQ7B381AK4Qdrwt51ZqExKbQpTUNn+EjqoTwvqNj4kqx5QUCI0ThS/YkOxJCXmPUWZbhjpCg56i+2aB6CmK2JGhn57K5mj0MNdBXA4/WnwH6XoPWJzK5Nyu2zB3nAZp+S5hpQs+p1vN1/wsjk=" + "ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ", + "ecdsa-sha2-nistp256 ABCDEFGHIJKLMNOPQRSTUVWXYZ", + "ssh-rsa ABCDEFGHIJKLMNOPQRSTUVWXYZ" ], "hooks": [ - "192.30.252.0/22", - "185.199.108.0/22", - "140.82.112.0/20", - "143.55.64.0/20", - "2a0a:a440::/29", - "2606:50c0::/32" + "192.0.2.1" ], "web": [ - "192.30.252.0/22", - "185.199.108.0/22", - "140.82.112.0/20", - "143.55.64.0/20", - "2a0a:a440::/29", - "2606:50c0::/32", - "20.201.28.151/32", - "20.205.243.166/32", - "102.133.202.242/32" + "192.0.2.1" ], "api": [ - "192.30.252.0/22", - "185.199.108.0/22", - "140.82.112.0/20", - "143.55.64.0/20", - "2a0a:a440::/29", - "2606:50c0::/32", - "20.201.28.148/32" + "192.0.2.1" ], "git": [ - "192.30.252.0/22", - "185.199.108.0/22", - "140.82.112.0/20", - "143.55.64.0/20", - "2a0a:a440::/29", - "2606:50c0::/32" + "192.0.2.1" ], "packages": [ - "140.82.121.33/32", - "192.30.255.164/31", - "20.200.245.241/32", - "20.233.54.55/32" + "192.0.2.1" ], "pages": [ - "192.30.252.153/32", - "192.30.252.154/32", - "185.199.108.153/32", - "185.199.109.153/32", - "185.199.110.153/32", - "185.199.111.153/32", - "2606:50c0:8000::153/128", - "2606:50c0:8001::153/128", - "2606:50c0:8002::153/128", - "2606:50c0:8003::153/128" + "192.0.2.1" ], "importer": [ - "52.23.85.212/32", - "52.0.228.224/32", - "52.22.155.48/32" + "192.0.2.1" ], "actions": [ - "4.148.0.0/16", - "13.67.153.64/26", - "2603:1030:804:220::/61", - "2603:1036:2500:10::/64" + "192.0.2.1" ], "dependabot": [ - "18.213.123.130/32", - "3.217.79.163/32", - "3.217.93.44/32" + "192.0.2.1" ] }, "schema": { @@ -335695,7 +336270,7 @@ "type": "string" }, "examples": [ - "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl" + "ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ" ] }, "hooks": { @@ -335704,7 +336279,7 @@ "type": "string" }, "examples": [ - "127.0.0.1/32" + "192.0.2.1" ] }, "web": { @@ -335713,7 +336288,7 @@ "type": "string" }, "examples": [ - "127.0.0.1/32" + "192.0.2.1" ] }, "api": { @@ -335722,7 +336297,7 @@ "type": "string" }, "examples": [ - "127.0.0.1/32" + "192.0.2.1" ] }, "git": { @@ -335731,7 +336306,7 @@ "type": "string" }, "examples": [ - "127.0.0.1/32" + "192.0.2.1" ] }, "packages": { @@ -335740,9 +336315,7 @@ "type": "string" }, "examples": [ - "13.65.0.0/16", - "157.55.204.33/32", - "2a01:111:f403:f90c::/62" + "192.0.2.1" ] }, "pages": { @@ -335751,8 +336324,7 @@ "type": "string" }, "examples": [ - "192.30.252.153/32", - "192.30.252.154/32" + "192.0.2.1" ] }, "importer": { @@ -335761,8 +336333,7 @@ "type": "string" }, "examples": [ - "54.158.161.132", - "54.226.70.38" + "192.0.2.1" ] }, "actions": { @@ -335771,8 +336342,7 @@ "type": "string" }, "examples": [ - "13.64.0.0/16", - "13.65.0.0/16" + "192.0.2.1" ] }, "dependabot": { @@ -335781,8 +336351,7 @@ "type": "string" }, "examples": [ - "192.168.7.15/32", - "192.168.7.16/32" + "192.0.2.1" ] } }, @@ -335794,7 +336363,7 @@ } ], "previews": [], - "descriptionHTML": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
\nNote: This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.
\nNote: The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses.
", + "descriptionHTML": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
\nThe values shown in the documentation's response are example values. You must always query the API directly to get the latest values.
\nNote: This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.
", "statusCodes": [ { "httpStatusCode": "200", @@ -354119,8 +354688,8 @@ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/organizations/{org}/personal-access-token-requests", - "title": "List requests to access organization resources with fine-grained personal access tokens", + "requestPath": "/orgs/{org}", + "title": "Get an organization", "category": "orgs", "subcategory": "orgs", "parameters": [ @@ -354132,111 +354701,6 @@ "schema": { "type": "string" } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page number of the results to fetch.
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "sort", - "description": "The property by which to sort the results.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created_at" - ], - "default": "created_at" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "owner", - "description": "A list of owner usernames to use to filter the results.
", - "in": "query", - "required": false, - "schema": { - "type": "array", - "maxItems": 10, - "items": { - "type": "string" - }, - "examples": [ - "owner[]=octocat1,owner[]=octocat2" - ] - } - }, - { - "name": "repository", - "description": "The name of the repository to use to filter the results.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "Hello-World" - ] - } - }, - { - "name": "permission", - "description": "The permission to use to filter the results.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "issues_read" - ] - } - }, - { - "name": "last_used_before", - "description": "Only show fine-grained personal access tokens used before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only show fine-grained personal access tokens used after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
", - "example": [ - { - "id": 25381, - "reason": "I need to access the GitHub API", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "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", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true + "example": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "github", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "type": "Organization", + "total_private_repos": 100, + "owned_private_repos": 100, + "private_gists": 81, + "disk_usage": 10000, + "collaborators": 8, + "billing_email": "mona@github.com", + "plan": { + "name": "Medium", + "space": 400, + "private_repos": 20, + "filled_seats": 4, + "seats": 5 + }, + "default_repository_permission": "read", + "members_can_create_repositories": true, + "two_factor_requirement_enabled": true, + "members_allowed_repository_creation_type": "all", + "members_can_create_public_repositories": false, + "members_can_create_private_repositories": false, + "members_can_create_internal_repositories": false, + "members_can_create_pages": true, + "members_can_create_public_pages": true, + "members_can_create_private_pages": true, + "members_can_fork_private_repositories": false, + "web_commit_signoff_required": false, + "updated_at": "2014-03-03T18:58:10Z", + "dependency_graph_enabled_for_new_repositories": false, + "dependabot_alerts_enabled_for_new_repositories": false, + "dependabot_security_updates_enabled_for_new_repositories": false, + "advanced_security_enabled_for_new_repositories": false, + "secret_scanning_enabled_for_new_repositories": false, + "secret_scanning_push_protection_enabled_for_new_repositories": false, + "secret_scanning_push_protection_custom_link": false, + "secret_scanning_push_protection_custom_link_enabled": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md" + }, + "schema": { + "title": "Organization Full", + "description": "Organization Full", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] }, - "repository_selection": "all", - "repositories_url": "https://api.github.com/organizations/652551/personal-access-token-requests/25381/repositories", - "permissions": { - "organization": { - "members": "read" - }, - "repository": { - "metadata": "read" - } + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "created_at": "2023-05-16T08:47:09.000-07:00", - "token_expired": false, - "token_expires_at": "2023-11-16T08:47:09.000-07:00", - "token_last_used_at": null - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple Organization Programmatic Access Grant Request", - "description": "Minimal representation of an organization programmatic access grant request for enumerations", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests." - }, - "reason": { - "type": [ - "string", - "null" - ], - "description": "Reason for requesting access." - }, - "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\"" - ] - } + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" }, - "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" - ] - }, - "repository_selection": { - "type": "string", - "enum": [ - "none", - "all", - "subset" - ], - "description": "Type of repository selection requested." - }, - "repositories_url": { - "type": "string", - "description": "URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`." - }, - "permissions": { - "type": "object", - "description": "Permissions requested, categorized by type of permission.", - "properties": { - "organization": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "repository": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "other": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" } }, - "created_at": { - "type": "string", - "description": "Date and time when the request for access was created." - }, - "token_expired": { - "type": "boolean", - "description": "Whether the associated fine-grained personal access token has expired." - }, - "token_expires_at": { - "type": [ - "string", - "null" - ], - "description": "Date and time when the associated fine-grained personal access token expires." - }, - "token_last_used_at": { - "type": [ - "string", - "null" - ], - "description": "Date and time when the associated fine-grained personal access token was last used for authentication." - } + "required": [ + "name", + "space", + "private_repos" + ] }, - "required": [ - "id", - "reason", - "owner", - "repository_selection", - "repositories_url", - "permissions", - "created_at", - "token_expired", - "token_expires_at", - "token_last_used_at" - ] - } + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at" + ] } } } ], "previews": [], - "descriptionHTML": "Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API,\nusing the organization_personal_access_token_requests: read permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", + "descriptionHTML": "To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.
GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub plan. See \"Authenticating with GitHub Apps\" for details. For an example response, see 'Response with GitHub plan information' below.\"
OK
" }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, { "httpStatusCode": "404", "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/organizations/{org}/personal-access-token-requests", - "title": "Review requests to access organization resources with fine-grained personal access tokens", + "verb": "patch", + "requestPath": "/orgs/{org}", + "title": "Update an organization", "category": "orgs", "subcategory": "orgs", "parameters": [ @@ -354596,3386 +355249,28 @@ ], "bodyParameters": [ { - "type": "array of integers", - "name": "pat_request_ids", + "type": "string", + "name": "billing_email", "in": "body", - "description": "Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 pat_request_id values.
Billing email address. This address is not publicized.
" }, { "type": "string", - "name": "action", + "name": "company", "in": "body", - "description": "Action to apply to the requests.
", - "isRequired": true, - "enum": [ - "approve", - "deny" - ] + "description": "The company name.
" }, { - "type": "string or null", - "name": "reason", + "type": "string", + "name": "email", "in": "body", - "description": "Reason for approving or denying the requests. Max 1024 characters.
" - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "204", - "request": { - "contentType": "application/json", - "description": "Example of denying a request", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "pat_request_ids": [ - 42, - 73 - ], - "action": "deny", - "reason": "Access is too broad." - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "Accepted
", - "example": null, - "schema": { - "type": "object" - } - } - } - ], - "previews": [], - "descriptionHTML": "Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API,\nusing the organization_personal_access_token_requests: write permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "Accepted
" + "description": "The publicly visible email address.
" }, { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/organizations/{org}/personal-access-token-requests/{pat_request_id}", - "title": "Review a request to access organization resources with a fine-grained personal access token", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pat_request_id", - "in": "path", - "description": "Unique identifier of the request for access via fine-grained personal access token.
", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "Action to apply to the request.
", - "isRequired": true, - "enum": [ - "approve", - "deny" - ] - }, - { - "type": "string or null", - "name": "reason", - "in": "body", - "description": "Reason for approving or denying the request. Max 1024 characters.
" - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "204", - "request": { - "contentType": "application/json", - "description": "Example of denying a request", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "action": "deny", - "reason": "This request is denied because the access is too broad." - }, - "parameters": { - "org": "ORG", - "pat_request_id": "PAT_REQUEST_ID" - } - }, - "response": { - "statusCode": "204", - "description": "A header with no content is returned.
" - } - } - ], - "previews": [], - "descriptionHTML": "Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API,\nusing the organization_personal_access_token_requests: write permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "A header with no content is returned.
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/organizations/{org}/personal-access-token-requests/{pat_request_id}/repositories", - "title": "List repositories requested to be accessed by a fine-grained personal access token", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pat_request_id", - "in": "path", - "description": "Unique identifier of the request for access via fine-grained personal access token.
", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page number of the results to fetch.
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "pat_request_id": "PAT_REQUEST_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "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 - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - } - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API,\nusing the organization_personal_access_token_requests: read permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/organizations/{org}/personal-access-tokens", - "title": "List fine-grained personal access tokens with access to organization resources", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page number of the results to fetch.
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "sort", - "description": "The property by which to sort the results.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created_at" - ], - "default": "created_at" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "owner", - "description": "A list of owner usernames to use to filter the results.
", - "in": "query", - "required": false, - "schema": { - "type": "array", - "maxItems": 10, - "items": { - "type": "string" - }, - "examples": [ - "owner[]=octocat1,owner[]=octocat2" - ] - } - }, - { - "name": "repository", - "description": "The name of the repository to use to filter the results.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "Hello-World" - ] - } - }, - { - "name": "permission", - "description": "The permission to use to filter the results.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "issues_read" - ] - } - }, - { - "name": "last_used_before", - "description": "Only show fine-grained personal access tokens used before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only show fine-grained personal access tokens used after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
", - "example": [ - { - "id": 25381, - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "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", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "repository_selection": "all", - "repositories_url": "https://api.github.com/organizations/652551/personal-access-tokens/25381/repositories", - "permissions": { - "organization": { - "members": "read" - }, - "repository": { - "metadata": "read" - } - }, - "access_granted_at": "2023-05-16T08:47:09.000-07:00", - "token_expired": false, - "token_expires_at": "2023-11-16T08:47:09.000-07:00", - "token_last_used_at": null - } - ], - "schema": { - "type": "array", - "items": { - "title": "Organization Programmatic Access Grant", - "description": "Minimal representation of an organization programmatic access grant for enumerations", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token." - }, - "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" - ] - }, - "repository_selection": { - "type": "string", - "enum": [ - "none", - "all", - "subset" - ], - "description": "Type of repository selection requested." - }, - "repositories_url": { - "type": "string", - "description": "URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`." - }, - "permissions": { - "type": "object", - "description": "Permissions requested, categorized by type of permission.", - "properties": { - "organization": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "repository": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "other": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "access_granted_at": { - "type": "string", - "description": "Date and time when the fine-grained personal access token was approved to access the organization." - }, - "token_expired": { - "type": "boolean", - "description": "Whether the associated fine-grained personal access token has expired." - }, - "token_expires_at": { - "type": [ - "string", - "null" - ], - "description": "Date and time when the associated fine-grained personal access token expires." - }, - "token_last_used_at": { - "type": [ - "string", - "null" - ], - "description": "Date and time when the associated fine-grained personal access token was last used for authentication." - } - }, - "required": [ - "id", - "owner", - "repository_selection", - "repositories_url", - "permissions", - "access_granted_at", - "token_expired", - "token_expires_at", - "token_last_used_at" - ] - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API,\nusing the organization_personal_access_tokens: read permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/organizations/{org}/personal-access-tokens", - "title": "Update the access to organization resources via fine-grained personal access tokens", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "Action to apply to the fine-grained personal access token.
", - "isRequired": true, - "enum": [ - "revoke" - ] - }, - { - "type": "array of integers", - "name": "pat_ids", - "in": "body", - "description": "The IDs of the fine-grained personal access tokens.
", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "204", - "request": { - "contentType": "application/json", - "description": "Example of revoking a fine-grained personal access token.", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "action": "revoke", - "pat_ids": [ - 1296269, - 1296280 - ] - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "Accepted
", - "example": null, - "schema": { - "type": "object" - } - } - } - ], - "previews": [], - "descriptionHTML": "Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API,\nusing the organization_personal_access_tokens: write permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "Accepted
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/organizations/{org}/personal-access-tokens/{pat_id}", - "title": "Update the access a fine-grained personal access token has to organization resources", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pat_id", - "description": "The unique identifier of the fine-grained personal access token.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "Action to apply to the fine-grained personal access token.
", - "isRequired": true, - "enum": [ - "revoke" - ] - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "204", - "request": { - "contentType": "application/json", - "description": "Example of revoking a fine-grained personal access token.", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "action": "revoke" - }, - "parameters": { - "org": "ORG", - "pat_id": "PAT_ID" - } - }, - "response": { - "statusCode": "204", - "description": "A header with no content is returned.
" - } - } - ], - "previews": [], - "descriptionHTML": "Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API,\nusing the organization_personal_access_tokens: write permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "A header with no content is returned.
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/organizations/{org}/personal-access-tokens/{pat_id}/repositories", - "title": "List repositories a fine-grained personal access token has access to", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pat_id", - "in": "path", - "description": "Unique identifier of the fine-grained personal access token.
", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page number of the results to fetch.
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "pat_id": "PAT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "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 - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - } - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API,\nusing the organization_personal_access_tokens: read permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}", - "title": "Get an organization", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "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": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "type": "Organization", - "total_private_repos": 100, - "owned_private_repos": 100, - "private_gists": 81, - "disk_usage": 10000, - "collaborators": 8, - "billing_email": "mona@github.com", - "plan": { - "name": "Medium", - "space": 400, - "private_repos": 20, - "filled_seats": 4, - "seats": 5 - }, - "default_repository_permission": "read", - "members_can_create_repositories": true, - "two_factor_requirement_enabled": true, - "members_allowed_repository_creation_type": "all", - "members_can_create_public_repositories": false, - "members_can_create_private_repositories": false, - "members_can_create_internal_repositories": false, - "members_can_create_pages": true, - "members_can_create_public_pages": true, - "members_can_create_private_pages": true, - "members_can_fork_private_repositories": false, - "web_commit_signoff_required": false, - "updated_at": "2014-03-03T18:58:10Z", - "dependency_graph_enabled_for_new_repositories": false, - "dependabot_alerts_enabled_for_new_repositories": false, - "dependabot_security_updates_enabled_for_new_repositories": false, - "advanced_security_enabled_for_new_repositories": false, - "secret_scanning_enabled_for_new_repositories": false, - "secret_scanning_push_protection_enabled_for_new_repositories": false, - "secret_scanning_push_protection_custom_link": false, - "secret_scanning_push_protection_custom_link_enabled": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md" - }, - "schema": { - "title": "Organization Full", - "description": "Organization Full", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ] - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ] - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ] - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ] - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ] - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ] - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", - "examples": [ - false - ] - }, - "secret_scanning_push_protection_custom_link": { - "type": [ - "string", - "null" - ], - "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", - "examples": [ - "https://github.com/test-org/test-repo/blob/main/README.md" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.
GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub plan. See \"Authenticating with GitHub Apps\" for details. For an example response, see 'Response with GitHub plan information' below.\"
OK
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "patch", - "requestPath": "/orgs/{org}", - "title": "Update an organization", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "billing_email", - "in": "body", - "description": "Billing email address. This address is not publicized.
" - }, - { - "type": "string", - "name": "company", - "in": "body", - "description": "The company name.
" - }, - { - "type": "string", - "name": "email", - "in": "body", - "description": "The publicly visible email address.
" - }, - { - "type": "string", - "name": "twitter_username", - "in": "body", - "description": "The Twitter username of the company.
" + "type": "string", + "name": "twitter_username", + "in": "body", + "description": "The Twitter username of the company.
" }, { "type": "string", @@ -361264,38 +358559,1050 @@ "url" ] }, - "team_count": { - "type": "integer" - }, - "node_id": { + "team_count": { + "type": "integer" + }, + "node_id": { + "type": "string", + "examples": [ + "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + ] + }, + "invitation_teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/organizations/16/invitations/1/teams\"" + ] + }, + "invitation_source": { + "type": "string", + "examples": [ + "\"member\"" + ] + } + }, + "required": [ + "id", + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, or hiring_manager. If the invitee is not a GitHub member, the login field in the return hash will be null.
OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/invitations", + "title": "Create an organization invitation", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "integer", + "name": "invitee_id", + "in": "body", + "description": "Required unless you provide email. GitHub user ID for the person you are inviting.
Required unless you provide invitee_id. Email address of the person you are inviting, which can be an existing GitHub user.
The role for the new member.
\nadmin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. direct_member - Non-owner organization members with ability to see other members and join teams by invitation. billing_manager - Non-owner organization members with ability to manage the billing settings of your organization.Specify IDs for the teams you want to invite new members to.
" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "email": "octocat@github.com", + "role": "direct_member", + "team_ids": [ + 12, + 26 + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response
", + "example": { + "id": 1, + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "inviter": { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + }, + "team_count": 2, + "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", + "invitation_source": "member" + }, + "schema": { + "title": "Organization Invitation", + "description": "Organization Invitation", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": [ + "string", + "null" + ] + }, + "failed_reason": { + "type": [ + "string", + "null" + ] + }, + "inviter": { + "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" + ] + }, + "team_count": { + "type": "integer" + }, + "node_id": { + "type": "string", + "examples": [ + "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + ] + }, + "invitation_teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/organizations/16/invitations/1/teams\"" + ] + }, + "invitation_source": { + "type": "string", + "examples": [ + "\"member\"" + ] + } + }, + "required": [ + "id", + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.
\nThis 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.
", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "Created
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/invitations/{invitation_id}", + "title": "Cancel an organization invitation", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "invitation_id", + "description": "The unique identifier of the invitation.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "invitation_id": "INVITATION_ID" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.
\nThis endpoint triggers notifications.
", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/invitations/{invitation_id}/teams", + "title": "List organization invitation teams", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "invitation_id", + "description": "The unique identifier of the invitation.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "invitation_id": "INVITATION_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "schema": { + "type": "array", + "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" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/members", + "title": "List organization members", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. This options is only available for organization owners.
Filter members returned by their role.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "admin", + "member" + ], + "default": "all" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "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": [ + { + "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 + } + ], + "schema": { + "type": "array", + "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": [ - "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + "https://api.github.com/users/octocat/received_events" ] }, - "invitation_teams_url": { + "type": { "type": "string", "examples": [ - "\"https://api.github.com/organizations/16/invitations/1/teams\"" + "User" ] }, - "invitation_source": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", "examples": [ - "\"member\"" + "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", + "node_id", "login", - "email", - "role", - "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } } @@ -361303,23 +359610,23 @@ } ], "previews": [], - "descriptionHTML": "The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, or hiring_manager. If the invitee is not a GitHub member, the login field in the return hash will be null.
List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { - "httpStatusCode": "404", - "description": "Resource not found
" + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" } ] }, { "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/orgs/{org}/invitations", - "title": "Create an organization invitation", + "verb": "get", + "requestPath": "/orgs/{org}/members/{username}", + "title": "Check organization membership for a user", "category": "orgs", "subcategory": "members", "parameters": [ @@ -361331,154 +359638,247 @@ "schema": { "type": "string" } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], - "bodyParameters": [ + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ { - "type": "integer", - "name": "invitee_id", - "in": "body", - "description": "Required unless you provide email. GitHub user ID for the person you are inviting.
Response if requester is an organization member and user is a member
" + } + } + ], + "previews": [], + "descriptionHTML": "Check if a user is, publicly or privately, a member of the organization.
", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "Response if requester is an organization member and user is a member
" }, { - "type": "string", - "name": "email", - "in": "body", - "description": "Required unless you provide invitee_id. Email address of the person you are inviting, which can be an existing GitHub user.
Response if requester is not an organization member
" }, { - "type": "string", - "name": "role", - "in": "body", - "description": "The role for the new member.
\nadmin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. direct_member - Non-owner organization members with ability to see other members and join teams by invitation. billing_manager - Non-owner organization members with ability to manage the billing settings of your organization.Not Found if requester is an organization member and user is not a member
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/members/{username}", + "title": "Remove an organization member", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "type": "array of integers", - "name": "team_ids", - "in": "body", - "description": "Specify IDs for the teams you want to invite new members to.
" + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], + "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "email": "octocat@github.com", - "role": "direct_member", - "team_ids": [ - 12, - 26 - ] - }, "parameters": { - "org": "ORG" + "org": "ORG", + "username": "USERNAME" } }, "response": { - "statusCode": "201", + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/memberships/{username}", + "title": "Get organization membership for a user", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "200", "contentType": "application/json", - "description": "Response
", + "description": "Response if user has an active admin membership with organization
", "example": { - "id": 1, - "login": "monalisa", - "node_id": "MDQ6VXNlcjE=", - "email": "octocat@github.com", - "role": "direct_member", - "created_at": "2016-11-30T06:46:10-08:00", - "inviter": { - "login": "other_user", + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "admin", + "organization_url": "https://api.github.com/orgs/octocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { + "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", + "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 - }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" + } }, "schema": { - "title": "Organization Invitation", - "description": "Organization Invitation", + "title": "Org Membership", + "description": "Org Membership", "type": "object", "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": [ - "string", - "null" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/memberships/defunkt" ] }, - "email": { - "type": [ - "string", - "null" + "state": { + "type": "string", + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "enum": [ + "active", + "pending" + ], + "examples": [ + "active" ] }, "role": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "failed_at": { - "type": [ - "string", - "null" + "type": "string", + "description": "The user's membership type in the organization.", + "enum": [ + "admin", + "member", + "billing_manager" + ], + "examples": [ + "admin" ] }, - "failed_reason": { - "type": [ - "string", - "null" + "organization_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat" ] }, - "inviter": { - "title": "Simple User", - "description": "A GitHub user.", + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, "login": { "type": "string", "examples": [ - "octocat" + "github" ] }, "id": { @@ -361490,182 +359890,737 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, - "avatar_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "https://api.github.com/orgs/github" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "repos_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "https://api.github.com/orgs/github/repos" ] }, - "url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/orgs/github/events" ] }, - "html_url": { + "hooks_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/orgs/github/hooks" ] }, - "followers_url": { + "issues_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "https://api.github.com/orgs/github/issues" ] }, - "following_url": { + "members_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "https://api.github.com/orgs/github/members{/member}" ] }, - "gists_url": { + "public_members_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "https://api.github.com/orgs/github/public_members{/member}" ] }, - "starred_url": { + "avatar_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "https://github.com/images/error/octocat_happy.gif" ] }, - "subscriptions_url": { + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "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" + ] + } + ] + }, + "permissions": { + "type": "object", + "properties": { + "can_create_repository": { + "type": "boolean" + } + }, + "required": [ + "can_create_repository" + ] + } + }, + "required": [ + "state", + "role", + "organization_url", + "url", + "organization", + "user" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.
OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/memberships/{username}", + "title": "Set organization membership for a user", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "role", + "in": "body", + "description": "The role to give the user in the organization. Can be one of:
\nadmin - The user will become an owner of the organization. member - The user will become a non-owner member of the organization.Response if user has an active admin membership with organization
", + "example": { + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "admin", + "organization_url": "https://api.github.com/orgs/octocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "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 + } + }, + "schema": { + "title": "Org Membership", + "description": "Org Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/memberships/defunkt" + ] + }, + "state": { + "type": "string", + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "enum": [ + "active", + "pending" + ], + "examples": [ + "active" + ] + }, + "role": { + "type": "string", + "description": "The user's membership type in the organization.", + "enum": [ + "admin", + "member", + "billing_manager" + ], + "examples": [ + "admin" + ] + }, + "organization_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "github" ] }, - "organizations_url": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "https://api.github.com/orgs/github/events" ] }, - "received_events_url": { + "hooks_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "https://api.github.com/orgs/github/hooks" ] }, - "type": { + "issues_url": { "type": "string", "examples": [ - "User" + "https://api.github.com/orgs/github/issues" ] }, - "site_admin": { - "type": "boolean" + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] }, - "starred_at": { + "public_members_url": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", + "login", + "url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "team_count": { - "type": "integer" - }, - "node_id": { - "type": "string", - "examples": [ - "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] }, - "invitation_teams_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/organizations/16/invitations/1/teams\"" + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "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" + ] + } ] }, - "invitation_source": { - "type": "string", - "examples": [ - "\"member\"" + "permissions": { + "type": "object", + "properties": { + "can_create_repository": { + "type": "boolean" + } + }, + "required": [ + "can_create_repository" ] } }, "required": [ - "id", - "login", - "email", + "state", "role", - "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" + "organization_url", + "url", + "organization", + "user" ] } } } ], "previews": [], - "descriptionHTML": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.
\nThis 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.
", + "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", "statusCodes": [ { - "httpStatusCode": "201", - "description": "Created
" + "httpStatusCode": "200", + "description": "OK
" }, { - "httpStatusCode": "404", - "description": "Resource not found
" + "httpStatusCode": "403", + "description": "Forbidden
" }, { "httpStatusCode": "422", @@ -361676,8 +360631,8 @@ { "serverUrl": "https://api.github.com", "verb": "delete", - "requestPath": "/orgs/{org}/invitations/{invitation_id}", - "title": "Cancel an organization invitation", + "requestPath": "/orgs/{org}/memberships/{username}", + "title": "Remove organization membership for a user", "category": "orgs", "subcategory": "members", "parameters": [ @@ -361691,12 +360646,12 @@ } }, { - "name": "invitation_id", - "description": "The unique identifier of the invitation.
", + "name": "username", + "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], @@ -361710,7 +360665,7 @@ "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", - "invitation_id": "INVITATION_ID" + "username": "USERNAME" } }, "response": { @@ -361720,312 +360675,15 @@ } ], "previews": [], - "descriptionHTML": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.
\nThis endpoint triggers notifications.
", + "descriptionHTML": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/invitations/{invitation_id}/teams", - "title": "List organization invitation teams", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "invitation_id", - "description": "The unique identifier of the invitation.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page number of the results to fetch.
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "invitation_id": "INVITATION_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "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 - } - ], - "schema": { - "type": "array", - "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" - }, - "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" - ] - }, - "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" - ] - } - } - } - } - ], - "previews": [], - "descriptionHTML": "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" + "httpStatusCode": "403", + "description": "Forbidden
" }, { "httpStatusCode": "404", @@ -362036,8 +360694,8 @@ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/members", - "title": "List organization members", + "requestPath": "/orgs/{org}/public_members", + "title": "List public organization members", "category": "orgs", "subcategory": "members", "parameters": [ @@ -362050,35 +360708,6 @@ "type": "string" } }, - { - "name": "filter", - "description": "Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. This options is only available for organization owners.
Filter members returned by their role.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "admin", - "member" - ], - "default": "all" - } - }, { "name": "per_page", "description": "The number of results per page (max 100).
", @@ -362268,181 +360897,724 @@ "User" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "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" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Members of an organization can choose to have their membership publicized or not.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/public_members/{username}", + "title": "Check public organization membership for a user", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "204", + "description": "Response if user is a public member
" + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "Response if user is a public member
" + }, + { + "httpStatusCode": "404", + "description": "Not Found if user is not a public member
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/public_members/{username}", + "title": "Set public organization membership for the authenticated user", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
No Content
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/public_members/{username}", + "title": "Remove public organization membership for the authenticated user", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/user/memberships/orgs", + "title": "List organization memberships for the authenticated user", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "state", + "description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "active", + "pending" + ] + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "admin", + "organization_url": "https://api.github.com/orgs/octocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "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 + } + }, + { + "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", + "state": "pending", + "role": "admin", + "organization_url": "https://api.github.com/orgs/invitocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "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 + } + } + ], + "schema": { + "type": "array", + "items": { + "title": "Org Membership", + "description": "Org Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/memberships/defunkt" + ] + }, + "state": { + "type": "string", + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "enum": [ + "active", + "pending" + ], + "examples": [ + "active" + ] + }, + "role": { + "type": "string", + "description": "The user's membership type in the organization.", + "enum": [ + "admin", + "member", + "billing_manager" + ], + "examples": [ + "admin" + ] + }, + "organization_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "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" + ] + } + ] + }, + "permissions": { + "type": "object", + "properties": { + "can_create_repository": { + "type": "boolean" + } + }, + "required": [ + "can_create_repository" ] } }, "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" + "state", + "role", + "organization_url", + "url", + "organization", + "user" ] } } } } ], + "descriptionHTML": "", "previews": [], - "descriptionHTML": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/members/{username}", - "title": "Check organization membership for a user", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "204", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "Response if requester is an organization member and user is a member
" - } - } - ], - "previews": [], - "descriptionHTML": "Check if a user is, publicly or privately, a member of the organization.
", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "Response if requester is an organization member and user is a member
" - }, - { - "httpStatusCode": "302", - "description": "Response if requester is not an organization member
" - }, - { - "httpStatusCode": "404", - "description": "Not Found if requester is an organization member and user is not a member
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/orgs/{org}/members/{username}", - "title": "Remove an organization member", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "httpStatusCode": "304", + "description": "Not modified
" }, { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" - } - } - ], - "previews": [], - "descriptionHTML": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" + "httpStatusCode": "401", + "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/memberships/{username}", - "title": "Get organization membership for a user", + "requestPath": "/user/memberships/orgs/{org}", + "title": "Get an organization membership for the authenticated user", "category": "orgs", "subcategory": "members", "parameters": [ @@ -362454,19 +361626,10 @@ "schema": { "type": "string" } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "bodyParameters": [], - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", @@ -362474,19 +361637,18 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG", - "username": "USERNAME" + "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user has an active admin membership with organization
", + "description": "Response
", "example": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", + "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", + "state": "pending", "role": "admin", - "organization_url": "https://api.github.com/orgs/octocat", + "organization_url": "https://api.github.com/orgs/invitocat", "organization": { "login": "github", "id": 1, @@ -362855,8 +362017,8 @@ } } ], + "descriptionHTML": "", "previews": [], - "descriptionHTML": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.
The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "bodyParameters": [ { "type": "string", - "name": "role", + "name": "state", "in": "body", - "description": "The role to give the user in the organization. Can be one of:
\nadmin - The user will become an owner of the organization. member - The user will become a non-owner member of the organization.The state that the membership should be in. Only \"active\" will be accepted.
Response if user has an active admin membership with organization
", + "description": "Response
", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -363258,55 +362409,941 @@ ] } }, - "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" - ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "can_create_repository": { - "type": "boolean" + "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" + ] + } + ] + }, + "permissions": { + "type": "object", + "properties": { + "can_create_repository": { + "type": "boolean" + } + }, + "required": [ + "can_create_repository" + ] + } + }, + "required": [ + "state", + "role", + "organization_url", + "url", + "organization", + "user" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + } + ], + "outside-collaborators": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/outside_collaborators", + "title": "List outside collaborators for an organization", + "category": "orgs", + "subcategory": "outside-collaborators", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned.
The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "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": [ + { + "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 + } + ], + "schema": { + "type": "array", + "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" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "List all users who are outside collaborators of an organization.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/outside_collaborators/{username}", + "title": "Convert an organization member to outside collaborator", + "category": "orgs", + "subcategory": "outside-collaborators", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "boolean", + "name": "async", + "in": "body", + "description": "When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.
User is getting converted asynchronously
", + "example": null, + "schema": { + "type": "object", + "properties": {}, + "additionalProperties": false + } + } + }, + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Status code 204, synchronous request", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": null, + "parameters": { + "org": "ORG", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "204", + "description": "User was converted
" + } + } + ], + "previews": [], + "descriptionHTML": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
", + "statusCodes": [ + { + "httpStatusCode": "202", + "description": "User is getting converted asynchronously
" + }, + { + "httpStatusCode": "204", + "description": "User was converted
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"Enforcing repository management policies in your enterprise.\"
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/outside_collaborators/{username}", + "title": "Remove outside collaborator from an organization", + "category": "orgs", + "subcategory": "outside-collaborators", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Removing a user from this list will remove them from all the organization's repositories.
", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "422", + "description": "Unprocessable Entity if user is a member of the organization
" + } + ] + } + ], + "personal-access-tokens": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/organizations/{org}/personal-access-token-requests", + "title": "List requests to access organization resources with fine-grained personal access tokens", + "category": "orgs", + "subcategory": "personal-access-tokens", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created_at" + ], + "default": "created_at" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "owner", + "description": "A list of owner usernames to use to filter the results.
", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 10, + "items": { + "type": "string" + }, + "examples": [ + "owner[]=octocat1,owner[]=octocat2" + ] + } + }, + { + "name": "repository", + "description": "The name of the repository to use to filter the results.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "examples": [ + "Hello-World" + ] + } + }, + { + "name": "permission", + "description": "The permission to use to filter the results.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "examples": [ + "issues_read" + ] + } + }, + { + "name": "last_used_before", + "description": "Only show fine-grained personal access tokens used before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only show fine-grained personal access tokens used after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
", + "example": [ + { + "id": 25381, + "reason": "I need to access the GitHub API", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "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", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "repository_selection": "all", + "repositories_url": "https://api.github.com/organizations/652551/personal-access-token-requests/25381/repositories", + "permissions": { + "organization": { + "members": "read" + }, + "repository": { + "metadata": "read" + } + }, + "created_at": "2023-05-16T08:47:09.000-07:00", + "token_expired": false, + "token_expires_at": "2023-11-16T08:47:09.000-07:00", + "token_last_used_at": null + } + ], + "schema": { + "type": "array", + "items": { + "title": "Simple Organization Programmatic Access Grant Request", + "description": "Minimal representation of an organization programmatic access grant request for enumerations", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests." + }, + "reason": { + "type": [ + "string", + "null" + ], + "description": "Reason for requesting access." + }, + "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" + ] + }, + "repository_selection": { + "type": "string", + "enum": [ + "none", + "all", + "subset" + ], + "description": "Type of repository selection requested." + }, + "repositories_url": { + "type": "string", + "description": "URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`." + }, + "permissions": { + "type": "object", + "description": "Permissions requested, categorized by type of permission.", + "properties": { + "organization": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repository": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "other": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } } }, - "required": [ - "can_create_repository" - ] - } - }, - "required": [ - "state", - "role", - "organization_url", - "url", - "organization", - "user" - ] + "created_at": { + "type": "string", + "description": "Date and time when the request for access was created." + }, + "token_expired": { + "type": "boolean", + "description": "Whether the associated fine-grained personal access token has expired." + }, + "token_expires_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the associated fine-grained personal access token expires." + }, + "token_last_used_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the associated fine-grained personal access token was last used for authentication." + } + }, + "required": [ + "id", + "reason", + "owner", + "repository_selection", + "repositories_url", + "permissions", + "created_at", + "token_expired", + "token_expires_at", + "token_last_used_at" + ] + } } } } ], "previews": [], - "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", + "descriptionHTML": "Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API,\nusing the organization_personal_access_token_requests: read permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", "statusCodes": [ { "httpStatusCode": "200", @@ -363316,19 +363353,27 @@ "httpStatusCode": "403", "description": "Forbidden
" }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, { "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/orgs/{org}/memberships/{username}", - "title": "Remove organization membership for a user", + "verb": "post", + "requestPath": "/organizations/{org}/personal-access-token-requests", + "title": "Review requests to access organization resources with fine-grained personal access tokens", "category": "orgs", - "subcategory": "members", + "subcategory": "personal-access-tokens", "parameters": [ { "name": "org", @@ -363338,42 +363383,164 @@ "schema": { "type": "string" } + } + ], + "bodyParameters": [ + { + "type": "array of integers", + "name": "pat_request_ids", + "in": "body", + "description": "Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 pat_request_id values.
The handle for the GitHub user account.
", + "type": "string", + "name": "action", + "in": "body", + "description": "Action to apply to the requests.
", + "isRequired": true, + "enum": [ + "approve", + "deny" + ] + }, + { + "type": "string or null", + "name": "reason", + "in": "body", + "description": "Reason for approving or denying the requests. Max 1024 characters.
" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Example of denying a request", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "pat_request_ids": [ + 42, + 73 + ], + "action": "deny", + "reason": "Access is too broad." + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "202", + "contentType": "application/json", + "description": "Accepted
", + "example": null, + "schema": { + "type": "object" + } + } + } + ], + "previews": [], + "descriptionHTML": "Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API,\nusing the organization_personal_access_token_requests: write permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", + "statusCodes": [ + { + "httpStatusCode": "202", + "description": "Accepted
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/organizations/{org}/personal-access-token-requests/{pat_request_id}", + "title": "Review a request to access organization resources with a fine-grained personal access token", + "category": "orgs", + "subcategory": "personal-access-tokens", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } + }, + { + "name": "pat_request_id", + "in": "path", + "description": "Unique identifier of the request for access via fine-grained personal access token.
", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "Action to apply to the request.
", + "isRequired": true, + "enum": [ + "approve", + "deny" + ] + }, + { + "type": "string or null", + "name": "reason", + "in": "body", + "description": "Reason for approving or denying the request. Max 1024 characters.
" } ], - "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { - "key": "default", + "key": "204", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Example of denying a request", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "action": "deny", + "reason": "This request is denied because the access is too broad." + }, "parameters": { "org": "ORG", - "username": "USERNAME" + "pat_request_id": "PAT_REQUEST_ID" } }, "response": { "statusCode": "204", - "description": "Response
" + "description": "A header with no content is returned.
" } } ], "previews": [], - "descriptionHTML": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
", + "descriptionHTML": "Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API,\nusing the organization_personal_access_token_requests: write permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", "statusCodes": [ { "httpStatusCode": "204", - "description": "No Content
" + "description": "A header with no content is returned.
" }, { "httpStatusCode": "403", @@ -363382,16 +363549,24 @@ { "httpStatusCode": "404", "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/public_members", - "title": "List public organization members", + "requestPath": "/organizations/{org}/personal-access-token-requests/{pat_request_id}/repositories", + "title": "List repositories requested to be accessed by a fine-grained personal access token", "category": "orgs", - "subcategory": "members", + "subcategory": "personal-access-tokens", "parameters": [ { "name": "org", @@ -363402,6 +363577,15 @@ "type": "string" } }, + { + "name": "pat_request_id", + "in": "path", + "description": "Unique identifier of the request for access via fine-grained personal access token.
", + "required": true, + "schema": { + "type": "integer" + } + }, { "name": "per_page", "description": "The number of results per page (max 100).
", @@ -363430,7 +363614,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG" + "org": "ORG", + "pat_request_id": "PAT_REQUEST_ID" } }, "response": { @@ -363439,186 +363624,910 @@ "description": "Response
", "example": [ { - "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 + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "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 + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + } + } } ], "schema": { "type": "array", "items": { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "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" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { "type": [ "string", "null" ] }, - "email": { - "type": [ - "string", - "null" - ] + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] + "has_wiki": { + "type": "boolean" }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "has_pages": { + "type": "boolean" }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "has_downloads": { + "type": "boolean" }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "has_discussions": { + "type": "boolean" }, - "gravatar_id": { + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { "type": [ "string", "null" ], + "format": "date-time", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "2011-01-26T19:06:43Z" ] }, - "url": { - "type": "string", - "format": "uri", + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "https://api.github.com/users/octocat" + "2011-01-26T19:01:12Z" ] }, - "html_url": { - "type": "string", - "format": "uri", + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "https://github.com/octocat" + "2011-01-26T19:14:43Z" ] }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } }, - "following_url": { + "role_name": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "admin" ] }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "temp_clone_token": { + "type": "string" }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "delete_branch_on_merge": { + "type": "boolean" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "subscribers_count": { + "type": "integer" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "network_count": { + "type": "integer" }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" ] }, - "events_url": { - "type": "string", + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + 0 ] }, - "received_events_url": { - "type": "string", - "format": "uri", + "open_issues": { + "type": "integer", "examples": [ - "https://api.github.com/users/octocat/received_events" + 0 ] }, - "type": { - "type": "string", + "watchers": { + "type": "integer", "examples": [ - "User" + 0 ] }, - "site_admin": { + "allow_forking": { "type": "boolean" }, - "starred_at": { - "type": "string", + "web_commit_signoff_required": { + "type": "boolean", "examples": [ - "\"2020-07-09T00:17:55Z\"" + false ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } } }, "required": [ - "avatar_url", + "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", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", + "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" ] } @@ -363627,21 +364536,33 @@ } ], "previews": [], - "descriptionHTML": "Members of an organization can choose to have their membership publicized or not.
", + "descriptionHTML": "Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API,\nusing the organization_personal_access_token_requests: read permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/public_members/{username}", - "title": "Check public organization membership for a user", + "requestPath": "/organizations/{org}/personal-access-tokens", + "title": "List fine-grained personal access tokens with access to organization resources", "category": "orgs", - "subcategory": "members", + "subcategory": "personal-access-tokens", "parameters": [ { "name": "org", @@ -363653,209 +364574,122 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "Response if user is a public member
" + "type": "integer", + "default": 30 } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "Response if user is a public member
" }, { - "httpStatusCode": "404", - "description": "Not Found if user is not a public member
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/orgs/{org}/public_members/{username}", - "title": "Set public organization membership for the authenticated user", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 1 } }, { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, + "name": "sort", + "description": "The property by which to sort the results.
", + "in": "query", + "required": false, "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": false, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" + "type": "string", + "enum": [ + "created_at" + ], + "default": "created_at" } - } - ], - "previews": [], - "descriptionHTML": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
No Content
" }, { - "httpStatusCode": "403", - "description": "Forbidden
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/orgs/{org}/public_members/{username}", - "title": "Remove public organization membership for the authenticated user", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, + "name": "direction", + "description": "The direction to sort the results by.
", + "in": "query", + "required": false, "schema": { - "type": "string" + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" } }, { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, + "name": "owner", + "description": "A list of owner usernames to use to filter the results.
", + "in": "query", + "required": false, "schema": { - "type": "string" + "type": "array", + "maxItems": 10, + "items": { + "type": "string" + }, + "examples": [ + "owner[]=octocat1,owner[]=octocat2" + ] } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": false, - "codeExamples": [ + }, { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" + "name": "repository", + "description": "The name of the repository to use to filter the results.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "examples": [ + "Hello-World" + ] } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/user/memberships/orgs", - "title": "List organization memberships for the authenticated user", - "category": "orgs", - "subcategory": "members", - "parameters": [ + }, { - "name": "state", - "description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.
", + "name": "permission", + "description": "The permission to use to filter the results.
", "in": "query", "required": false, "schema": { "type": "string", - "enum": [ - "active", - "pending" + "examples": [ + "issues_read" ] } }, { - "name": "per_page", - "description": "The number of results per page (max 100).
", + "name": "last_used_before", + "description": "Only show fine-grained personal access tokens used before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Page number of the results to fetch.
", + "name": "last_used_after", + "description": "Only show fine-grained personal access tokens used after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
", "example": [ { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "admin", - "organization_url": "https://api.github.com/orgs/octocat", - "organization": { + "id": 25381, + "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "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}", @@ -363895,107 +364714,58 @@ "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 - } - }, - { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "admin", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" + "site_admin": true }, - "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 - } + "repository_selection": "all", + "repositories_url": "https://api.github.com/organizations/652551/personal-access-tokens/25381/repositories", + "permissions": { + "organization": { + "members": "read" + }, + "repository": { + "metadata": "read" + } + }, + "access_granted_at": "2023-05-16T08:47:09.000-07:00", + "token_expired": false, + "token_expires_at": "2023-11-16T08:47:09.000-07:00", + "token_last_used_at": null } ], "schema": { "type": "array", "items": { - "title": "Org Membership", - "description": "Org Membership", + "title": "Organization Programmatic Access Grant", + "description": "Minimal representation of an organization programmatic access grant for enumerations", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/memberships/defunkt" - ] - }, - "state": { - "type": "string", - "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", - "enum": [ - "active", - "pending" - ], - "examples": [ - "active" - ] - }, - "role": { - "type": "string", - "description": "The user's membership type in the organization.", - "enum": [ - "admin", - "member", - "billing_manager" - ], - "examples": [ - "admin" - ] - }, - "organization_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat" - ] + "id": { + "type": "integer", + "description": "Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token." }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, "login": { "type": "string", "examples": [ - "github" + "octocat" ] }, "id": { @@ -364007,310 +364777,243 @@ "node_id": { "type": "string", "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" + "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/orgs/github" + "https://api.github.com/users/octocat" ] }, - "repos_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/orgs/github/repos" + "https://github.com/octocat" ] }, - "events_url": { + "followers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/orgs/github/events" + "https://api.github.com/users/octocat/followers" ] }, - "hooks_url": { + "following_url": { "type": "string", "examples": [ - "https://api.github.com/orgs/github/hooks" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "issues_url": { + "gists_url": { "type": "string", "examples": [ - "https://api.github.com/orgs/github/issues" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "members_url": { + "starred_url": { "type": "string", "examples": [ - "https://api.github.com/orgs/github/members{/member}" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "public_members_url": { + "subscriptions_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" + "https://api.github.com/users/octocat/subscriptions" ] }, - "avatar_url": { + "organizations_url": { "type": "string", + "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "https://api.github.com/users/octocat/orgs" ] }, - "description": { - "type": [ - "string", - "null" - ], + "repos_url": { + "type": "string", + "format": "uri", "examples": [ - "A great organization" + "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": [ - "login", - "url", + "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", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - ] - } - ] + "repository_selection": { + "type": "string", + "enum": [ + "none", + "all", + "subset" + ], + "description": "Type of repository selection requested." + }, + "repositories_url": { + "type": "string", + "description": "URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`." }, "permissions": { "type": "object", + "description": "Permissions requested, categorized by type of permission.", "properties": { - "can_create_repository": { - "type": "boolean" + "organization": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repository": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "other": { + "type": "object", + "additionalProperties": { + "type": "string" + } } - }, - "required": [ - "can_create_repository" - ] + } + }, + "access_granted_at": { + "type": "string", + "description": "Date and time when the fine-grained personal access token was approved to access the organization." + }, + "token_expired": { + "type": "boolean", + "description": "Whether the associated fine-grained personal access token has expired." + }, + "token_expires_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the associated fine-grained personal access token expires." + }, + "token_last_used_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the associated fine-grained personal access token was last used for authentication." } }, "required": [ - "state", - "role", - "organization_url", - "url", - "organization", - "user" + "id", + "owner", + "repository_selection", + "repositories_url", + "permissions", + "access_granted_at", + "token_expired", + "token_expires_at", + "token_last_used_at" ] } } } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API,\nusing the organization_personal_access_tokens: read permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, { "httpStatusCode": "403", "description": "Forbidden
" }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, { "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/user/memberships/orgs/{org}", - "title": "Get an organization membership for the authenticated user", + "verb": "post", + "requestPath": "/organizations/{org}/personal-access-tokens", + "title": "Update the access to organization resources via fine-grained personal access tokens", "category": "orgs", - "subcategory": "members", + "subcategory": "personal-access-tokens", "parameters": [ { "name": "org", @@ -364322,401 +365025,61 @@ } } ], - "bodyParameters": [], - "enabledForGitHubApps": false, + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "Action to apply to the fine-grained personal access token.
", + "isRequired": true, + "enum": [ + "revoke" + ] + }, + { + "type": "array of integers", + "name": "pat_ids", + "in": "body", + "description": "The IDs of the fine-grained personal access tokens.
", + "isRequired": true + } + ], + "enabledForGitHubApps": true, "codeExamples": [ { - "key": "default", + "key": "204", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Example of revoking a fine-grained personal access token.", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "action": "revoke", + "pat_ids": [ + 1296269, + 1296280 + ] + }, "parameters": { "org": "ORG" } }, "response": { - "statusCode": "200", + "statusCode": "202", "contentType": "application/json", - "description": "Response
", - "example": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "admin", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "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 - } - }, + "description": "Accepted
", + "example": null, "schema": { - "title": "Org Membership", - "description": "Org Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/memberships/defunkt" - ] - }, - "state": { - "type": "string", - "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", - "enum": [ - "active", - "pending" - ], - "examples": [ - "active" - ] - }, - "role": { - "type": "string", - "description": "The user's membership type in the organization.", - "enum": [ - "admin", - "member", - "billing_manager" - ], - "examples": [ - "admin" - ] - }, - "organization_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "can_create_repository": { - "type": "boolean" - } - }, - "required": [ - "can_create_repository" - ] - } - }, - "required": [ - "state", - "role", - "organization_url", - "url", - "organization", - "user" - ] + "type": "object" } } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API,\nusing the organization_personal_access_tokens: write permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", "statusCodes": [ { - "httpStatusCode": "200", - "description": "OK
" + "httpStatusCode": "202", + "description": "Accepted
" }, { "httpStatusCode": "403", @@ -364725,16 +365088,24 @@ { "httpStatusCode": "404", "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", - "verb": "patch", - "requestPath": "/user/memberships/orgs/{org}", - "title": "Update an organization membership for the authenticated user", + "verb": "post", + "requestPath": "/organizations/{org}/personal-access-tokens/{pat_id}", + "title": "Update the access a fine-grained personal access token has to organization resources", "category": "orgs", - "subcategory": "members", + "subcategory": "personal-access-tokens", "parameters": [ { "name": "org", @@ -364744,418 +365115,57 @@ "schema": { "type": "string" } + }, + { + "name": "pat_id", + "description": "The unique identifier of the fine-grained personal access token.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "bodyParameters": [ { "type": "string", - "name": "state", + "name": "action", "in": "body", - "description": "The state that the membership should be in. Only \"active\" will be accepted.
Action to apply to the fine-grained personal access token.
", "isRequired": true, "enum": [ - "active" + "revoke" ] } ], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { - "key": "default", + "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of revoking a fine-grained personal access token.", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "state": "active" + "action": "revoke" }, "parameters": { - "org": "ORG" + "org": "ORG", + "pat_id": "PAT_ID" } }, "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "admin", - "organization_url": "https://api.github.com/orgs/octocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "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 - } - }, - "schema": { - "title": "Org Membership", - "description": "Org Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/memberships/defunkt" - ] - }, - "state": { - "type": "string", - "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", - "enum": [ - "active", - "pending" - ], - "examples": [ - "active" - ] - }, - "role": { - "type": "string", - "description": "The user's membership type in the organization.", - "enum": [ - "admin", - "member", - "billing_manager" - ], - "examples": [ - "admin" - ] - }, - "organization_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "can_create_repository": { - "type": "boolean" - } - }, - "required": [ - "can_create_repository" - ] - } - }, - "required": [ - "state", - "role", - "organization_url", - "url", - "organization", - "user" - ] - } + "statusCode": "204", + "description": "A header with no content is returned.
" } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API,\nusing the organization_personal_access_tokens: write permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", "statusCodes": [ { - "httpStatusCode": "200", - "description": "OK
" + "httpStatusCode": "204", + "description": "A header with no content is returned.
" }, { "httpStatusCode": "403", @@ -365168,18 +365178,20 @@ { "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" } ] - } - ], - "outside-collaborators": [ + }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/outside_collaborators", - "title": "List outside collaborators for an organization", + "requestPath": "/organizations/{org}/personal-access-tokens/{pat_id}/repositories", + "title": "List repositories a fine-grained personal access token has access to", "category": "orgs", - "subcategory": "outside-collaborators", + "subcategory": "personal-access-tokens", "parameters": [ { "name": "org", @@ -365191,17 +365203,12 @@ } }, { - "name": "filter", - "description": "Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned.
Unique identifier of the fine-grained personal access token.
", + "required": true, "schema": { - "type": "string", - "enum": [ - "2fa_disabled", - "all" - ], - "default": "all" + "type": "integer" } }, { @@ -365232,7 +365239,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG" + "org": "ORG", + "pat_id": "PAT_ID" } }, "response": { @@ -365241,186 +365249,910 @@ "description": "Response
", "example": [ { - "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 + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "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 + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + } + } } ], "schema": { "type": "array", "items": { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, "name": { - "type": [ - "string", - "null" + "type": "string", + "examples": [ + "Hello-World" ] }, - "email": { + "full_name": { + "type": "string", + "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" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { "type": [ "string", "null" + ], + "examples": [ + "This your first repo!" ] }, - "login": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "octocat" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "id": { - "type": "integer", + "archive_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "node_id": { + "assignees_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "avatar_url": { + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "deployments_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "html_url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "followers_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "following_url": { + "git_commits_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "gists_url": { + "git_refs_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "starred_url": { + "git_tags_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "subscriptions_url": { + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "organizations_url": { + "merges_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "repos_url": { + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "events_url": { + "statuses_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "received_events_url": { + "subscribers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "type": { + "subscription_url": { "type": "string", + "format": "uri", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "site_admin": { + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { "type": "boolean" }, - "starred_at": { + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } } }, "required": [ - "avatar_url", + "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", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", + "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" ] } @@ -365429,173 +366161,23 @@ } ], "previews": [], - "descriptionHTML": "List all users who are outside collaborators of an organization.
", + "descriptionHTML": "Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API,\nusing the organization_personal_access_tokens: read permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "title": "Convert an organization member to outside collaborator", - "category": "orgs", - "subcategory": "outside-collaborators", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "boolean", - "name": "async", - "in": "body", - "description": "When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.
User is getting converted asynchronously
", - "example": null, - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - }, - { - "key": "204", - "request": { - "contentType": "application/json", - "description": "Status code 204, synchronous request", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": null, - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "User was converted
" - } - } - ], - "previews": [], - "descriptionHTML": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
", - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "User is getting converted asynchronously
" - }, - { - "httpStatusCode": "204", - "description": "User was converted
" }, { "httpStatusCode": "403", - "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"Enforcing repository management policies in your enterprise.\"
" + "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "title": "Remove outside collaborator from an organization", - "category": "orgs", - "subcategory": "outside-collaborators", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" - } - } - ], - "previews": [], - "descriptionHTML": "Removing a user from this list will remove them from all the organization's repositories.
", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" }, { - "httpStatusCode": "422", - "description": "Unprocessable Entity if user is a member of the organization
" + "httpStatusCode": "500", + "description": "Internal Error
" } ] } @@ -365645,6 +366227,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -365716,6 +366299,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -390246,6 +390836,7 @@ "description": "A great team.", "privacy": "closed", "permission": "admin", + "notification_setting": "notifications_enabled", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null @@ -391805,6 +392396,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -391921,6 +392515,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -395978,6 +396579,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -397599,6 +398201,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -399805,6 +400414,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -401426,6 +402036,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -403682,6 +404299,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -405303,6 +405921,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -409291,8 +409916,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -409917,8 +410540,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -410558,8 +411179,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -411311,8 +411930,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -412025,8 +412642,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -412680,8 +413295,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -412799,6 +413412,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -413003,6 +413617,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -413119,6 +413736,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -413500,6 +414124,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -415057,6 +415682,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -415173,6 +415801,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -419206,6 +419841,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -420763,6 +421399,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -420879,6 +421518,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -438087,7 +438733,7 @@ "type": "string", "name": "target_commitish", "in": "body", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
" }, { "type": "string", @@ -441174,7 +441820,7 @@ "type": "string", "name": "target_commitish", "in": "body", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
" }, { "type": "string", @@ -459860,6 +460506,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -459894,6 +460541,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -460010,6 +460660,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -469236,7 +469893,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -471555,7 +472212,7 @@ "type": "string", "name": "branch", "in": "body", - "description": "The branch name. Default: the repository’s default branch (usually master)
The branch name. Default: the repository’s default branch.
" }, { "type": "object", @@ -472167,7 +472824,7 @@ "type": "string", "name": "branch", "in": "body", - "description": "The branch name. Default: the repository’s default branch (usually master)
The branch name. Default: the repository’s default branch
" }, { "type": "object", @@ -472484,7 +473141,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -472695,7 +473352,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -480181,7 +480838,7 @@ } ], "previews": [], - "descriptionHTML": "Create a fork for the authenticated user.
\nNote: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Support.
", + "descriptionHTML": "Create a fork for the authenticated user.
\nNote: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Support.
\nNote: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
", "statusCodes": [ { "httpStatusCode": "202", @@ -499088,6 +499745,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -499122,6 +499780,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -499238,6 +499899,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -499367,6 +500035,16 @@ "closed" ] }, + { + "type": "string", + "name": "notification_setting", + "in": "body", + "description": "The notification setting the team has chosen:
\nnotifications_enabled - team members receive notifications when the team is @mentioned notifications_disabled - no one receives notifications\nDefault: notifications_enabledThe notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:\n*notifications_enabled - team members receive notifications when the team is @mentioned
notifications_disabled - no one receives notifications\nDefault: notifications_enabledResponse
", + "example": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -501028,6 +502467,17 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", @@ -501116,694 +502566,11 @@ "closed" ] }, - "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" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at" - ] - }, - "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", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - } - } - }, - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "new team name", - "description": "new team description", - "privacy": "closed" - }, - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "Response
", - "example": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "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, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - } - }, - "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "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" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "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", + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", "examples": [ - "closed" + "notifications_enabled" ] }, "html_url": { @@ -507161,6 +507928,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -507196,6 +507964,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -507312,6 +508083,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -507426,6 +508204,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -507531,6 +508310,17 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", @@ -507619,6 +508409,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -508192,6 +508989,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -508297,6 +509095,17 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", @@ -508385,6 +509194,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -508881,6 +509697,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -508986,6 +509803,17 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", @@ -509074,6 +509902,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -514373,6 +515208,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -514408,6 +515244,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -514524,333 +515363,359 @@ "closed" ] }, - "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": { + "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" + ] + } + } + } + } + ], + "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 child teams endpoint.
if child teams exist
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/user/teams", + "title": "List teams for the authenticated user", + "category": "teams", + "subcategory": "teams", + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + } + } + ], + "schema": { + "type": "array", + "items": { + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] + }, + "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" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "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": [ - "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" - ] - } - } - } - } - ], - "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 child teams endpoint.
if child teams exist
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/user/teams", - "title": "List teams for the authenticated user", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page number of the results to fetch.
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": false, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "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, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "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" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "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" + "notifications_enabled" ] }, "html_url": { @@ -530830,7 +531695,17 @@ }, "emails": { "type": "array", - "items": {} + "items": { + "type": "object", + "properties": { + "email": { + "type": "string" + }, + "verified": { + "type": "boolean" + } + } + } }, "subkeys": { "type": "array", @@ -531132,7 +532007,17 @@ }, "emails": { "type": "array", - "items": {} + "items": { + "type": "object", + "properties": { + "email": { + "type": "string" + }, + "verified": { + "type": "boolean" + } + } + } }, "subkeys": { "type": "array", @@ -531431,7 +532316,17 @@ }, "emails": { "type": "array", - "items": {} + "items": { + "type": "object", + "properties": { + "email": { + "type": "string" + }, + "verified": { + "type": "boolean" + } + } + } }, "subkeys": { "type": "array", @@ -531813,7 +532708,17 @@ }, "emails": { "type": "array", - "items": {} + "items": { + "type": "object", + "properties": { + "email": { + "type": "string" + }, + "verified": { + "type": "boolean" + } + } + } }, "subkeys": { "type": "array", diff --git a/src/rest/data/ghae/schema.json b/src/rest/data/ghae/schema.json index f9dbfb66524f..5f9dd9cc156a 100644 --- a/src/rest/data/ghae/schema.json +++ b/src/rest/data/ghae/schema.json @@ -74997,6 +74997,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -75113,6 +75116,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -75719,6 +75729,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -75835,6 +75848,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -76366,6 +76386,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -77821,6 +77844,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -77937,6 +77963,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -78543,6 +78576,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -78659,6 +78695,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -79190,6 +79233,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -80595,6 +80641,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -80680,6 +80727,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -81031,6 +81079,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -81147,6 +81198,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -81753,6 +81811,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -81869,6 +81930,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -82400,6 +82468,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -83321,6 +83392,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -83437,6 +83511,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -84028,6 +84109,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -84144,6 +84228,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -84732,6 +84823,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -85399,6 +85493,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -85656,6 +85751,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -85772,6 +85870,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -86378,6 +86483,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -86494,6 +86602,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -87108,6 +87223,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -87365,6 +87481,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -87481,6 +87600,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -88087,6 +88213,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -88203,6 +88332,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -89846,6 +89982,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -90005,6 +90142,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -92156,6 +92296,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -92190,6 +92331,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -92306,6 +92450,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -92460,6 +92611,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -92494,6 +92646,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -92610,6 +92765,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -92764,6 +92926,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -92798,6 +92961,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -92914,6 +93080,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -93068,6 +93241,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -93102,6 +93276,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -93218,6 +93395,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -94487,7 +94671,7 @@ { "type": "array of objects", "name": "annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\".
", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see \"About status checks\".
", "childParamsGroups": [ { "type": "string", @@ -98326,7 +98510,7 @@ { "type": "array of objects", "name": "annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\".
", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"About status checks\".
", "childParamsGroups": [ { "type": "string", @@ -122923,6 +123107,7 @@ "description": "A great team.", "privacy": "closed", "permission": "admin", + "notification_setting": "notifications_enabled", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null @@ -124482,6 +124667,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -124598,6 +124786,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -139204,6 +139399,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -139557,6 +139753,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -139673,6 +139872,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -139929,6 +140135,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -140268,6 +140475,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -140384,6 +140594,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -140704,6 +140921,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -141043,6 +141261,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -141159,6 +141380,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -207326,6 +207554,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -207442,6 +207673,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -212205,6 +212443,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -212321,6 +212562,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -218169,6 +218417,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -218285,6 +218536,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -219230,6 +219488,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -219346,6 +219607,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -230235,6 +230503,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -230351,6 +230622,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -231296,6 +231574,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -231412,6 +231693,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -240019,8 +240307,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -243352,80 +243638,37 @@ "example": { "verifiable_password_authentication": true, "ssh_key_fingerprints": { - "SHA256_RSA": "uNiVztksCsDhcc0u9e8BujQXVUpKZIDTMczCvj3tD2s", - "SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ", - "SHA256_ECDSA": "p2QAMXNIC1TJYWeIOttrVc98/R1BUFWu3/LiyKgUfQM", - "SHA256_ED25519": "+DiY3wvvV6TuJJhbpZisF/zLDA0zPMSvHdkr4UvCOqU" + "SHA256_RSA": 1234567890, + "SHA256_DSA": 1234567890, + "SHA256_ECDSA": 1234567890, + "SHA256_ED25519": 1234567890 }, "hooks": [ - "192.30.252.0/22", - "185.199.108.0/22", - "140.82.112.0/20", - "143.55.64.0/20", - "2a0a:a440::/29", - "2606:50c0::/32" + "192.0.2.1" ], "web": [ - "192.30.252.0/22", - "185.199.108.0/22", - "140.82.112.0/20", - "143.55.64.0/20", - "2a0a:a440::/29", - "2606:50c0::/32", - "20.201.28.151/32", - "20.205.243.166/32", - "102.133.202.242/32" + "192.0.2.1" ], "api": [ - "192.30.252.0/22", - "185.199.108.0/22", - "140.82.112.0/20", - "143.55.64.0/20", - "2a0a:a440::/29", - "2606:50c0::/32", - "20.201.28.148/32" + "192.0.2.1" ], "git": [ - "192.30.252.0/22", - "185.199.108.0/22", - "140.82.112.0/20", - "143.55.64.0/20", - "2a0a:a440::/29", - "2606:50c0::/32" + "192.0.2.1" ], "packages": [ - "140.82.121.33/32", - "192.30.255.164/31", - "20.200.245.241/32", - "20.233.54.55/32" + "192.0.2.1" ], "pages": [ - "192.30.252.153/32", - "192.30.252.154/32", - "185.199.108.153/32", - "185.199.109.153/32", - "185.199.110.153/32", - "185.199.111.153/32", - "2606:50c0:8000::153/128", - "2606:50c0:8001::153/128", - "2606:50c0:8002::153/128", - "2606:50c0:8003::153/128" + "192.0.2.1" ], "importer": [ - "52.23.85.212/32", - "52.0.228.224/32", - "52.22.155.48/32" + "192.0.2.1" ], "actions": [ - "4.148.0.0/16", - "13.67.153.64/26", - "2603:1030:804:220::/61", - "2603:1036:2500:10::/64" + "192.0.2.1" ], "dependabot": [ - "18.213.123.130/32", - "3.217.79.163/32", - "3.217.93.44/32" + "192.0.2.1" ] }, "schema": { @@ -243462,7 +243705,7 @@ "type": "string" }, "examples": [ - "127.0.0.1/32" + "192.0.2.1" ] }, "web": { @@ -243471,7 +243714,7 @@ "type": "string" }, "examples": [ - "127.0.0.1/32" + "192.0.2.1" ] }, "api": { @@ -243480,7 +243723,7 @@ "type": "string" }, "examples": [ - "127.0.0.1/32" + "192.0.2.1" ] }, "git": { @@ -243489,7 +243732,7 @@ "type": "string" }, "examples": [ - "127.0.0.1/32" + "192.0.2.1" ] }, "packages": { @@ -243498,9 +243741,7 @@ "type": "string" }, "examples": [ - "13.65.0.0/16", - "157.55.204.33/32", - "2a01:111:f403:f90c::/62" + "192.0.2.1" ] }, "pages": { @@ -243509,8 +243750,7 @@ "type": "string" }, "examples": [ - "192.30.252.153/32", - "192.30.252.154/32" + "192.0.2.1" ] }, "importer": { @@ -243519,8 +243759,7 @@ "type": "string" }, "examples": [ - "54.158.161.132", - "54.226.70.38" + "192.0.2.1" ] }, "actions": { @@ -243529,8 +243768,7 @@ "type": "string" }, "examples": [ - "13.64.0.0/16", - "13.65.0.0/16" + "192.0.2.1" ] }, "dependabot": { @@ -243539,8 +243777,7 @@ "type": "string" }, "examples": [ - "192.168.7.15/32", - "192.168.7.16/32" + "192.0.2.1" ] } }, @@ -243552,7 +243789,7 @@ } ], "previews": [], - "descriptionHTML": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
\nNote: This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.
\nNote: The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses.
", + "descriptionHTML": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
\nThe values shown in the documentation's response are example values. You must always query the API directly to get the latest values.
\nNote: This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.
", "statusCodes": [ { "httpStatusCode": "200", @@ -272974,6 +273211,7 @@ "description": "A great team.", "privacy": "closed", "permission": "admin", + "notification_setting": "notifications_enabled", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null @@ -274533,6 +274771,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -274649,6 +274890,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -278530,6 +278778,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -280151,6 +280400,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -282357,6 +282613,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -283978,6 +284235,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -286234,6 +286498,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -287855,6 +288120,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -291843,8 +292115,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -292469,8 +292739,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -293110,8 +293378,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -293863,8 +294129,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -294567,8 +294831,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -295222,8 +295484,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -295341,6 +295601,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -295545,6 +295806,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -295661,6 +295925,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -296042,6 +296313,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -297599,6 +297871,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -297715,6 +297990,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -301578,6 +301860,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -303135,6 +303418,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -303251,6 +303537,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -318967,7 +319260,7 @@ "type": "string", "name": "target_commitish", "in": "body", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
" }, { "type": "string", @@ -321905,7 +322198,7 @@ "type": "string", "name": "target_commitish", "in": "body", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
" }, { "type": "string", @@ -339686,6 +339979,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -339720,6 +340014,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -339836,6 +340133,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -347601,7 +347905,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -349920,7 +350224,7 @@ "type": "string", "name": "branch", "in": "body", - "description": "The branch name. Default: the repository’s default branch (usually master)
The branch name. Default: the repository’s default branch.
" }, { "type": "object", @@ -350532,7 +350836,7 @@ "type": "string", "name": "branch", "in": "body", - "description": "The branch name. Default: the repository’s default branch (usually master)
The branch name. Default: the repository’s default branch
" }, { "type": "object", @@ -350849,7 +351153,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -351060,7 +351364,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -358189,7 +358493,7 @@ } ], "previews": [], - "descriptionHTML": "Create a fork for the authenticated user.
\nNote: 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 AE Support.
", + "descriptionHTML": "Create a fork for the authenticated user.
\nNote: 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 AE Support.
\nNote: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
", "statusCodes": [ { "httpStatusCode": "202", @@ -368560,6 +368864,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -368594,6 +368899,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -368710,6 +369018,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -368839,6 +369154,16 @@ "closed" ] }, + { + "type": "string", + "name": "notification_setting", + "in": "body", + "description": "The notification setting the team has chosen:
\nnotifications_enabled - team members receive notifications when the team is @mentioned notifications_disabled - no one receives notifications\nDefault: notifications_enabledThe notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:\n*notifications_enabled - team members receive notifications when the team is @mentioned
notifications_disabled - no one receives notifications\nDefault: notifications_enabledAdds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\".
", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see \"About status checks\".
", "childParamsGroups": [ { "type": "string", @@ -154628,7 +154846,7 @@ { "type": "array of objects", "name": "annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\".
", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"About status checks\".
", "childParamsGroups": [ { "type": "string", @@ -221597,6 +221815,7 @@ "description": "A great team.", "privacy": "closed", "permission": "admin", + "notification_setting": "notifications_enabled", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null @@ -223156,6 +223375,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -223272,6 +223494,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -243563,6 +243792,304 @@ } ] } + ], + "sboms": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dependency-graph/sbom", + "title": "Export a software bill of materials (SBOM) for a repository.", + "category": "dependency-graph", + "subcategory": "sboms", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "sbom": { + "SPDXID": "SPDXRef-DOCUMENT", + "spdxVersion": "SPDX-2.3", + "creationInfo": { + "created": "2021-09-01T00:00:00Z", + "creators": [ + "Tool: GitHub.com-Dependency-Graph" + ] + }, + "name": "github/example", + "dataLicense": "CC0-1.0", + "documentDescribes": [ + "github/example" + ], + "documentNamespace": "https://github.com/github/example/dependency_graph/sbom-abcdef123456", + "packages": [ + { + "SPDXID": "SPDXRef-Package", + "name": "rubygems:rails", + "versionInfo": "1.0.0", + "downloadLocation": "NOASSERTION", + "filesAnalyzed": false, + "licenseConcluded": "NOASSERTION", + "licenseDeclared": "NOASSERTION" + } + ] + } + }, + "schema": { + "title": "Dependency Graph SPDX SBOM", + "description": "A schema for the SPDX JSON format returned by the Dependency Graph.", + "type": "object", + "properties": { + "sbom": { + "type": "object", + "properties": { + "SPDXID": { + "type": "string", + "description": "The SPDX identifier for the SPDX document.", + "examples": [ + "SPDXRef-DOCUMENT" + ] + }, + "spdxVersion": { + "type": "string", + "description": "The version of the SPDX specification that this document conforms to.", + "examples": [ + "SPDX-2.3" + ] + }, + "creationInfo": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "The date and time the SPDX document was created.", + "examples": [ + "2021-11-03T00:00:00Z" + ] + }, + "creators": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "description": "The tools that were used to generate the SPDX document." + } + }, + "required": [ + "created", + "creators" + ] + }, + "name": { + "type": "string", + "description": "The name of the SPDX document.", + "examples": [ + "github/github" + ] + }, + "dataLicense": { + "type": "string", + "description": "The license under which the SPDX document is licensed.", + "examples": [ + "CC0-1.0" + ] + }, + "documentDescribes": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "github/github" + ] + }, + "description": "The name of the repository that the SPDX document describes." + }, + "documentNamespace": { + "type": "string", + "description": "The namespace for the SPDX document.", + "examples": [ + "https://github.com/example/dependency_graph/sbom-123" + ] + }, + "packages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "SPDXID": { + "type": "string", + "description": "A unique SPDX identifier for the package.", + "examples": [ + "SPDXRef-Package" + ] + }, + "name": { + "type": "string", + "description": "The name of the package.", + "examples": [ + "rubygems:github/github" + ] + }, + "versionInfo": { + "type": "string", + "description": "The version of the package. If the package does not have an exact version specified,\na version range is given.", + "examples": [ + "1.0.0" + ] + }, + "downloadLocation": { + "type": "string", + "description": "The location where the package can be downloaded,\nor NOASSERTION if this has not been determined.", + "examples": [ + "NOASSERTION" + ] + }, + "filesAnalyzed": { + "type": "boolean", + "description": "Whether the package's file content has been subjected to\nanalysis during the creation of the SPDX document.", + "examples": [ + false + ] + }, + "licenseConcluded": { + "type": "string", + "description": "The license of the package as determined while creating the SPDX document.", + "examples": [ + "MIT" + ] + }, + "licenseDeclared": { + "type": "string", + "description": "The license of the package as declared by its author, or NOASSERTION if this information\nwas not available when the SPDX document was created.", + "examples": [ + "NOASSERTION" + ] + }, + "supplier": { + "type": "string", + "description": "The distribution source of this package, or NOASSERTION if this was not determined.", + "examples": [ + "NOASSERTION" + ] + }, + "externalRefs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "referenceCategory": { + "type": "string", + "description": "The category of reference to an external resource this reference refers to.", + "examples": [ + "PACKAGE-MANAGER" + ] + }, + "referenceLocator": { + "type": "string", + "description": "A locator for the particular external resource this reference refers to.", + "examples": [ + "pkg:gem/rails@6.0.1" + ] + }, + "referenceType": { + "type": "string", + "description": "The category of reference to an external resource this reference refers to.", + "examples": [ + "purl" + ] + } + }, + "required": [ + "referenceCategory", + "referenceLocator", + "referenceType" + ] + } + } + } + }, + "required": [ + "SPDXID", + "name", + "versionInfo", + "downloadLocation", + "filesAnalyzed", + "licenseConcluded", + "licenseDeclared", + "supplier" + ] + } + }, + "required": [ + "SPDXID", + "spdxVersion", + "creationInfo", + "name", + "dataLicense", + "documentDescribes", + "documentNamespace", + "packages" + ] + } + }, + "required": [ + "sbom" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Exports the software bill of materials (SBOM) for a repository in SPDX JSON format.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + } ] }, "deploy-keys": { @@ -247221,6 +247748,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -247574,6 +248102,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -247690,6 +248221,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -247946,6 +248484,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -248285,6 +248824,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -248401,6 +248943,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -248721,6 +249270,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -249060,6 +249610,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -249176,6 +249729,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -312573,6 +313133,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -312689,6 +313252,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -317537,6 +318107,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -317653,6 +318226,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -323501,6 +324081,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -323617,6 +324200,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -324562,6 +325152,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -324678,6 +325271,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -335567,6 +336167,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -335683,6 +336286,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -336628,6 +337238,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -336744,6 +337357,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -345436,8 +346056,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -348769,85 +349387,42 @@ "example": { "verifiable_password_authentication": true, "ssh_key_fingerprints": { - "SHA256_RSA": "uNiVztksCsDhcc0u9e8BujQXVUpKZIDTMczCvj3tD2s", - "SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ", - "SHA256_ECDSA": "p2QAMXNIC1TJYWeIOttrVc98/R1BUFWu3/LiyKgUfQM", - "SHA256_ED25519": "+DiY3wvvV6TuJJhbpZisF/zLDA0zPMSvHdkr4UvCOqU" + "SHA256_RSA": 1234567890, + "SHA256_DSA": 1234567890, + "SHA256_ECDSA": 1234567890, + "SHA256_ED25519": 1234567890 }, "ssh_keys": [ - "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl", - "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBEmKSENjQEezOmxkZMy7opKgwFB9nkt5YRrYMjNuG5N87uRgg6CLrbo5wAdT/y6v0mKV0U2w0WZ2YB/++Tpockg=", - "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCj7ndNxQowgcQnjshcLrqPEiiphnt+VTTvDP6mHBL9j1aNUkY4Ue1gvwnGLVlOhGeYrnZaMgRK6+PKCUXaDbC7qtbW8gIkhL7aGCsOr/C56SJMy/BCZfxd1nWzAOxSDPgVsmerOBYfNqltV9/hWCqBywINIR+5dIg6JTJ72pcEpEjcYgXkE2YEFXV1JHnsKgbLWNlhScqb2UmyRkQyytRLtL+38TGxkxCflmO+5Z8CSSNY7GidjMIZ7Q4zMjA2n1nGrlTDkzwDCsw+wqFPGQA179cnfGWOWRVruj16z6XyvxvjJwbz0wQZ75XK5tKSb7FNyeIEs4TT4jk+S4dhPeAUC5y+bDYirYgM4GC7uEnztnZyaVWQ7B381AK4Qdrwt51ZqExKbQpTUNn+EjqoTwvqNj4kqx5QUCI0ThS/YkOxJCXmPUWZbhjpCg56i+2aB6CmK2JGhn57K5mj0MNdBXA4/WnwH6XoPWJzK5Nyu2zB3nAZp+S5hpQs+p1vN1/wsjk=" + "ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ", + "ecdsa-sha2-nistp256 ABCDEFGHIJKLMNOPQRSTUVWXYZ", + "ssh-rsa ABCDEFGHIJKLMNOPQRSTUVWXYZ" ], "hooks": [ - "192.30.252.0/22", - "185.199.108.0/22", - "140.82.112.0/20", - "143.55.64.0/20", - "2a0a:a440::/29", - "2606:50c0::/32" + "192.0.2.1" ], "web": [ - "192.30.252.0/22", - "185.199.108.0/22", - "140.82.112.0/20", - "143.55.64.0/20", - "2a0a:a440::/29", - "2606:50c0::/32", - "20.201.28.151/32", - "20.205.243.166/32", - "102.133.202.242/32" + "192.0.2.1" ], "api": [ - "192.30.252.0/22", - "185.199.108.0/22", - "140.82.112.0/20", - "143.55.64.0/20", - "2a0a:a440::/29", - "2606:50c0::/32", - "20.201.28.148/32" + "192.0.2.1" ], "git": [ - "192.30.252.0/22", - "185.199.108.0/22", - "140.82.112.0/20", - "143.55.64.0/20", - "2a0a:a440::/29", - "2606:50c0::/32" + "192.0.2.1" ], "packages": [ - "140.82.121.33/32", - "192.30.255.164/31", - "20.200.245.241/32", - "20.233.54.55/32" + "192.0.2.1" ], "pages": [ - "192.30.252.153/32", - "192.30.252.154/32", - "185.199.108.153/32", - "185.199.109.153/32", - "185.199.110.153/32", - "185.199.111.153/32", - "2606:50c0:8000::153/128", - "2606:50c0:8001::153/128", - "2606:50c0:8002::153/128", - "2606:50c0:8003::153/128" + "192.0.2.1" ], "importer": [ - "52.23.85.212/32", - "52.0.228.224/32", - "52.22.155.48/32" + "192.0.2.1" ], "actions": [ - "4.148.0.0/16", - "13.67.153.64/26", - "2603:1030:804:220::/61", - "2603:1036:2500:10::/64" + "192.0.2.1" ], "dependabot": [ - "18.213.123.130/32", - "3.217.79.163/32", - "3.217.93.44/32" + "192.0.2.1" ] }, "schema": { @@ -348884,7 +349459,7 @@ "type": "string" }, "examples": [ - "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl" + "ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ" ] }, "hooks": { @@ -348893,7 +349468,7 @@ "type": "string" }, "examples": [ - "127.0.0.1/32" + "192.0.2.1" ] }, "web": { @@ -348902,7 +349477,7 @@ "type": "string" }, "examples": [ - "127.0.0.1/32" + "192.0.2.1" ] }, "api": { @@ -348911,7 +349486,7 @@ "type": "string" }, "examples": [ - "127.0.0.1/32" + "192.0.2.1" ] }, "git": { @@ -348920,7 +349495,7 @@ "type": "string" }, "examples": [ - "127.0.0.1/32" + "192.0.2.1" ] }, "packages": { @@ -348929,9 +349504,7 @@ "type": "string" }, "examples": [ - "13.65.0.0/16", - "157.55.204.33/32", - "2a01:111:f403:f90c::/62" + "192.0.2.1" ] }, "pages": { @@ -348940,8 +349513,7 @@ "type": "string" }, "examples": [ - "192.30.252.153/32", - "192.30.252.154/32" + "192.0.2.1" ] }, "importer": { @@ -348950,8 +349522,7 @@ "type": "string" }, "examples": [ - "54.158.161.132", - "54.226.70.38" + "192.0.2.1" ] }, "actions": { @@ -348960,8 +349531,7 @@ "type": "string" }, "examples": [ - "13.64.0.0/16", - "13.65.0.0/16" + "192.0.2.1" ] }, "dependabot": { @@ -348970,8 +349540,7 @@ "type": "string" }, "examples": [ - "192.168.7.15/32", - "192.168.7.16/32" + "192.0.2.1" ] } }, @@ -348983,7 +349552,7 @@ } ], "previews": [], - "descriptionHTML": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
\nNote: This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.
\nNote: The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses.
", + "descriptionHTML": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
\nThe values shown in the documentation's response are example values. You must always query the API directly to get the latest values.
\nNote: This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.
", "statusCodes": [ { "httpStatusCode": "200", @@ -367308,8 +367877,8 @@ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/organizations/{org}/personal-access-token-requests", - "title": "List requests to access organization resources with fine-grained personal access tokens", + "requestPath": "/orgs/{org}", + "title": "Get an organization", "category": "orgs", "subcategory": "orgs", "parameters": [ @@ -367321,111 +367890,6 @@ "schema": { "type": "string" } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page number of the results to fetch.
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "sort", - "description": "The property by which to sort the results.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created_at" - ], - "default": "created_at" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "owner", - "description": "A list of owner usernames to use to filter the results.
", - "in": "query", - "required": false, - "schema": { - "type": "array", - "maxItems": 10, - "items": { - "type": "string" - }, - "examples": [ - "owner[]=octocat1,owner[]=octocat2" - ] - } - }, - { - "name": "repository", - "description": "The name of the repository to use to filter the results.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "Hello-World" - ] - } - }, - { - "name": "permission", - "description": "The permission to use to filter the results.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "issues_read" - ] - } - }, - { - "name": "last_used_before", - "description": "Only show fine-grained personal access tokens used before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only show fine-grained personal access tokens used after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
", - "example": [ - { - "id": 25381, - "reason": "I need to access the GitHub API", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "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", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true + "example": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "github", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "type": "Organization", + "total_private_repos": 100, + "owned_private_repos": 100, + "private_gists": 81, + "disk_usage": 10000, + "collaborators": 8, + "billing_email": "mona@github.com", + "plan": { + "name": "Medium", + "space": 400, + "private_repos": 20, + "filled_seats": 4, + "seats": 5 + }, + "default_repository_permission": "read", + "members_can_create_repositories": true, + "two_factor_requirement_enabled": true, + "members_allowed_repository_creation_type": "all", + "members_can_create_public_repositories": false, + "members_can_create_private_repositories": false, + "members_can_create_internal_repositories": false, + "members_can_create_pages": true, + "members_can_create_public_pages": true, + "members_can_create_private_pages": true, + "members_can_fork_private_repositories": false, + "web_commit_signoff_required": false, + "updated_at": "2014-03-03T18:58:10Z", + "dependency_graph_enabled_for_new_repositories": false, + "dependabot_alerts_enabled_for_new_repositories": false, + "dependabot_security_updates_enabled_for_new_repositories": false, + "advanced_security_enabled_for_new_repositories": false, + "secret_scanning_enabled_for_new_repositories": false, + "secret_scanning_push_protection_enabled_for_new_repositories": false, + "secret_scanning_push_protection_custom_link": false, + "secret_scanning_push_protection_custom_link_enabled": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md" + }, + "schema": { + "title": "Organization Full", + "description": "Organization Full", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] }, - "repository_selection": "all", - "repositories_url": "https://api.github.com/organizations/652551/personal-access-token-requests/25381/repositories", - "permissions": { - "organization": { - "members": "read" - }, - "repository": { - "metadata": "read" - } + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "created_at": "2023-05-16T08:47:09.000-07:00", - "token_expired": false, - "token_expires_at": "2023-11-16T08:47:09.000-07:00", - "token_last_used_at": null - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple Organization Programmatic Access Grant Request", - "description": "Minimal representation of an organization programmatic access grant request for enumerations", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests." - }, - "reason": { - "type": [ - "string", - "null" - ], - "description": "Reason for requesting access." - }, - "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\"" - ] - } + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" }, - "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" - ] - }, - "repository_selection": { - "type": "string", - "enum": [ - "none", - "all", - "subset" - ], - "description": "Type of repository selection requested." - }, - "repositories_url": { - "type": "string", - "description": "URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`." - }, - "permissions": { - "type": "object", - "description": "Permissions requested, categorized by type of permission.", - "properties": { - "organization": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "repository": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "other": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" } }, - "created_at": { - "type": "string", - "description": "Date and time when the request for access was created." - }, - "token_expired": { - "type": "boolean", - "description": "Whether the associated fine-grained personal access token has expired." - }, - "token_expires_at": { - "type": [ - "string", - "null" - ], - "description": "Date and time when the associated fine-grained personal access token expires." - }, - "token_last_used_at": { - "type": [ - "string", - "null" - ], - "description": "Date and time when the associated fine-grained personal access token was last used for authentication." - } + "required": [ + "name", + "space", + "private_repos" + ] }, - "required": [ - "id", - "reason", - "owner", - "repository_selection", - "repositories_url", - "permissions", - "created_at", - "token_expired", - "token_expires_at", - "token_last_used_at" - ] - } + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at" + ] } } } ], "previews": [], - "descriptionHTML": "Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API,\nusing the organization_personal_access_token_requests: read permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", + "descriptionHTML": "To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.
GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub Enterprise Cloud plan. See \"Authenticating with GitHub Apps\" for details. For an example response, see 'Response with GitHub Enterprise Cloud plan information' below.\"
OK
" }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, { "httpStatusCode": "404", "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/organizations/{org}/personal-access-token-requests", - "title": "Review requests to access organization resources with fine-grained personal access tokens", + "verb": "patch", + "requestPath": "/orgs/{org}", + "title": "Update an organization", "category": "orgs", "subcategory": "orgs", "parameters": [ @@ -367785,3386 +368438,28 @@ ], "bodyParameters": [ { - "type": "array of integers", - "name": "pat_request_ids", + "type": "string", + "name": "billing_email", "in": "body", - "description": "Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 pat_request_id values.
Billing email address. This address is not publicized.
" }, { "type": "string", - "name": "action", + "name": "company", "in": "body", - "description": "Action to apply to the requests.
", - "isRequired": true, - "enum": [ - "approve", - "deny" - ] + "description": "The company name.
" }, { - "type": "string or null", - "name": "reason", + "type": "string", + "name": "email", "in": "body", - "description": "Reason for approving or denying the requests. Max 1024 characters.
" - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "204", - "request": { - "contentType": "application/json", - "description": "Example of denying a request", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "pat_request_ids": [ - 42, - 73 - ], - "action": "deny", - "reason": "Access is too broad." - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "Accepted
", - "example": null, - "schema": { - "type": "object" - } - } - } - ], - "previews": [], - "descriptionHTML": "Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API,\nusing the organization_personal_access_token_requests: write permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "Accepted
" + "description": "The publicly visible email address.
" }, { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/organizations/{org}/personal-access-token-requests/{pat_request_id}", - "title": "Review a request to access organization resources with a fine-grained personal access token", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pat_request_id", - "in": "path", - "description": "Unique identifier of the request for access via fine-grained personal access token.
", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "Action to apply to the request.
", - "isRequired": true, - "enum": [ - "approve", - "deny" - ] - }, - { - "type": "string or null", - "name": "reason", - "in": "body", - "description": "Reason for approving or denying the request. Max 1024 characters.
" - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "204", - "request": { - "contentType": "application/json", - "description": "Example of denying a request", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "action": "deny", - "reason": "This request is denied because the access is too broad." - }, - "parameters": { - "org": "ORG", - "pat_request_id": "PAT_REQUEST_ID" - } - }, - "response": { - "statusCode": "204", - "description": "A header with no content is returned.
" - } - } - ], - "previews": [], - "descriptionHTML": "Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API,\nusing the organization_personal_access_token_requests: write permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "A header with no content is returned.
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/organizations/{org}/personal-access-token-requests/{pat_request_id}/repositories", - "title": "List repositories requested to be accessed by a fine-grained personal access token", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pat_request_id", - "in": "path", - "description": "Unique identifier of the request for access via fine-grained personal access token.
", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page number of the results to fetch.
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "pat_request_id": "PAT_REQUEST_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "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 - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - } - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API,\nusing the organization_personal_access_token_requests: read permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/organizations/{org}/personal-access-tokens", - "title": "List fine-grained personal access tokens with access to organization resources", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page number of the results to fetch.
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "sort", - "description": "The property by which to sort the results.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created_at" - ], - "default": "created_at" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "owner", - "description": "A list of owner usernames to use to filter the results.
", - "in": "query", - "required": false, - "schema": { - "type": "array", - "maxItems": 10, - "items": { - "type": "string" - }, - "examples": [ - "owner[]=octocat1,owner[]=octocat2" - ] - } - }, - { - "name": "repository", - "description": "The name of the repository to use to filter the results.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "Hello-World" - ] - } - }, - { - "name": "permission", - "description": "The permission to use to filter the results.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "issues_read" - ] - } - }, - { - "name": "last_used_before", - "description": "Only show fine-grained personal access tokens used before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only show fine-grained personal access tokens used after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
", - "example": [ - { - "id": 25381, - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "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", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "repository_selection": "all", - "repositories_url": "https://api.github.com/organizations/652551/personal-access-tokens/25381/repositories", - "permissions": { - "organization": { - "members": "read" - }, - "repository": { - "metadata": "read" - } - }, - "access_granted_at": "2023-05-16T08:47:09.000-07:00", - "token_expired": false, - "token_expires_at": "2023-11-16T08:47:09.000-07:00", - "token_last_used_at": null - } - ], - "schema": { - "type": "array", - "items": { - "title": "Organization Programmatic Access Grant", - "description": "Minimal representation of an organization programmatic access grant for enumerations", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token." - }, - "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" - ] - }, - "repository_selection": { - "type": "string", - "enum": [ - "none", - "all", - "subset" - ], - "description": "Type of repository selection requested." - }, - "repositories_url": { - "type": "string", - "description": "URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`." - }, - "permissions": { - "type": "object", - "description": "Permissions requested, categorized by type of permission.", - "properties": { - "organization": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "repository": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "other": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "access_granted_at": { - "type": "string", - "description": "Date and time when the fine-grained personal access token was approved to access the organization." - }, - "token_expired": { - "type": "boolean", - "description": "Whether the associated fine-grained personal access token has expired." - }, - "token_expires_at": { - "type": [ - "string", - "null" - ], - "description": "Date and time when the associated fine-grained personal access token expires." - }, - "token_last_used_at": { - "type": [ - "string", - "null" - ], - "description": "Date and time when the associated fine-grained personal access token was last used for authentication." - } - }, - "required": [ - "id", - "owner", - "repository_selection", - "repositories_url", - "permissions", - "access_granted_at", - "token_expired", - "token_expires_at", - "token_last_used_at" - ] - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API,\nusing the organization_personal_access_tokens: read permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/organizations/{org}/personal-access-tokens", - "title": "Update the access to organization resources via fine-grained personal access tokens", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "Action to apply to the fine-grained personal access token.
", - "isRequired": true, - "enum": [ - "revoke" - ] - }, - { - "type": "array of integers", - "name": "pat_ids", - "in": "body", - "description": "The IDs of the fine-grained personal access tokens.
", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "204", - "request": { - "contentType": "application/json", - "description": "Example of revoking a fine-grained personal access token.", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "action": "revoke", - "pat_ids": [ - 1296269, - 1296280 - ] - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "Accepted
", - "example": null, - "schema": { - "type": "object" - } - } - } - ], - "previews": [], - "descriptionHTML": "Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API,\nusing the organization_personal_access_tokens: write permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "Accepted
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/organizations/{org}/personal-access-tokens/{pat_id}", - "title": "Update the access a fine-grained personal access token has to organization resources", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pat_id", - "description": "The unique identifier of the fine-grained personal access token.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "Action to apply to the fine-grained personal access token.
", - "isRequired": true, - "enum": [ - "revoke" - ] - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "204", - "request": { - "contentType": "application/json", - "description": "Example of revoking a fine-grained personal access token.", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "action": "revoke" - }, - "parameters": { - "org": "ORG", - "pat_id": "PAT_ID" - } - }, - "response": { - "statusCode": "204", - "description": "A header with no content is returned.
" - } - } - ], - "previews": [], - "descriptionHTML": "Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API,\nusing the organization_personal_access_tokens: write permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "A header with no content is returned.
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/organizations/{org}/personal-access-tokens/{pat_id}/repositories", - "title": "List repositories a fine-grained personal access token has access to", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pat_id", - "in": "path", - "description": "Unique identifier of the fine-grained personal access token.
", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page number of the results to fetch.
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "pat_id": "PAT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "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 - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - } - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API,\nusing the organization_personal_access_tokens: read permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}", - "title": "Get an organization", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "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": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "type": "Organization", - "total_private_repos": 100, - "owned_private_repos": 100, - "private_gists": 81, - "disk_usage": 10000, - "collaborators": 8, - "billing_email": "mona@github.com", - "plan": { - "name": "Medium", - "space": 400, - "private_repos": 20, - "filled_seats": 4, - "seats": 5 - }, - "default_repository_permission": "read", - "members_can_create_repositories": true, - "two_factor_requirement_enabled": true, - "members_allowed_repository_creation_type": "all", - "members_can_create_public_repositories": false, - "members_can_create_private_repositories": false, - "members_can_create_internal_repositories": false, - "members_can_create_pages": true, - "members_can_create_public_pages": true, - "members_can_create_private_pages": true, - "members_can_fork_private_repositories": false, - "web_commit_signoff_required": false, - "updated_at": "2014-03-03T18:58:10Z", - "dependency_graph_enabled_for_new_repositories": false, - "dependabot_alerts_enabled_for_new_repositories": false, - "dependabot_security_updates_enabled_for_new_repositories": false, - "advanced_security_enabled_for_new_repositories": false, - "secret_scanning_enabled_for_new_repositories": false, - "secret_scanning_push_protection_enabled_for_new_repositories": false, - "secret_scanning_push_protection_custom_link": false, - "secret_scanning_push_protection_custom_link_enabled": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md" - }, - "schema": { - "title": "Organization Full", - "description": "Organization Full", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ] - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ] - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ] - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ] - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ] - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ] - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", - "examples": [ - false - ] - }, - "secret_scanning_push_protection_custom_link": { - "type": [ - "string", - "null" - ], - "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", - "examples": [ - "https://github.com/test-org/test-repo/blob/main/README.md" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.
GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub Enterprise Cloud plan. See \"Authenticating with GitHub Apps\" for details. For an example response, see 'Response with GitHub Enterprise Cloud plan information' below.\"
OK
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "patch", - "requestPath": "/orgs/{org}", - "title": "Update an organization", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "billing_email", - "in": "body", - "description": "Billing email address. This address is not publicized.
" - }, - { - "type": "string", - "name": "company", - "in": "body", - "description": "The company name.
" - }, - { - "type": "string", - "name": "email", - "in": "body", - "description": "The publicly visible email address.
" - }, - { - "type": "string", - "name": "twitter_username", - "in": "body", - "description": "The Twitter username of the company.
" + "type": "string", + "name": "twitter_username", + "in": "body", + "description": "The Twitter username of the company.
" }, { "type": "string", @@ -377980,38 +375275,1050 @@ "url" ] }, - "team_count": { - "type": "integer" - }, - "node_id": { + "team_count": { + "type": "integer" + }, + "node_id": { + "type": "string", + "examples": [ + "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + ] + }, + "invitation_teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/organizations/16/invitations/1/teams\"" + ] + }, + "invitation_source": { + "type": "string", + "examples": [ + "\"member\"" + ] + } + }, + "required": [ + "id", + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, or hiring_manager. If the invitee is not a GitHub Enterprise Cloud member, the login field in the return hash will be null.
OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/invitations", + "title": "Create an organization invitation", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "integer", + "name": "invitee_id", + "in": "body", + "description": "Required unless you provide email. GitHub user ID for the person you are inviting.
Required unless you provide invitee_id. Email address of the person you are inviting, which can be an existing GitHub user.
The role for the new member.
\nadmin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. direct_member - Non-owner organization members with ability to see other members and join teams by invitation. billing_manager - Non-owner organization members with ability to manage the billing settings of your organization.Specify IDs for the teams you want to invite new members to.
" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "email": "octocat@github.com", + "role": "direct_member", + "team_ids": [ + 12, + 26 + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response
", + "example": { + "id": 1, + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "inviter": { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + }, + "team_count": 2, + "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", + "invitation_source": "member" + }, + "schema": { + "title": "Organization Invitation", + "description": "Organization Invitation", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": [ + "string", + "null" + ] + }, + "failed_reason": { + "type": [ + "string", + "null" + ] + }, + "inviter": { + "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" + ] + }, + "team_count": { + "type": "integer" + }, + "node_id": { + "type": "string", + "examples": [ + "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + ] + }, + "invitation_teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/organizations/16/invitations/1/teams\"" + ] + }, + "invitation_source": { + "type": "string", + "examples": [ + "\"member\"" + ] + } + }, + "required": [ + "id", + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.
\nThis 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.
", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "Created
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/invitations/{invitation_id}", + "title": "Cancel an organization invitation", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "invitation_id", + "description": "The unique identifier of the invitation.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "invitation_id": "INVITATION_ID" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.
\nThis endpoint triggers notifications.
", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/invitations/{invitation_id}/teams", + "title": "List organization invitation teams", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "invitation_id", + "description": "The unique identifier of the invitation.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "invitation_id": "INVITATION_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "schema": { + "type": "array", + "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" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/members", + "title": "List organization members", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. This options is only available for organization owners.
Filter members returned by their role.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "admin", + "member" + ], + "default": "all" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "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": [ + { + "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 + } + ], + "schema": { + "type": "array", + "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": [ - "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + "https://api.github.com/users/octocat/received_events" ] }, - "invitation_teams_url": { + "type": { "type": "string", "examples": [ - "\"https://api.github.com/organizations/16/invitations/1/teams\"" + "User" ] }, - "invitation_source": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", "examples": [ - "\"member\"" + "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", + "node_id", "login", - "email", - "role", - "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } } @@ -378019,23 +376326,23 @@ } ], "previews": [], - "descriptionHTML": "The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, or hiring_manager. If the invitee is not a GitHub Enterprise Cloud member, the login field in the return hash will be null.
List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { - "httpStatusCode": "404", - "description": "Resource not found
" + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" } ] }, { "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/orgs/{org}/invitations", - "title": "Create an organization invitation", + "verb": "get", + "requestPath": "/orgs/{org}/members/{username}", + "title": "Check organization membership for a user", "category": "orgs", "subcategory": "members", "parameters": [ @@ -378047,154 +376354,247 @@ "schema": { "type": "string" } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], - "bodyParameters": [ + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ { - "type": "integer", - "name": "invitee_id", - "in": "body", - "description": "Required unless you provide email. GitHub user ID for the person you are inviting.
Response if requester is an organization member and user is a member
" + } + } + ], + "previews": [], + "descriptionHTML": "Check if a user is, publicly or privately, a member of the organization.
", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "Response if requester is an organization member and user is a member
" }, { - "type": "string", - "name": "email", - "in": "body", - "description": "Required unless you provide invitee_id. Email address of the person you are inviting, which can be an existing GitHub user.
Response if requester is not an organization member
" }, { - "type": "string", - "name": "role", - "in": "body", - "description": "The role for the new member.
\nadmin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. direct_member - Non-owner organization members with ability to see other members and join teams by invitation. billing_manager - Non-owner organization members with ability to manage the billing settings of your organization.Not Found if requester is an organization member and user is not a member
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/members/{username}", + "title": "Remove an organization member", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "type": "array of integers", - "name": "team_ids", - "in": "body", - "description": "Specify IDs for the teams you want to invite new members to.
" + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], + "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "email": "octocat@github.com", - "role": "direct_member", - "team_ids": [ - 12, - 26 - ] - }, "parameters": { - "org": "ORG" + "org": "ORG", + "username": "USERNAME" } }, "response": { - "statusCode": "201", + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/memberships/{username}", + "title": "Get organization membership for a user", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "200", "contentType": "application/json", - "description": "Response
", + "description": "Response if user has an active admin membership with organization
", "example": { - "id": 1, - "login": "monalisa", - "node_id": "MDQ6VXNlcjE=", - "email": "octocat@github.com", - "role": "direct_member", - "created_at": "2016-11-30T06:46:10-08:00", - "inviter": { - "login": "other_user", + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "admin", + "organization_url": "https://api.github.com/orgs/octocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { + "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", + "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 - }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" + } }, "schema": { - "title": "Organization Invitation", - "description": "Organization Invitation", + "title": "Org Membership", + "description": "Org Membership", "type": "object", "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": [ - "string", - "null" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/memberships/defunkt" ] }, - "email": { - "type": [ - "string", - "null" + "state": { + "type": "string", + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "enum": [ + "active", + "pending" + ], + "examples": [ + "active" ] }, "role": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "failed_at": { - "type": [ - "string", - "null" + "type": "string", + "description": "The user's membership type in the organization.", + "enum": [ + "admin", + "member", + "billing_manager" + ], + "examples": [ + "admin" ] }, - "failed_reason": { - "type": [ - "string", - "null" + "organization_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat" ] }, - "inviter": { - "title": "Simple User", - "description": "A GitHub user.", + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, "login": { "type": "string", "examples": [ - "octocat" + "github" ] }, "id": { @@ -378206,182 +376606,737 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, - "avatar_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "https://api.github.com/orgs/github" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "repos_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "https://api.github.com/orgs/github/repos" ] }, - "url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/orgs/github/events" ] }, - "html_url": { + "hooks_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/orgs/github/hooks" ] }, - "followers_url": { + "issues_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "https://api.github.com/orgs/github/issues" ] }, - "following_url": { + "members_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "https://api.github.com/orgs/github/members{/member}" ] }, - "gists_url": { + "public_members_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "https://api.github.com/orgs/github/public_members{/member}" ] }, - "starred_url": { + "avatar_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "https://github.com/images/error/octocat_happy.gif" ] }, - "subscriptions_url": { + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "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" + ] + } + ] + }, + "permissions": { + "type": "object", + "properties": { + "can_create_repository": { + "type": "boolean" + } + }, + "required": [ + "can_create_repository" + ] + } + }, + "required": [ + "state", + "role", + "organization_url", + "url", + "organization", + "user" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.
OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/memberships/{username}", + "title": "Set organization membership for a user", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "role", + "in": "body", + "description": "The role to give the user in the organization. Can be one of:
\nadmin - The user will become an owner of the organization. member - The user will become a non-owner member of the organization.Response if user has an active admin membership with organization
", + "example": { + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "admin", + "organization_url": "https://api.github.com/orgs/octocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "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 + } + }, + "schema": { + "title": "Org Membership", + "description": "Org Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/memberships/defunkt" + ] + }, + "state": { + "type": "string", + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "enum": [ + "active", + "pending" + ], + "examples": [ + "active" + ] + }, + "role": { + "type": "string", + "description": "The user's membership type in the organization.", + "enum": [ + "admin", + "member", + "billing_manager" + ], + "examples": [ + "admin" + ] + }, + "organization_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "github" ] }, - "organizations_url": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "https://api.github.com/orgs/github/events" ] }, - "received_events_url": { + "hooks_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "https://api.github.com/orgs/github/hooks" ] }, - "type": { + "issues_url": { "type": "string", "examples": [ - "User" + "https://api.github.com/orgs/github/issues" ] }, - "site_admin": { - "type": "boolean" + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] }, - "starred_at": { + "public_members_url": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", + "login", + "url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "team_count": { - "type": "integer" - }, - "node_id": { - "type": "string", - "examples": [ - "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] }, - "invitation_teams_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/organizations/16/invitations/1/teams\"" + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "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" + ] + } ] }, - "invitation_source": { - "type": "string", - "examples": [ - "\"member\"" + "permissions": { + "type": "object", + "properties": { + "can_create_repository": { + "type": "boolean" + } + }, + "required": [ + "can_create_repository" ] } }, "required": [ - "id", - "login", - "email", + "state", "role", - "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" + "organization_url", + "url", + "organization", + "user" ] } } } ], "previews": [], - "descriptionHTML": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.
\nThis 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.
", + "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", "statusCodes": [ { - "httpStatusCode": "201", - "description": "Created
" + "httpStatusCode": "200", + "description": "OK
" }, { - "httpStatusCode": "404", - "description": "Resource not found
" + "httpStatusCode": "403", + "description": "Forbidden
" }, { "httpStatusCode": "422", @@ -378392,8 +377347,8 @@ { "serverUrl": "https://api.github.com", "verb": "delete", - "requestPath": "/orgs/{org}/invitations/{invitation_id}", - "title": "Cancel an organization invitation", + "requestPath": "/orgs/{org}/memberships/{username}", + "title": "Remove organization membership for a user", "category": "orgs", "subcategory": "members", "parameters": [ @@ -378407,12 +377362,12 @@ } }, { - "name": "invitation_id", - "description": "The unique identifier of the invitation.
", + "name": "username", + "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], @@ -378426,7 +377381,7 @@ "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", - "invitation_id": "INVITATION_ID" + "username": "USERNAME" } }, "response": { @@ -378436,312 +377391,15 @@ } ], "previews": [], - "descriptionHTML": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.
\nThis endpoint triggers notifications.
", + "descriptionHTML": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/invitations/{invitation_id}/teams", - "title": "List organization invitation teams", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "invitation_id", - "description": "The unique identifier of the invitation.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page number of the results to fetch.
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "invitation_id": "INVITATION_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "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 - } - ], - "schema": { - "type": "array", - "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" - }, - "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" - ] - }, - "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" - ] - } - } - } - } - ], - "previews": [], - "descriptionHTML": "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" + "httpStatusCode": "403", + "description": "Forbidden
" }, { "httpStatusCode": "404", @@ -378752,8 +377410,8 @@ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/members", - "title": "List organization members", + "requestPath": "/orgs/{org}/public_members", + "title": "List public organization members", "category": "orgs", "subcategory": "members", "parameters": [ @@ -378766,35 +377424,6 @@ "type": "string" } }, - { - "name": "filter", - "description": "Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. This options is only available for organization owners.
Filter members returned by their role.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "admin", - "member" - ], - "default": "all" - } - }, { "name": "per_page", "description": "The number of results per page (max 100).
", @@ -378984,181 +377613,724 @@ "User" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "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" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Members of an organization can choose to have their membership publicized or not.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/public_members/{username}", + "title": "Check public organization membership for a user", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "204", + "description": "Response if user is a public member
" + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "Response if user is a public member
" + }, + { + "httpStatusCode": "404", + "description": "Not Found if user is not a public member
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/public_members/{username}", + "title": "Set public organization membership for the authenticated user", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
No Content
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/public_members/{username}", + "title": "Remove public organization membership for the authenticated user", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/user/memberships/orgs", + "title": "List organization memberships for the authenticated user", + "category": "orgs", + "subcategory": "members", + "parameters": [ + { + "name": "state", + "description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "active", + "pending" + ] + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "admin", + "organization_url": "https://api.github.com/orgs/octocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "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 + } + }, + { + "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", + "state": "pending", + "role": "admin", + "organization_url": "https://api.github.com/orgs/invitocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "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 + } + } + ], + "schema": { + "type": "array", + "items": { + "title": "Org Membership", + "description": "Org Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/memberships/defunkt" + ] + }, + "state": { + "type": "string", + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "enum": [ + "active", + "pending" + ], + "examples": [ + "active" + ] + }, + "role": { + "type": "string", + "description": "The user's membership type in the organization.", + "enum": [ + "admin", + "member", + "billing_manager" + ], + "examples": [ + "admin" + ] + }, + "organization_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "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" + ] + } + ] + }, + "permissions": { + "type": "object", + "properties": { + "can_create_repository": { + "type": "boolean" + } + }, + "required": [ + "can_create_repository" ] } }, "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" + "state", + "role", + "organization_url", + "url", + "organization", + "user" ] } } } } ], + "descriptionHTML": "", "previews": [], - "descriptionHTML": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/members/{username}", - "title": "Check organization membership for a user", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "204", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "Response if requester is an organization member and user is a member
" - } - } - ], - "previews": [], - "descriptionHTML": "Check if a user is, publicly or privately, a member of the organization.
", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "Response if requester is an organization member and user is a member
" - }, - { - "httpStatusCode": "302", - "description": "Response if requester is not an organization member
" - }, - { - "httpStatusCode": "404", - "description": "Not Found if requester is an organization member and user is not a member
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/orgs/{org}/members/{username}", - "title": "Remove an organization member", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "httpStatusCode": "304", + "description": "Not modified
" }, { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" - } - } - ], - "previews": [], - "descriptionHTML": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" + "httpStatusCode": "401", + "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/memberships/{username}", - "title": "Get organization membership for a user", + "requestPath": "/user/memberships/orgs/{org}", + "title": "Get an organization membership for the authenticated user", "category": "orgs", "subcategory": "members", "parameters": [ @@ -379170,19 +378342,10 @@ "schema": { "type": "string" } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "bodyParameters": [], - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", @@ -379190,19 +378353,18 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG", - "username": "USERNAME" + "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user has an active admin membership with organization
", + "description": "Response
", "example": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", + "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", + "state": "pending", "role": "admin", - "organization_url": "https://api.github.com/orgs/octocat", + "organization_url": "https://api.github.com/orgs/invitocat", "organization": { "login": "github", "id": 1, @@ -379571,8 +378733,8 @@ } } ], + "descriptionHTML": "", "previews": [], - "descriptionHTML": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.
The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "bodyParameters": [ { "type": "string", - "name": "role", + "name": "state", "in": "body", - "description": "The role to give the user in the organization. Can be one of:
\nadmin - The user will become an owner of the organization. member - The user will become a non-owner member of the organization.The state that the membership should be in. Only \"active\" will be accepted.
Response if user has an active admin membership with organization
", + "description": "Response
", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -379974,55 +379125,941 @@ ] } }, - "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" - ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "can_create_repository": { - "type": "boolean" + "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" + ] + } + ] + }, + "permissions": { + "type": "object", + "properties": { + "can_create_repository": { + "type": "boolean" + } + }, + "required": [ + "can_create_repository" + ] + } + }, + "required": [ + "state", + "role", + "organization_url", + "url", + "organization", + "user" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + } + ], + "outside-collaborators": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/outside_collaborators", + "title": "List outside collaborators for an organization", + "category": "orgs", + "subcategory": "outside-collaborators", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned.
The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "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": [ + { + "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 + } + ], + "schema": { + "type": "array", + "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" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "List all users who are outside collaborators of an organization.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/outside_collaborators/{username}", + "title": "Convert an organization member to outside collaborator", + "category": "orgs", + "subcategory": "outside-collaborators", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "boolean", + "name": "async", + "in": "body", + "description": "When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.
User is getting converted asynchronously
", + "example": null, + "schema": { + "type": "object", + "properties": {}, + "additionalProperties": false + } + } + }, + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Status code 204, synchronous request", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": null, + "parameters": { + "org": "ORG", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "204", + "description": "User was converted
" + } + } + ], + "previews": [], + "descriptionHTML": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
", + "statusCodes": [ + { + "httpStatusCode": "202", + "description": "User is getting converted asynchronously
" + }, + { + "httpStatusCode": "204", + "description": "User was converted
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"Enforcing repository management policies in your enterprise.\"
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/outside_collaborators/{username}", + "title": "Remove outside collaborator from an organization", + "category": "orgs", + "subcategory": "outside-collaborators", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Removing a user from this list will remove them from all the organization's repositories.
", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "422", + "description": "Unprocessable Entity if user is a member of the organization
" + } + ] + } + ], + "personal-access-tokens": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/organizations/{org}/personal-access-token-requests", + "title": "List requests to access organization resources with fine-grained personal access tokens", + "category": "orgs", + "subcategory": "personal-access-tokens", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created_at" + ], + "default": "created_at" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "owner", + "description": "A list of owner usernames to use to filter the results.
", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 10, + "items": { + "type": "string" + }, + "examples": [ + "owner[]=octocat1,owner[]=octocat2" + ] + } + }, + { + "name": "repository", + "description": "The name of the repository to use to filter the results.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "examples": [ + "Hello-World" + ] + } + }, + { + "name": "permission", + "description": "The permission to use to filter the results.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "examples": [ + "issues_read" + ] + } + }, + { + "name": "last_used_before", + "description": "Only show fine-grained personal access tokens used before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only show fine-grained personal access tokens used after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
", + "example": [ + { + "id": 25381, + "reason": "I need to access the GitHub API", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "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", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "repository_selection": "all", + "repositories_url": "https://api.github.com/organizations/652551/personal-access-token-requests/25381/repositories", + "permissions": { + "organization": { + "members": "read" + }, + "repository": { + "metadata": "read" + } + }, + "created_at": "2023-05-16T08:47:09.000-07:00", + "token_expired": false, + "token_expires_at": "2023-11-16T08:47:09.000-07:00", + "token_last_used_at": null + } + ], + "schema": { + "type": "array", + "items": { + "title": "Simple Organization Programmatic Access Grant Request", + "description": "Minimal representation of an organization programmatic access grant request for enumerations", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests." + }, + "reason": { + "type": [ + "string", + "null" + ], + "description": "Reason for requesting access." + }, + "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" + ] + }, + "repository_selection": { + "type": "string", + "enum": [ + "none", + "all", + "subset" + ], + "description": "Type of repository selection requested." + }, + "repositories_url": { + "type": "string", + "description": "URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`." + }, + "permissions": { + "type": "object", + "description": "Permissions requested, categorized by type of permission.", + "properties": { + "organization": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repository": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "other": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } } }, - "required": [ - "can_create_repository" - ] - } - }, - "required": [ - "state", - "role", - "organization_url", - "url", - "organization", - "user" - ] + "created_at": { + "type": "string", + "description": "Date and time when the request for access was created." + }, + "token_expired": { + "type": "boolean", + "description": "Whether the associated fine-grained personal access token has expired." + }, + "token_expires_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the associated fine-grained personal access token expires." + }, + "token_last_used_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the associated fine-grained personal access token was last used for authentication." + } + }, + "required": [ + "id", + "reason", + "owner", + "repository_selection", + "repositories_url", + "permissions", + "created_at", + "token_expired", + "token_expires_at", + "token_last_used_at" + ] + } } } } ], "previews": [], - "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", + "descriptionHTML": "Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API,\nusing the organization_personal_access_token_requests: read permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", "statusCodes": [ { "httpStatusCode": "200", @@ -380032,19 +380069,27 @@ "httpStatusCode": "403", "description": "Forbidden
" }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, { "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/orgs/{org}/memberships/{username}", - "title": "Remove organization membership for a user", + "verb": "post", + "requestPath": "/organizations/{org}/personal-access-token-requests", + "title": "Review requests to access organization resources with fine-grained personal access tokens", "category": "orgs", - "subcategory": "members", + "subcategory": "personal-access-tokens", "parameters": [ { "name": "org", @@ -380054,42 +380099,164 @@ "schema": { "type": "string" } + } + ], + "bodyParameters": [ + { + "type": "array of integers", + "name": "pat_request_ids", + "in": "body", + "description": "Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 pat_request_id values.
The handle for the GitHub user account.
", + "type": "string", + "name": "action", + "in": "body", + "description": "Action to apply to the requests.
", + "isRequired": true, + "enum": [ + "approve", + "deny" + ] + }, + { + "type": "string or null", + "name": "reason", + "in": "body", + "description": "Reason for approving or denying the requests. Max 1024 characters.
" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Example of denying a request", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "pat_request_ids": [ + 42, + 73 + ], + "action": "deny", + "reason": "Access is too broad." + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "202", + "contentType": "application/json", + "description": "Accepted
", + "example": null, + "schema": { + "type": "object" + } + } + } + ], + "previews": [], + "descriptionHTML": "Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API,\nusing the organization_personal_access_token_requests: write permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", + "statusCodes": [ + { + "httpStatusCode": "202", + "description": "Accepted
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/organizations/{org}/personal-access-token-requests/{pat_request_id}", + "title": "Review a request to access organization resources with a fine-grained personal access token", + "category": "orgs", + "subcategory": "personal-access-tokens", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } + }, + { + "name": "pat_request_id", + "in": "path", + "description": "Unique identifier of the request for access via fine-grained personal access token.
", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "Action to apply to the request.
", + "isRequired": true, + "enum": [ + "approve", + "deny" + ] + }, + { + "type": "string or null", + "name": "reason", + "in": "body", + "description": "Reason for approving or denying the request. Max 1024 characters.
" } ], - "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { - "key": "default", + "key": "204", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Example of denying a request", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "action": "deny", + "reason": "This request is denied because the access is too broad." + }, "parameters": { "org": "ORG", - "username": "USERNAME" + "pat_request_id": "PAT_REQUEST_ID" } }, "response": { "statusCode": "204", - "description": "Response
" + "description": "A header with no content is returned.
" } } ], "previews": [], - "descriptionHTML": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
", + "descriptionHTML": "Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API,\nusing the organization_personal_access_token_requests: write permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", "statusCodes": [ { "httpStatusCode": "204", - "description": "No Content
" + "description": "A header with no content is returned.
" }, { "httpStatusCode": "403", @@ -380098,16 +380265,24 @@ { "httpStatusCode": "404", "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/public_members", - "title": "List public organization members", + "requestPath": "/organizations/{org}/personal-access-token-requests/{pat_request_id}/repositories", + "title": "List repositories requested to be accessed by a fine-grained personal access token", "category": "orgs", - "subcategory": "members", + "subcategory": "personal-access-tokens", "parameters": [ { "name": "org", @@ -380118,6 +380293,15 @@ "type": "string" } }, + { + "name": "pat_request_id", + "in": "path", + "description": "Unique identifier of the request for access via fine-grained personal access token.
", + "required": true, + "schema": { + "type": "integer" + } + }, { "name": "per_page", "description": "The number of results per page (max 100).
", @@ -380146,7 +380330,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG" + "org": "ORG", + "pat_request_id": "PAT_REQUEST_ID" } }, "response": { @@ -380155,186 +380340,910 @@ "description": "Response
", "example": [ { - "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 + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "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 + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + } + } } ], "schema": { "type": "array", "items": { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "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" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { "type": [ "string", "null" ] }, - "email": { - "type": [ - "string", - "null" - ] + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] + "has_wiki": { + "type": "boolean" }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "has_pages": { + "type": "boolean" }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "has_downloads": { + "type": "boolean" }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "has_discussions": { + "type": "boolean" }, - "gravatar_id": { + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { "type": [ "string", "null" ], + "format": "date-time", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "2011-01-26T19:06:43Z" ] }, - "url": { - "type": "string", - "format": "uri", + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "https://api.github.com/users/octocat" + "2011-01-26T19:01:12Z" ] }, - "html_url": { - "type": "string", - "format": "uri", + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "https://github.com/octocat" + "2011-01-26T19:14:43Z" ] }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } }, - "following_url": { + "role_name": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "admin" ] }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "temp_clone_token": { + "type": "string" }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "delete_branch_on_merge": { + "type": "boolean" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "subscribers_count": { + "type": "integer" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "network_count": { + "type": "integer" }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" ] }, - "events_url": { - "type": "string", + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + 0 ] }, - "received_events_url": { - "type": "string", - "format": "uri", + "open_issues": { + "type": "integer", "examples": [ - "https://api.github.com/users/octocat/received_events" + 0 ] }, - "type": { - "type": "string", + "watchers": { + "type": "integer", "examples": [ - "User" + 0 ] }, - "site_admin": { + "allow_forking": { "type": "boolean" }, - "starred_at": { - "type": "string", + "web_commit_signoff_required": { + "type": "boolean", "examples": [ - "\"2020-07-09T00:17:55Z\"" + false ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } } }, "required": [ - "avatar_url", + "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", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", + "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" ] } @@ -380343,21 +381252,33 @@ } ], "previews": [], - "descriptionHTML": "Members of an organization can choose to have their membership publicized or not.
", + "descriptionHTML": "Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API,\nusing the organization_personal_access_token_requests: read permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/public_members/{username}", - "title": "Check public organization membership for a user", + "requestPath": "/organizations/{org}/personal-access-tokens", + "title": "List fine-grained personal access tokens with access to organization resources", "category": "orgs", - "subcategory": "members", + "subcategory": "personal-access-tokens", "parameters": [ { "name": "org", @@ -380369,209 +381290,122 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "Response if user is a public member
" + "type": "integer", + "default": 30 } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "Response if user is a public member
" }, { - "httpStatusCode": "404", - "description": "Not Found if user is not a public member
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/orgs/{org}/public_members/{username}", - "title": "Set public organization membership for the authenticated user", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 1 } }, { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, + "name": "sort", + "description": "The property by which to sort the results.
", + "in": "query", + "required": false, "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": false, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" + "type": "string", + "enum": [ + "created_at" + ], + "default": "created_at" } - } - ], - "previews": [], - "descriptionHTML": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
No Content
" }, { - "httpStatusCode": "403", - "description": "Forbidden
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/orgs/{org}/public_members/{username}", - "title": "Remove public organization membership for the authenticated user", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, + "name": "direction", + "description": "The direction to sort the results by.
", + "in": "query", + "required": false, "schema": { - "type": "string" + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" } }, { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, + "name": "owner", + "description": "A list of owner usernames to use to filter the results.
", + "in": "query", + "required": false, "schema": { - "type": "string" + "type": "array", + "maxItems": 10, + "items": { + "type": "string" + }, + "examples": [ + "owner[]=octocat1,owner[]=octocat2" + ] } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": false, - "codeExamples": [ + }, { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" + "name": "repository", + "description": "The name of the repository to use to filter the results.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "examples": [ + "Hello-World" + ] } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/user/memberships/orgs", - "title": "List organization memberships for the authenticated user", - "category": "orgs", - "subcategory": "members", - "parameters": [ + }, { - "name": "state", - "description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.
", + "name": "permission", + "description": "The permission to use to filter the results.
", "in": "query", "required": false, "schema": { "type": "string", - "enum": [ - "active", - "pending" + "examples": [ + "issues_read" ] } }, { - "name": "per_page", - "description": "The number of results per page (max 100).
", + "name": "last_used_before", + "description": "Only show fine-grained personal access tokens used before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Page number of the results to fetch.
", + "name": "last_used_after", + "description": "Only show fine-grained personal access tokens used after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
", "example": [ { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "admin", - "organization_url": "https://api.github.com/orgs/octocat", - "organization": { + "id": 25381, + "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "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}", @@ -380611,107 +381430,58 @@ "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 - } - }, - { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "admin", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" + "site_admin": true }, - "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 - } + "repository_selection": "all", + "repositories_url": "https://api.github.com/organizations/652551/personal-access-tokens/25381/repositories", + "permissions": { + "organization": { + "members": "read" + }, + "repository": { + "metadata": "read" + } + }, + "access_granted_at": "2023-05-16T08:47:09.000-07:00", + "token_expired": false, + "token_expires_at": "2023-11-16T08:47:09.000-07:00", + "token_last_used_at": null } ], "schema": { "type": "array", "items": { - "title": "Org Membership", - "description": "Org Membership", + "title": "Organization Programmatic Access Grant", + "description": "Minimal representation of an organization programmatic access grant for enumerations", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/memberships/defunkt" - ] - }, - "state": { - "type": "string", - "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", - "enum": [ - "active", - "pending" - ], - "examples": [ - "active" - ] - }, - "role": { - "type": "string", - "description": "The user's membership type in the organization.", - "enum": [ - "admin", - "member", - "billing_manager" - ], - "examples": [ - "admin" - ] - }, - "organization_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat" - ] + "id": { + "type": "integer", + "description": "Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token." }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, "login": { "type": "string", "examples": [ - "github" + "octocat" ] }, "id": { @@ -380723,310 +381493,243 @@ "node_id": { "type": "string", "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" + "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/orgs/github" + "https://api.github.com/users/octocat" ] }, - "repos_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/orgs/github/repos" + "https://github.com/octocat" ] }, - "events_url": { + "followers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/orgs/github/events" + "https://api.github.com/users/octocat/followers" ] }, - "hooks_url": { + "following_url": { "type": "string", "examples": [ - "https://api.github.com/orgs/github/hooks" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "issues_url": { + "gists_url": { "type": "string", "examples": [ - "https://api.github.com/orgs/github/issues" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "members_url": { + "starred_url": { "type": "string", "examples": [ - "https://api.github.com/orgs/github/members{/member}" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "public_members_url": { + "subscriptions_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" + "https://api.github.com/users/octocat/subscriptions" ] }, - "avatar_url": { + "organizations_url": { "type": "string", + "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "https://api.github.com/users/octocat/orgs" ] }, - "description": { - "type": [ - "string", - "null" - ], + "repos_url": { + "type": "string", + "format": "uri", "examples": [ - "A great organization" + "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": [ - "login", - "url", + "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", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - ] - } - ] + "repository_selection": { + "type": "string", + "enum": [ + "none", + "all", + "subset" + ], + "description": "Type of repository selection requested." + }, + "repositories_url": { + "type": "string", + "description": "URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`." }, "permissions": { "type": "object", + "description": "Permissions requested, categorized by type of permission.", "properties": { - "can_create_repository": { - "type": "boolean" + "organization": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repository": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "other": { + "type": "object", + "additionalProperties": { + "type": "string" + } } - }, - "required": [ - "can_create_repository" - ] + } + }, + "access_granted_at": { + "type": "string", + "description": "Date and time when the fine-grained personal access token was approved to access the organization." + }, + "token_expired": { + "type": "boolean", + "description": "Whether the associated fine-grained personal access token has expired." + }, + "token_expires_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the associated fine-grained personal access token expires." + }, + "token_last_used_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the associated fine-grained personal access token was last used for authentication." } }, "required": [ - "state", - "role", - "organization_url", - "url", - "organization", - "user" + "id", + "owner", + "repository_selection", + "repositories_url", + "permissions", + "access_granted_at", + "token_expired", + "token_expires_at", + "token_last_used_at" ] } } } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API,\nusing the organization_personal_access_tokens: read permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, { "httpStatusCode": "403", "description": "Forbidden
" }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, { "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/user/memberships/orgs/{org}", - "title": "Get an organization membership for the authenticated user", + "verb": "post", + "requestPath": "/organizations/{org}/personal-access-tokens", + "title": "Update the access to organization resources via fine-grained personal access tokens", "category": "orgs", - "subcategory": "members", + "subcategory": "personal-access-tokens", "parameters": [ { "name": "org", @@ -381038,401 +381741,61 @@ } } ], - "bodyParameters": [], - "enabledForGitHubApps": false, + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "Action to apply to the fine-grained personal access token.
", + "isRequired": true, + "enum": [ + "revoke" + ] + }, + { + "type": "array of integers", + "name": "pat_ids", + "in": "body", + "description": "The IDs of the fine-grained personal access tokens.
", + "isRequired": true + } + ], + "enabledForGitHubApps": true, "codeExamples": [ { - "key": "default", + "key": "204", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Example of revoking a fine-grained personal access token.", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "action": "revoke", + "pat_ids": [ + 1296269, + 1296280 + ] + }, "parameters": { "org": "ORG" } }, "response": { - "statusCode": "200", + "statusCode": "202", "contentType": "application/json", - "description": "Response
", - "example": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "admin", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "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 - } - }, + "description": "Accepted
", + "example": null, "schema": { - "title": "Org Membership", - "description": "Org Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/memberships/defunkt" - ] - }, - "state": { - "type": "string", - "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", - "enum": [ - "active", - "pending" - ], - "examples": [ - "active" - ] - }, - "role": { - "type": "string", - "description": "The user's membership type in the organization.", - "enum": [ - "admin", - "member", - "billing_manager" - ], - "examples": [ - "admin" - ] - }, - "organization_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "can_create_repository": { - "type": "boolean" - } - }, - "required": [ - "can_create_repository" - ] - } - }, - "required": [ - "state", - "role", - "organization_url", - "url", - "organization", - "user" - ] + "type": "object" } } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API,\nusing the organization_personal_access_tokens: write permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", "statusCodes": [ { - "httpStatusCode": "200", - "description": "OK
" + "httpStatusCode": "202", + "description": "Accepted
" }, { "httpStatusCode": "403", @@ -381441,16 +381804,24 @@ { "httpStatusCode": "404", "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", - "verb": "patch", - "requestPath": "/user/memberships/orgs/{org}", - "title": "Update an organization membership for the authenticated user", + "verb": "post", + "requestPath": "/organizations/{org}/personal-access-tokens/{pat_id}", + "title": "Update the access a fine-grained personal access token has to organization resources", "category": "orgs", - "subcategory": "members", + "subcategory": "personal-access-tokens", "parameters": [ { "name": "org", @@ -381460,418 +381831,57 @@ "schema": { "type": "string" } + }, + { + "name": "pat_id", + "description": "The unique identifier of the fine-grained personal access token.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "bodyParameters": [ { "type": "string", - "name": "state", + "name": "action", "in": "body", - "description": "The state that the membership should be in. Only \"active\" will be accepted.
Action to apply to the fine-grained personal access token.
", "isRequired": true, "enum": [ - "active" + "revoke" ] } ], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { - "key": "default", + "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of revoking a fine-grained personal access token.", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "state": "active" + "action": "revoke" }, "parameters": { - "org": "ORG" + "org": "ORG", + "pat_id": "PAT_ID" } }, "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "admin", - "organization_url": "https://api.github.com/orgs/octocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "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 - } - }, - "schema": { - "title": "Org Membership", - "description": "Org Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/memberships/defunkt" - ] - }, - "state": { - "type": "string", - "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", - "enum": [ - "active", - "pending" - ], - "examples": [ - "active" - ] - }, - "role": { - "type": "string", - "description": "The user's membership type in the organization.", - "enum": [ - "admin", - "member", - "billing_manager" - ], - "examples": [ - "admin" - ] - }, - "organization_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "can_create_repository": { - "type": "boolean" - } - }, - "required": [ - "can_create_repository" - ] - } - }, - "required": [ - "state", - "role", - "organization_url", - "url", - "organization", - "user" - ] - } + "statusCode": "204", + "description": "A header with no content is returned.
" } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API,\nusing the organization_personal_access_tokens: write permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", "statusCodes": [ { - "httpStatusCode": "200", - "description": "OK
" + "httpStatusCode": "204", + "description": "A header with no content is returned.
" }, { "httpStatusCode": "403", @@ -381884,18 +381894,20 @@ { "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" } ] - } - ], - "outside-collaborators": [ + }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/outside_collaborators", - "title": "List outside collaborators for an organization", + "requestPath": "/organizations/{org}/personal-access-tokens/{pat_id}/repositories", + "title": "List repositories a fine-grained personal access token has access to", "category": "orgs", - "subcategory": "outside-collaborators", + "subcategory": "personal-access-tokens", "parameters": [ { "name": "org", @@ -381907,17 +381919,12 @@ } }, { - "name": "filter", - "description": "Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned.
Unique identifier of the fine-grained personal access token.
", + "required": true, "schema": { - "type": "string", - "enum": [ - "2fa_disabled", - "all" - ], - "default": "all" + "type": "integer" } }, { @@ -381948,7 +381955,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG" + "org": "ORG", + "pat_id": "PAT_ID" } }, "response": { @@ -381957,186 +381965,910 @@ "description": "Response
", "example": [ { - "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 + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "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 + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + } + } } ], "schema": { "type": "array", "items": { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, "name": { - "type": [ - "string", - "null" + "type": "string", + "examples": [ + "Hello-World" ] }, - "email": { + "full_name": { + "type": "string", + "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" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { "type": [ "string", "null" + ], + "examples": [ + "This your first repo!" ] }, - "login": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "octocat" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "id": { - "type": "integer", + "archive_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "node_id": { + "assignees_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "avatar_url": { + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "deployments_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "html_url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "followers_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "following_url": { + "git_commits_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "gists_url": { + "git_refs_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "starred_url": { + "git_tags_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "subscriptions_url": { + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "organizations_url": { + "merges_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "repos_url": { + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "events_url": { + "statuses_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "received_events_url": { + "subscribers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "type": { + "subscription_url": { "type": "string", + "format": "uri", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "site_admin": { + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { "type": "boolean" }, - "starred_at": { + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } } }, "required": [ - "avatar_url", + "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", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", + "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" ] } @@ -382145,173 +382877,23 @@ } ], "previews": [], - "descriptionHTML": "List all users who are outside collaborators of an organization.
", + "descriptionHTML": "Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API,\nusing the organization_personal_access_tokens: read permission.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "title": "Convert an organization member to outside collaborator", - "category": "orgs", - "subcategory": "outside-collaborators", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "boolean", - "name": "async", - "in": "body", - "description": "When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.
User is getting converted asynchronously
", - "example": null, - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - }, - { - "key": "204", - "request": { - "contentType": "application/json", - "description": "Status code 204, synchronous request", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": null, - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "User was converted
" - } - } - ], - "previews": [], - "descriptionHTML": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
", - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "User is getting converted asynchronously
" - }, - { - "httpStatusCode": "204", - "description": "User was converted
" }, { "httpStatusCode": "403", - "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"Enforcing repository management policies in your enterprise.\"
" + "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "title": "Remove outside collaborator from an organization", - "category": "orgs", - "subcategory": "outside-collaborators", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" - } - } - ], - "previews": [], - "descriptionHTML": "Removing a user from this list will remove them from all the organization's repositories.
", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" }, { - "httpStatusCode": "422", - "description": "Unprocessable Entity if user is a member of the organization
" + "httpStatusCode": "500", + "description": "Internal Error
" } ] } @@ -382361,6 +382943,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -382432,6 +383015,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -406968,6 +407558,7 @@ "description": "A great team.", "privacy": "closed", "permission": "admin", + "notification_setting": "notifications_enabled", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null @@ -408527,6 +409118,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -408643,6 +409237,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -412700,6 +413301,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -414321,6 +414923,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -416527,6 +417136,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -418148,6 +418758,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -420404,6 +421021,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -422025,6 +422643,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -426013,8 +426638,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -426639,8 +427262,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -427280,8 +427901,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -428033,8 +428652,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -428747,8 +429364,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -429402,8 +430017,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -429521,6 +430134,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -429725,6 +430339,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -429841,6 +430458,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -430222,6 +430846,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -431779,6 +432404,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -431895,6 +432523,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -435928,6 +436563,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -437485,6 +438121,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -437601,6 +438240,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -454809,7 +455455,7 @@ "type": "string", "name": "target_commitish", "in": "body", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
" }, { "type": "string", @@ -457896,7 +458542,7 @@ "type": "string", "name": "target_commitish", "in": "body", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
" }, { "type": "string", @@ -476540,6 +477186,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -476574,6 +477221,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -476690,6 +477340,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -485916,7 +486573,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -488235,7 +488892,7 @@ "type": "string", "name": "branch", "in": "body", - "description": "The branch name. Default: the repository’s default branch (usually master)
The branch name. Default: the repository’s default branch.
" }, { "type": "object", @@ -488847,7 +489504,7 @@ "type": "string", "name": "branch", "in": "body", - "description": "The branch name. Default: the repository’s default branch (usually master)
The branch name. Default: the repository’s default branch
" }, { "type": "object", @@ -489164,7 +489821,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -489375,7 +490032,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -496861,7 +497518,7 @@ } ], "previews": [], - "descriptionHTML": "Create a fork for the authenticated user.
\nNote: 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 Cloud Support.
", + "descriptionHTML": "Create a fork for the authenticated user.
\nNote: 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 Cloud Support.
\nNote: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
", "statusCodes": [ { "httpStatusCode": "202", @@ -518254,6 +518911,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -518288,6 +518946,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -518404,6 +519065,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -518533,6 +519201,16 @@ "closed" ] }, + { + "type": "string", + "name": "notification_setting", + "in": "body", + "description": "The notification setting the team has chosen:
\nnotifications_enabled - team members receive notifications when the team is @mentioned notifications_disabled - no one receives notifications\nDefault: notifications_enabledThe notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:\n*notifications_enabled - team members receive notifications when the team is @mentioned
notifications_disabled - no one receives notifications\nDefault: notifications_enabledResponse
", + "example": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -520194,6 +521633,17 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", @@ -520282,694 +521732,11 @@ "closed" ] }, - "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" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at" - ] - }, - "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", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - } - } - }, - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "new team name", - "description": "new team description", - "privacy": "closed" - }, - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "Response
", - "example": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "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, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - } - }, - "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "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" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "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", + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", "examples": [ - "closed" + "notifications_enabled" ] }, "html_url": { @@ -526327,6 +527094,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -526362,6 +527130,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -526478,6 +527249,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -526592,6 +527370,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -526697,6 +527476,17 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", @@ -526785,6 +527575,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -527358,6 +528155,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -527463,6 +528261,17 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", @@ -527551,6 +528360,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -528047,6 +528863,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -528152,6 +528969,17 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", @@ -528240,6 +529068,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -533539,6 +534374,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -533574,6 +534410,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -533690,333 +534529,359 @@ "closed" ] }, - "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": { + "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" + ] + } + } + } + } + ], + "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 child teams endpoint.
if child teams exist
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/user/teams", + "title": "List teams for the authenticated user", + "category": "teams", + "subcategory": "teams", + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + } + } + ], + "schema": { + "type": "array", + "items": { + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] + }, + "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" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "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": [ - "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" - ] - } - } - } - } - ], - "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 child teams endpoint.
if child teams exist
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/user/teams", - "title": "List teams for the authenticated user", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page number of the results to fetch.
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": false, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "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, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "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" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "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" + "notifications_enabled" ] }, "html_url": { @@ -551564,7 +552429,17 @@ }, "emails": { "type": "array", - "items": {} + "items": { + "type": "object", + "properties": { + "email": { + "type": "string" + }, + "verified": { + "type": "boolean" + } + } + } }, "subkeys": { "type": "array", @@ -551866,7 +552741,17 @@ }, "emails": { "type": "array", - "items": {} + "items": { + "type": "object", + "properties": { + "email": { + "type": "string" + }, + "verified": { + "type": "boolean" + } + } + } }, "subkeys": { "type": "array", @@ -552165,7 +553050,17 @@ }, "emails": { "type": "array", - "items": {} + "items": { + "type": "object", + "properties": { + "email": { + "type": "string" + }, + "verified": { + "type": "boolean" + } + } + } }, "subkeys": { "type": "array", @@ -552547,7 +553442,17 @@ }, "emails": { "type": "array", - "items": {} + "items": { + "type": "object", + "properties": { + "email": { + "type": "string" + }, + "verified": { + "type": "boolean" + } + } + } }, "subkeys": { "type": "array", diff --git a/src/rest/data/ghes-3.4/schema.json b/src/rest/data/ghes-3.4/schema.json index d359dbb83d94..e27e1dbfd4c7 100644 --- a/src/rest/data/ghes-3.4/schema.json +++ b/src/rest/data/ghes-3.4/schema.json @@ -28973,6 +28973,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -29257,6 +29258,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -29373,6 +29377,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -99912,6 +99923,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -100028,6 +100042,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -100634,6 +100655,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -100750,6 +100774,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -101281,6 +101312,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -102736,6 +102770,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -102852,6 +102889,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -103458,6 +103502,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -103574,6 +103621,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -104105,6 +104159,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -105589,6 +105646,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -105705,6 +105765,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -106311,6 +106378,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -106427,6 +106497,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -106958,6 +107035,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -108367,6 +108447,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -108452,6 +108533,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -108803,6 +108885,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -108919,6 +109004,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -109525,6 +109617,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -109641,6 +109736,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -110172,6 +110274,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -111093,6 +111198,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -111209,6 +111317,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -111800,6 +111915,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -111916,6 +112034,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -112504,6 +112629,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -113171,6 +113299,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -113428,6 +113557,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -113544,6 +113676,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -114150,6 +114289,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -114266,6 +114408,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -114880,6 +115029,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -115137,6 +115287,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -115253,6 +115406,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -115859,6 +116019,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -115975,6 +116138,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -117606,6 +117776,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -117765,6 +117936,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -119916,6 +120090,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -119950,6 +120125,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -120066,6 +120244,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -120216,6 +120401,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -120250,6 +120436,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -120366,6 +120555,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -120516,6 +120712,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -120550,6 +120747,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -120666,6 +120866,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -120816,6 +121023,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -120850,6 +121058,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -120966,6 +121177,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -122235,7 +122453,7 @@ { "type": "array of objects", "name": "annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\".
", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see \"About status checks\".
", "childParamsGroups": [ { "type": "string", @@ -126074,7 +126292,7 @@ { "type": "array of objects", "name": "annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\".
", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"About status checks\".
", "childParamsGroups": [ { "type": "string", @@ -149147,6 +149365,7 @@ "description": "A great team.", "privacy": "closed", "permission": "admin", + "notification_setting": "notifications_enabled", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null @@ -150706,6 +150925,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -150822,6 +151044,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -167522,6 +167751,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -167875,6 +168105,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -167991,6 +168224,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -168247,6 +168487,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -168586,6 +168827,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -168702,6 +168946,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -169022,6 +169273,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -169361,6 +169613,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -169477,6 +169732,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -176286,6 +176548,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -176324,6 +176587,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -239811,6 +240077,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -239927,6 +240196,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -244685,6 +244961,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -244801,6 +245080,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -250649,6 +250935,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -250765,6 +251054,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -251710,6 +252006,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -251826,6 +252125,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -262715,6 +263021,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -262831,6 +263140,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -263776,6 +264092,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -263892,6 +264211,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -272494,8 +272820,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -275827,15 +276151,10 @@ "example": { "verifiable_password_authentication": true, "packages": [ - "140.82.121.33/32", - "192.30.255.164/31", - "20.200.245.241/32", - "20.233.54.55/32" + "192.0.2.1" ], "dependabot": [ - "18.213.123.130/32", - "3.217.79.163/32", - "3.217.93.44/32" + "192.0.2.1" ], "installed_version": "3.4.0" }, @@ -275856,9 +276175,7 @@ "type": "string" }, "examples": [ - "13.65.0.0/16", - "157.55.204.33/32", - "2a01:111:f403:f90c::/62" + "192.0.2.1" ] }, "dependabot": { @@ -275867,8 +276184,7 @@ "type": "string" }, "examples": [ - "192.168.7.15/32", - "192.168.7.16/32" + "192.0.2.1" ] }, "installed_version": { @@ -313232,6 +313548,7 @@ "description": "A great team.", "privacy": "closed", "permission": "admin", + "notification_setting": "notifications_enabled", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null @@ -314791,6 +315108,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -314907,6 +315227,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -318778,6 +319105,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -320399,6 +320727,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -322599,6 +322934,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -324220,6 +324556,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -326470,6 +326813,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -328091,6 +328435,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -332073,8 +332424,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -332699,8 +333048,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -333340,8 +333687,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -334093,8 +334438,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -334797,8 +335140,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -335452,8 +335793,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -335571,6 +335910,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -335775,6 +336115,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -335891,6 +336234,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -336272,6 +336622,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -337829,6 +338180,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -337945,6 +338299,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -341798,6 +342159,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -343355,6 +343717,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -343471,6 +343836,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -360531,7 +360903,7 @@ "type": "string", "name": "target_commitish", "in": "body", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
" }, { "type": "string", @@ -363576,7 +363948,7 @@ "type": "string", "name": "target_commitish", "in": "body", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
" }, { "type": "string", @@ -381225,6 +381597,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -381259,6 +381632,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -381375,6 +381751,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -389959,7 +390342,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -392278,7 +392661,7 @@ "type": "string", "name": "branch", "in": "body", - "description": "The branch name. Default: the repository’s default branch (usually master)
The branch name. Default: the repository’s default branch.
" }, { "type": "object", @@ -392890,7 +393273,7 @@ "type": "string", "name": "branch", "in": "body", - "description": "The branch name. Default: the repository’s default branch (usually master)
The branch name. Default: the repository’s default branch
" }, { "type": "object", @@ -393207,7 +393590,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -393418,7 +393801,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -400497,7 +400880,7 @@ } ], "previews": [], - "descriptionHTML": "Create a fork for the authenticated user.
\nNote: 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.
", + "descriptionHTML": "Create a fork for the authenticated user.
\nNote: 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.
\nNote: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
", "statusCodes": [ { "httpStatusCode": "202", @@ -411691,6 +412074,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -411725,6 +412109,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -411841,6 +412228,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -411970,6 +412364,16 @@ "closed" ] }, + { + "type": "string", + "name": "notification_setting", + "in": "body", + "description": "The notification setting the team has chosen:
\nnotifications_enabled - team members receive notifications when the team is @mentioned notifications_disabled - no one receives notifications\nDefault: notifications_enabledThe notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:\n*notifications_enabled - team members receive notifications when the team is @mentioned
notifications_disabled - no one receives notifications\nDefault: notifications_enabledAdds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\".
", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see \"About status checks\".
", "childParamsGroups": [ { "type": "string", @@ -131748,7 +131966,7 @@ { "type": "array of objects", "name": "annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\".
", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"About status checks\".
", "childParamsGroups": [ { "type": "string", @@ -156295,6 +156513,7 @@ "description": "A great team.", "privacy": "closed", "permission": "admin", + "notification_setting": "notifications_enabled", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null @@ -157854,6 +158073,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -157970,6 +158192,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -174682,6 +174911,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -175035,6 +175265,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -175151,6 +175384,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -175407,6 +175647,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -175746,6 +175987,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -175862,6 +176106,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -176182,6 +176433,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -176521,6 +176773,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -176637,6 +176892,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -183446,6 +183708,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -183484,6 +183747,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -246971,6 +247237,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -247087,6 +247356,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -251845,6 +252121,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -251961,6 +252240,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -257809,6 +258095,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -257925,6 +258214,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -258870,6 +259166,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -258986,6 +259285,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -269875,6 +270181,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -269991,6 +270300,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -270936,6 +271252,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -271052,6 +271371,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -279654,8 +279980,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -282987,15 +283311,10 @@ "example": { "verifiable_password_authentication": true, "packages": [ - "140.82.121.33/32", - "192.30.255.164/31", - "20.200.245.241/32", - "20.233.54.55/32" + "192.0.2.1" ], "dependabot": [ - "18.213.123.130/32", - "3.217.79.163/32", - "3.217.93.44/32" + "192.0.2.1" ], "installed_version": "3.5.0" }, @@ -283016,9 +283335,7 @@ "type": "string" }, "examples": [ - "13.65.0.0/16", - "157.55.204.33/32", - "2a01:111:f403:f90c::/62" + "192.0.2.1" ] }, "dependabot": { @@ -283027,8 +283344,7 @@ "type": "string" }, "examples": [ - "192.168.7.15/32", - "192.168.7.16/32" + "192.0.2.1" ] }, "installed_version": { @@ -320404,6 +320720,7 @@ "description": "A great team.", "privacy": "closed", "permission": "admin", + "notification_setting": "notifications_enabled", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null @@ -321963,6 +322280,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -322079,6 +322399,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -325950,6 +326277,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -327571,6 +327899,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -329771,6 +330106,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -331392,6 +331728,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -333642,6 +333985,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -335263,6 +335607,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -339245,8 +339596,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -339871,8 +340220,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -340512,8 +340859,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -341265,8 +341610,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -341969,8 +342312,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -342624,8 +342965,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -342743,6 +343082,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -342947,6 +343287,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -343063,6 +343406,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -343444,6 +343794,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -345001,6 +345352,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -345117,6 +345471,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -348970,6 +349331,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -350527,6 +350889,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -350643,6 +351008,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -367642,7 +368014,7 @@ "type": "string", "name": "target_commitish", "in": "body", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
" }, { "type": "string", @@ -370687,7 +371059,7 @@ "type": "string", "name": "target_commitish", "in": "body", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
" }, { "type": "string", @@ -388510,6 +388882,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -388544,6 +388917,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -388660,6 +389036,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -397262,7 +397645,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -399581,7 +399964,7 @@ "type": "string", "name": "branch", "in": "body", - "description": "The branch name. Default: the repository’s default branch (usually master)
The branch name. Default: the repository’s default branch.
" }, { "type": "object", @@ -400193,7 +400576,7 @@ "type": "string", "name": "branch", "in": "body", - "description": "The branch name. Default: the repository’s default branch (usually master)
The branch name. Default: the repository’s default branch
" }, { "type": "object", @@ -400510,7 +400893,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -400721,7 +401104,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -407806,7 +408189,7 @@ } ], "previews": [], - "descriptionHTML": "Create a fork for the authenticated user.
\nNote: 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.
", + "descriptionHTML": "Create a fork for the authenticated user.
\nNote: 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.
\nNote: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
", "statusCodes": [ { "httpStatusCode": "202", @@ -419341,6 +419724,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -419375,6 +419759,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -419491,6 +419878,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -419620,6 +420014,16 @@ "closed" ] }, + { + "type": "string", + "name": "notification_setting", + "in": "body", + "description": "The notification setting the team has chosen:
\nnotifications_enabled - team members receive notifications when the team is @mentioned notifications_disabled - no one receives notifications\nDefault: notifications_enabledThe notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:\n*notifications_enabled - team members receive notifications when the team is @mentioned
notifications_disabled - no one receives notifications\nDefault: notifications_enabledAdds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\".
", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see \"About status checks\".
", "childParamsGroups": [ { "type": "string", @@ -134265,7 +134483,7 @@ { "type": "array of objects", "name": "annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\".
", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"About status checks\".
", "childParamsGroups": [ { "type": "string", @@ -158912,6 +159130,7 @@ "description": "A great team.", "privacy": "closed", "permission": "admin", + "notification_setting": "notifications_enabled", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null @@ -160471,6 +160690,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -160587,6 +160809,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -177720,6 +177949,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -178073,6 +178303,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -178189,6 +178422,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -178445,6 +178685,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -178784,6 +179025,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -178900,6 +179144,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -179220,6 +179471,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -179559,6 +179811,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -179675,6 +179930,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -186484,6 +186746,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -186522,6 +186785,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -256126,6 +256392,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -256242,6 +256511,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -261082,6 +261358,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -261198,6 +261477,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -267046,6 +267332,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -267162,6 +267451,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -268107,6 +268403,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -268223,6 +268522,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -279112,6 +279418,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -279228,6 +279537,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -280173,6 +280489,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -280289,6 +280608,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -288973,8 +289299,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -292306,15 +292630,10 @@ "example": { "verifiable_password_authentication": true, "packages": [ - "140.82.121.33/32", - "192.30.255.164/31", - "20.200.245.241/32", - "20.233.54.55/32" + "192.0.2.1" ], "dependabot": [ - "18.213.123.130/32", - "3.217.79.163/32", - "3.217.93.44/32" + "192.0.2.1" ], "installed_version": "3.6.0" }, @@ -292335,9 +292654,7 @@ "type": "string" }, "examples": [ - "13.65.0.0/16", - "157.55.204.33/32", - "2a01:111:f403:f90c::/62" + "192.0.2.1" ] }, "dependabot": { @@ -292346,8 +292663,7 @@ "type": "string" }, "examples": [ - "192.168.7.15/32", - "192.168.7.16/32" + "192.0.2.1" ] }, "installed_version": { @@ -330166,6 +330482,7 @@ "description": "A great team.", "privacy": "closed", "permission": "admin", + "notification_setting": "notifications_enabled", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null @@ -331725,6 +332042,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -331841,6 +332161,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -335876,6 +336203,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -337497,6 +337825,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -339703,6 +340038,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -341324,6 +341660,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -343580,6 +343923,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -345201,6 +345545,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -349189,8 +349540,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -349815,8 +350164,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -350456,8 +350803,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -351209,8 +351554,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -351913,8 +352256,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -352568,8 +352909,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -352687,6 +353026,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -352891,6 +353231,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -353007,6 +353350,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -353388,6 +353738,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -354945,6 +355296,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -355061,6 +355415,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -359078,6 +359439,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -360635,6 +360997,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -360751,6 +361116,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -377914,7 +378286,7 @@ "type": "string", "name": "target_commitish", "in": "body", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
" }, { "type": "string", @@ -380959,7 +381331,7 @@ "type": "string", "name": "target_commitish", "in": "body", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
" }, { "type": "string", @@ -399487,6 +399859,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -399521,6 +399894,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -399637,6 +400013,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -408503,7 +408886,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -410822,7 +411205,7 @@ "type": "string", "name": "branch", "in": "body", - "description": "The branch name. Default: the repository’s default branch (usually master)
The branch name. Default: the repository’s default branch.
" }, { "type": "object", @@ -411434,7 +411817,7 @@ "type": "string", "name": "branch", "in": "body", - "description": "The branch name. Default: the repository’s default branch (usually master)
The branch name. Default: the repository’s default branch
" }, { "type": "object", @@ -411751,7 +412134,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -411962,7 +412345,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -419359,7 +419742,7 @@ } ], "previews": [], - "descriptionHTML": "Create a fork for the authenticated user.
\nNote: 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.
", + "descriptionHTML": "Create a fork for the authenticated user.
\nNote: 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.
\nNote: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
", "statusCodes": [ { "httpStatusCode": "202", @@ -431995,6 +432378,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -432029,6 +432413,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -432145,6 +432532,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -432274,6 +432668,16 @@ "closed" ] }, + { + "type": "string", + "name": "notification_setting", + "in": "body", + "description": "The notification setting the team has chosen:
\nnotifications_enabled - team members receive notifications when the team is @mentioned notifications_disabled - no one receives notifications\nDefault: notifications_enabledThe notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:\n*notifications_enabled - team members receive notifications when the team is @mentioned
notifications_disabled - no one receives notifications\nDefault: notifications_enabledAdds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\".
", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see \"About status checks\".
", "childParamsGroups": [ { "type": "string", @@ -135236,7 +135454,7 @@ { "type": "array of objects", "name": "annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\".
", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"About status checks\".
", "childParamsGroups": [ { "type": "string", @@ -161344,6 +161562,7 @@ "description": "A great team.", "privacy": "closed", "permission": "admin", + "notification_setting": "notifications_enabled", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null @@ -162903,6 +163122,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -163019,6 +163241,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -180531,6 +180760,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -180884,6 +181114,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -181000,6 +181233,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -181256,6 +181496,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -181595,6 +181836,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -181711,6 +181955,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -182031,6 +182282,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -182370,6 +182622,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -182486,6 +182741,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -189295,6 +189557,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -189333,6 +189596,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -259037,6 +259303,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -259153,6 +259422,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -264001,6 +264277,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -264117,6 +264396,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -269965,6 +270251,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -270081,6 +270370,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -271026,6 +271322,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -271142,6 +271441,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -282031,6 +282337,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -282147,6 +282456,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -283092,6 +283408,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -283208,6 +283527,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -291900,8 +292226,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -295233,15 +295557,10 @@ "example": { "verifiable_password_authentication": true, "packages": [ - "140.82.121.33/32", - "192.30.255.164/31", - "20.200.245.241/32", - "20.233.54.55/32" + "192.0.2.1" ], "dependabot": [ - "18.213.123.130/32", - "3.217.79.163/32", - "3.217.93.44/32" + "192.0.2.1" ], "installed_version": "3.7.0" }, @@ -295262,9 +295581,7 @@ "type": "string" }, "examples": [ - "13.65.0.0/16", - "157.55.204.33/32", - "2a01:111:f403:f90c::/62" + "192.0.2.1" ] }, "dependabot": { @@ -295273,8 +295590,7 @@ "type": "string" }, "examples": [ - "192.168.7.15/32", - "192.168.7.16/32" + "192.0.2.1" ] }, "installed_version": { @@ -322891,6 +323207,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -322962,6 +323279,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -333782,6 +334106,7 @@ "description": "A great team.", "privacy": "closed", "permission": "admin", + "notification_setting": "notifications_enabled", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null @@ -335341,6 +335666,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -335457,6 +335785,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -339508,6 +339843,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -341129,6 +341465,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -343335,6 +343678,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -344956,6 +345300,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -347212,6 +347563,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -348833,6 +349185,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -352821,8 +353180,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -353447,8 +353804,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -354088,8 +354443,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -354841,8 +355194,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -355545,8 +355896,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -356200,8 +356549,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -356319,6 +356666,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -356523,6 +356871,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -356639,6 +356990,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -357020,6 +357378,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -358577,6 +358936,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -358693,6 +359055,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -362726,6 +363095,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -364283,6 +364653,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -364399,6 +364772,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -381578,7 +381958,7 @@ "type": "string", "name": "target_commitish", "in": "body", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
" }, { "type": "string", @@ -384623,7 +385003,7 @@ "type": "string", "name": "target_commitish", "in": "body", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
" }, { "type": "string", @@ -403222,6 +403602,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -403256,6 +403637,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -403372,6 +403756,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -412305,7 +412696,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -414624,7 +415015,7 @@ "type": "string", "name": "branch", "in": "body", - "description": "The branch name. Default: the repository’s default branch (usually master)
The branch name. Default: the repository’s default branch.
" }, { "type": "object", @@ -415236,7 +415627,7 @@ "type": "string", "name": "branch", "in": "body", - "description": "The branch name. Default: the repository’s default branch (usually master)
The branch name. Default: the repository’s default branch
" }, { "type": "object", @@ -415553,7 +415944,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -415764,7 +416155,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -423206,7 +423597,7 @@ } ], "previews": [], - "descriptionHTML": "Create a fork for the authenticated user.
\nNote: 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.
", + "descriptionHTML": "Create a fork for the authenticated user.
\nNote: 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.
\nNote: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
", "statusCodes": [ { "httpStatusCode": "202", @@ -435895,6 +436286,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -435929,6 +436321,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -436045,6 +436440,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -436174,6 +436576,16 @@ "closed" ] }, + { + "type": "string", + "name": "notification_setting", + "in": "body", + "description": "The notification setting the team has chosen:
\nnotifications_enabled - team members receive notifications when the team is @mentioned notifications_disabled - no one receives notifications\nDefault: notifications_enabledThe notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:\n*notifications_enabled - team members receive notifications when the team is @mentioned
notifications_disabled - no one receives notifications\nDefault: notifications_enabledAdds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\".
", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see \"About status checks\".
", "childParamsGroups": [ { "type": "string", @@ -150207,7 +150425,7 @@ { "type": "array of objects", "name": "annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\".
", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"About status checks\".
", "childParamsGroups": [ { "type": "string", @@ -176765,6 +176983,7 @@ "description": "A great team.", "privacy": "closed", "permission": "admin", + "notification_setting": "notifications_enabled", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null @@ -178324,6 +178543,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -178440,6 +178662,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -202389,6 +202618,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -202742,6 +202972,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -202858,6 +203091,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -203114,6 +203354,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -203453,6 +203694,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -203569,6 +203813,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -203889,6 +204140,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -204228,6 +204480,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -204344,6 +204599,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -211380,6 +211642,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -211418,6 +211681,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -281146,6 +281412,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -281262,6 +281531,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -286110,6 +286386,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -286226,6 +286505,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -292074,6 +292360,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -292190,6 +292479,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -293135,6 +293431,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -293251,6 +293550,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -304140,6 +304446,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -304256,6 +304565,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -305201,6 +305517,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -305317,6 +305636,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -314009,8 +314335,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -317342,15 +317666,10 @@ "example": { "verifiable_password_authentication": true, "packages": [ - "140.82.121.33/32", - "192.30.255.164/31", - "20.200.245.241/32", - "20.233.54.55/32" + "192.0.2.1" ], "dependabot": [ - "18.213.123.130/32", - "3.217.79.163/32", - "3.217.93.44/32" + "192.0.2.1" ], "installed_version": "3.8.0" }, @@ -317371,9 +317690,7 @@ "type": "string" }, "examples": [ - "13.65.0.0/16", - "157.55.204.33/32", - "2a01:111:f403:f90c::/62" + "192.0.2.1" ] }, "dependabot": { @@ -317382,8 +317699,7 @@ "type": "string" }, "examples": [ - "192.168.7.15/32", - "192.168.7.16/32" + "192.0.2.1" ] }, "installed_version": { @@ -345232,6 +345548,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -345303,6 +345620,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -356123,6 +356447,7 @@ "description": "A great team.", "privacy": "closed", "permission": "admin", + "notification_setting": "notifications_enabled", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null @@ -357682,6 +358007,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -357798,6 +358126,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -361855,6 +362190,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -363476,6 +363812,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -365682,6 +366025,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -367303,6 +367647,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -369559,6 +369910,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" @@ -371180,6 +371532,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -375168,8 +375527,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -375794,8 +376151,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -376435,8 +376790,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -377188,8 +377541,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -377892,8 +378243,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -378547,8 +378896,6 @@ "pull_request_review_id", "diff_hunk", "path", - "position", - "original_position", "commit_id", "original_commit_id", "user", @@ -378666,6 +379013,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -378870,6 +379218,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -378986,6 +379337,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -379367,6 +379725,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -380924,6 +381283,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -381040,6 +381402,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -385073,6 +385442,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -386630,6 +387000,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -386746,6 +387119,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -403925,7 +404305,7 @@ "type": "string", "name": "target_commitish", "in": "body", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
" }, { "type": "string", @@ -406982,7 +407362,7 @@ "type": "string", "name": "target_commitish", "in": "body", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
" }, { "type": "string", @@ -425648,6 +426028,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -425682,6 +426063,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -425798,6 +426182,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -434874,7 +435265,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -437193,7 +437584,7 @@ "type": "string", "name": "branch", "in": "body", - "description": "The branch name. Default: the repository’s default branch (usually master)
The branch name. Default: the repository’s default branch.
" }, { "type": "object", @@ -437805,7 +438196,7 @@ "type": "string", "name": "branch", "in": "body", - "description": "The branch name. Default: the repository’s default branch (usually master)
The branch name. Default: the repository’s default branch
" }, { "type": "object", @@ -438122,7 +438513,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -438333,7 +438724,7 @@ }, { "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
The name of the commit/branch/tag. Default: the repository’s default branch.
", "in": "query", "required": false, "schema": { @@ -445819,7 +446210,7 @@ } ], "previews": [], - "descriptionHTML": "Create a fork for the authenticated user.
\nNote: 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.
", + "descriptionHTML": "Create a fork for the authenticated user.
\nNote: 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.
\nNote: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
", "statusCodes": [ { "httpStatusCode": "202", @@ -458700,6 +459091,7 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -458734,6 +459126,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -458850,6 +459245,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -458979,6 +459381,16 @@ "closed" ] }, + { + "type": "string", + "name": "notification_setting", + "in": "body", + "description": "The notification setting the team has chosen:
\nnotifications_enabled - team members receive notifications when the team is @mentioned notifications_disabled - no one receives notifications\nDefault: notifications_enabledThe notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:\n*notifications_enabled - team members receive notifications when the team is @mentioned
notifications_disabled - no one receives notifications\nDefault: notifications_enabledWhether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -68857,6 +68867,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -69169,6 +69188,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -69204,6 +69233,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -69232,7 +69270,7 @@ } }, "merge_group": { - "default": { + "checks_requested": { "descriptionHtml": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.
\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.
", "summaryHtml": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.
\nNote: The pull request merge queue feature is currently in public beta and subject to change.
", "bodyParameters": [ @@ -69242,6 +69280,9 @@ "in": "body", "description": "", "isRequired": true, + "enum": [ + "checks_requested" + ], "childParamsGroups": [] }, { @@ -69401,7 +69442,7 @@ "availability": [ "app" ], - "action": "default", + "action": "checks_requested", "category": "merge_group" } }, @@ -94738,6 +94779,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -98046,6 +98092,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -108083,6 +108134,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -124518,6 +124574,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -127826,6 +127887,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -131134,6 +131200,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -196884,6 +196955,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -196919,6 +197000,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -197100,6 +197190,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -197135,6 +197235,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -197315,6 +197424,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -197350,6 +197469,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -197529,6 +197657,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -197564,6 +197702,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -197651,6 +197798,19 @@ } ] }, + { + "type": "object", + "name": "notification_setting", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "The previous version of the team's notification setting if the action was edited.
Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -197865,6 +198035,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -198045,6 +198224,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -198080,6 +198269,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", diff --git a/src/webhooks/data/ghae/schema.json b/src/webhooks/data/ghae/schema.json index 950e8fc35598..cd74e784784d 100644 --- a/src/webhooks/data/ghae/schema.json +++ b/src/webhooks/data/ghae/schema.json @@ -65602,6 +65602,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -65637,6 +65647,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -65949,6 +65968,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -65984,6 +66013,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -66011,180 +66049,6 @@ "category": "membership" } }, - "merge_group": { - "default": { - "descriptionHtml": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.
\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.
", - "summaryHtml": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.
\nNote: The pull request merge queue feature is currently in public beta and subject to change.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "merge_group", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "head_sha", - "description": "The SHA of the merge group.
", - "isRequired": true - }, - { - "type": "string", - "name": "head_ref", - "description": "The full ref of the merge group.
", - "isRequired": true - }, - { - "type": "string", - "name": "base_sha", - "description": "The SHA of the merge group's parent commit.
", - "isRequired": true - }, - { - "type": "string", - "name": "base_ref", - "description": "The full ref of the branch the merge group will be merged into.
", - "isRequired": true - }, - { - "type": "object", - "name": "head_commit", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "author", - "description": "Metaproperties for Git author/committer information.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The git author's name.
", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "object", - "name": "committer", - "description": "Metaproperties for Git author/committer information.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The git author's name.
", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "string", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "message", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "timestamp", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tree_id", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "A GitHub organization.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "A repository on GitHub.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "default", - "category": "merge_group" - } - }, "meta": { "deleted": { "descriptionHtml": "The webhook was deleted.
", @@ -88033,6 +87897,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -91341,6 +91210,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -98159,6 +98033,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -111382,6 +111261,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -114690,6 +114574,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -117998,6 +117887,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -179824,6 +179718,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -179859,6 +179763,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -180040,6 +179953,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -180075,6 +179998,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -180255,6 +180187,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -180290,6 +180232,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -180469,6 +180420,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -180504,6 +180465,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -180591,6 +180561,19 @@ } ] }, + { + "type": "object", + "name": "notification_setting", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "The previous version of the team's notification setting if the action was edited.
Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -180805,6 +180798,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -180985,6 +180987,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -181020,6 +181032,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index 00abf581ee7c..385c92b15c21 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -68822,6 +68822,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -68857,6 +68867,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -69169,6 +69188,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -69204,6 +69233,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -69232,7 +69270,7 @@ } }, "merge_group": { - "default": { + "checks_requested": { "descriptionHtml": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.
\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.
", "summaryHtml": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.
\nNote: The pull request merge queue feature is currently in public beta and subject to change.
", "bodyParameters": [ @@ -69242,6 +69280,9 @@ "in": "body", "description": "", "isRequired": true, + "enum": [ + "checks_requested" + ], "childParamsGroups": [] }, { @@ -69401,7 +69442,7 @@ "availability": [ "app" ], - "action": "default", + "action": "checks_requested", "category": "merge_group" } }, @@ -94738,6 +94779,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -98046,6 +98092,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -108083,6 +108134,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -124518,6 +124574,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -127826,6 +127887,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -131134,6 +131200,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -196884,6 +196955,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -196919,6 +197000,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -197100,6 +197190,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -197135,6 +197235,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -197315,6 +197424,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -197350,6 +197469,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -197529,6 +197657,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -197564,6 +197702,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -197651,6 +197798,19 @@ } ] }, + { + "type": "object", + "name": "notification_setting", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "The previous version of the team's notification setting if the action was edited.
Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -197865,6 +198035,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -198045,6 +198224,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -198080,6 +198269,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", diff --git a/src/webhooks/data/ghes-3.7/schema.json b/src/webhooks/data/ghes-3.7/schema.json index dcb862454a06..3c149308409d 100644 --- a/src/webhooks/data/ghes-3.7/schema.json +++ b/src/webhooks/data/ghes-3.7/schema.json @@ -65833,6 +65833,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -65868,6 +65878,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -66180,6 +66199,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -66215,6 +66244,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -66242,180 +66280,6 @@ "category": "membership" } }, - "merge_group": { - "default": { - "descriptionHtml": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.
\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.
", - "summaryHtml": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.
\nNote: The pull request merge queue feature is currently in public beta and subject to change.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "merge_group", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "head_sha", - "description": "The SHA of the merge group.
", - "isRequired": true - }, - { - "type": "string", - "name": "head_ref", - "description": "The full ref of the merge group.
", - "isRequired": true - }, - { - "type": "string", - "name": "base_sha", - "description": "The SHA of the merge group's parent commit.
", - "isRequired": true - }, - { - "type": "string", - "name": "base_ref", - "description": "The full ref of the branch the merge group will be merged into.
", - "isRequired": true - }, - { - "type": "object", - "name": "head_commit", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "author", - "description": "Metaproperties for Git author/committer information.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The git author's name.
", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "object", - "name": "committer", - "description": "Metaproperties for Git author/committer information.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The git author's name.
", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "string", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "message", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "timestamp", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tree_id", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "A GitHub organization.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "A repository on GitHub.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "default", - "category": "merge_group" - } - }, "meta": { "deleted": { "descriptionHtml": "The webhook was deleted.
", @@ -87412,6 +87276,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -90720,6 +90589,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -97538,6 +97412,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -110761,6 +110640,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -114069,6 +113953,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -117377,6 +117266,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -181616,6 +181510,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -181651,6 +181555,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -181832,6 +181745,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -181867,6 +181790,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -182047,6 +181979,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -182082,6 +182024,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -182261,6 +182212,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -182296,6 +182257,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -182383,6 +182353,19 @@ } ] }, + { + "type": "object", + "name": "notification_setting", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "The previous version of the team's notification setting if the action was edited.
Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -182597,6 +182590,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -182777,6 +182779,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -182812,6 +182824,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", diff --git a/src/webhooks/data/ghes-3.8/schema.json b/src/webhooks/data/ghes-3.8/schema.json index 4b68a8358b87..64794957a9cf 100644 --- a/src/webhooks/data/ghes-3.8/schema.json +++ b/src/webhooks/data/ghes-3.8/schema.json @@ -66053,6 +66053,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -66088,6 +66098,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -66400,6 +66419,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -66435,6 +66464,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -66462,180 +66500,6 @@ "category": "membership" } }, - "merge_group": { - "default": { - "descriptionHtml": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.
\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.
", - "summaryHtml": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.
\nNote: The pull request merge queue feature is currently in public beta and subject to change.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "merge_group", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "head_sha", - "description": "The SHA of the merge group.
", - "isRequired": true - }, - { - "type": "string", - "name": "head_ref", - "description": "The full ref of the merge group.
", - "isRequired": true - }, - { - "type": "string", - "name": "base_sha", - "description": "The SHA of the merge group's parent commit.
", - "isRequired": true - }, - { - "type": "string", - "name": "base_ref", - "description": "The full ref of the branch the merge group will be merged into.
", - "isRequired": true - }, - { - "type": "object", - "name": "head_commit", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "author", - "description": "Metaproperties for Git author/committer information.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The git author's name.
", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "object", - "name": "committer", - "description": "Metaproperties for Git author/committer information.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The git author's name.
", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "string", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "message", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "timestamp", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tree_id", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "A GitHub organization.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "A repository on GitHub.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "default", - "category": "merge_group" - } - }, "meta": { "deleted": { "descriptionHtml": "The webhook was deleted.
", @@ -87632,6 +87496,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -90940,6 +90809,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -97758,6 +97632,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -110981,6 +110860,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -114289,6 +114173,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -117597,6 +117486,11 @@ "name": "privacy", "description": "The level of privacy this team should have
" }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, { "type": "string", "name": "html_url", @@ -181859,6 +181753,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -181894,6 +181798,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -182075,6 +181988,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -182110,6 +182033,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -182290,6 +182222,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -182325,6 +182267,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -182504,6 +182455,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -182539,6 +182500,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -182626,6 +182596,19 @@ } ] }, + { + "type": "object", + "name": "notification_setting", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "The previous version of the team's notification setting if the action was edited.
Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -182840,6 +182833,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -183020,6 +183022,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -183055,6 +183067,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 87185b5e8bd8..db0507680629 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "e27c8f10a2208e6a8df88e64d2b40c9c7a1ecd2d" + "sha": "e462c64f50b84f040ac76cd2205984ddf151b67f" } \ No newline at end of file