From 769413ad5c5ecc39843df6e4757484783a0d400b Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Thu, 27 Jun 2024 12:12:32 -0700 Subject: [PATCH] Update OpenAPI Description (#51459) --- .../data/fpt-2022-11-28/fine-grained-pat.json | 6 - .../fpt-2022-11-28/server-to-server-rest.json | 6 - .../fpt-2022-11-28/user-to-server-rest.json | 6 - .../ghec-2022-11-28/fine-grained-pat.json | 6 - .../server-to-server-rest.json | 6 - .../ghec-2022-11-28/user-to-server-rest.json | 6 - .../fine-grained-pat.json | 6 - .../server-to-server-rest.json | 6 - .../user-to-server-rest.json | 6 - .../fine-grained-pat.json | 6 - .../server-to-server-rest.json | 6 - .../user-to-server-rest.json | 6 - .../fine-grained-pat.json | 6 - .../server-to-server-rest.json | 6 - .../user-to-server-rest.json | 6 - .../fine-grained-pat.json | 6 - .../server-to-server-rest.json | 6 - .../user-to-server-rest.json | 6 - .../ghes-3.9-2022-11-28/fine-grained-pat.json | 6 - .../server-to-server-rest.json | 6 - .../user-to-server-rest.json | 6 - src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 1719 +++++++++++++++- src/rest/data/ghec-2022-11-28/schema.json | 1723 +++++++++++++++- .../data/ghes-3.10-2022-11-28/schema.json | 1579 ++++++++++++++- .../data/ghes-3.11-2022-11-28/schema.json | 1579 ++++++++++++++- .../data/ghes-3.12-2022-11-28/schema.json | 1579 ++++++++++++++- .../data/ghes-3.13-2022-11-28/schema.json | 1755 ++++++++++++++++- src/rest/data/ghes-3.9-2022-11-28/schema.json | 1579 ++++++++++++++- src/rest/lib/config.json | 2 +- src/webhooks/data/fpt/schema.json | 817 ++++++++ src/webhooks/data/ghec/schema.json | 817 ++++++++ src/webhooks/lib/config.json | 2 +- 33 files changed, 12621 insertions(+), 658 deletions(-) diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json index d2b58abed8..9cc081809c 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json @@ -4890,12 +4890,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-attestations", "subcategory": "attestations", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json index 1e2b2e2dde..f74857ab36 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json @@ -4212,12 +4212,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-attestations", "subcategory": "attestations", diff --git a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json index d2b58abed8..9cc081809c 100644 --- a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json @@ -4890,12 +4890,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-attestations", "subcategory": "attestations", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json index 04012ac718..065b33df58 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json @@ -5292,12 +5292,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-attestations", "subcategory": "attestations", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json index 6b1666e6b1..ab4e091e1d 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json @@ -4614,12 +4614,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-attestations", "subcategory": "attestations", diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json index 04012ac718..065b33df58 100644 --- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json @@ -5292,12 +5292,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-attestations", "subcategory": "attestations", diff --git a/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat.json index e7ccd1b495..fbcb3655a3 100644 --- a/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat.json @@ -4106,12 +4106,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-followers-of-a-user", "subcategory": "followers", diff --git a/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-rest.json index 8d04c39635..2482a50ac0 100644 --- a/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-rest.json @@ -3744,12 +3744,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-followers-of-a-user", "subcategory": "followers", diff --git a/src/github-apps/data/ghes-3.10-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.10-2022-11-28/user-to-server-rest.json index e7ccd1b495..fbcb3655a3 100644 --- a/src/github-apps/data/ghes-3.10-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.10-2022-11-28/user-to-server-rest.json @@ -4106,12 +4106,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-followers-of-a-user", "subcategory": "followers", diff --git a/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat.json index 10abe0d521..14a4d63b7b 100644 --- a/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat.json @@ -4192,12 +4192,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-followers-of-a-user", "subcategory": "followers", diff --git a/src/github-apps/data/ghes-3.11-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.11-2022-11-28/server-to-server-rest.json index 16faf95d22..dbca5fd6b8 100644 --- a/src/github-apps/data/ghes-3.11-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.11-2022-11-28/server-to-server-rest.json @@ -3830,12 +3830,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-followers-of-a-user", "subcategory": "followers", diff --git a/src/github-apps/data/ghes-3.11-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.11-2022-11-28/user-to-server-rest.json index 10abe0d521..14a4d63b7b 100644 --- a/src/github-apps/data/ghes-3.11-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.11-2022-11-28/user-to-server-rest.json @@ -4192,12 +4192,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-followers-of-a-user", "subcategory": "followers", diff --git a/src/github-apps/data/ghes-3.12-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.12-2022-11-28/fine-grained-pat.json index 95c3ef8b0d..a4b88e77e3 100644 --- a/src/github-apps/data/ghes-3.12-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.12-2022-11-28/fine-grained-pat.json @@ -4222,12 +4222,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-followers-of-a-user", "subcategory": "followers", diff --git a/src/github-apps/data/ghes-3.12-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.12-2022-11-28/server-to-server-rest.json index 9b6724f258..7d163d7321 100644 --- a/src/github-apps/data/ghes-3.12-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.12-2022-11-28/server-to-server-rest.json @@ -3860,12 +3860,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-followers-of-a-user", "subcategory": "followers", diff --git a/src/github-apps/data/ghes-3.12-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.12-2022-11-28/user-to-server-rest.json index 95c3ef8b0d..a4b88e77e3 100644 --- a/src/github-apps/data/ghes-3.12-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.12-2022-11-28/user-to-server-rest.json @@ -4222,12 +4222,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-followers-of-a-user", "subcategory": "followers", diff --git a/src/github-apps/data/ghes-3.13-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.13-2022-11-28/fine-grained-pat.json index 89d8fea4f3..4073a1c518 100644 --- a/src/github-apps/data/ghes-3.13-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.13-2022-11-28/fine-grained-pat.json @@ -4372,12 +4372,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-followers-of-a-user", "subcategory": "followers", diff --git a/src/github-apps/data/ghes-3.13-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.13-2022-11-28/server-to-server-rest.json index 534ebe6096..d65ae971b7 100644 --- a/src/github-apps/data/ghes-3.13-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.13-2022-11-28/server-to-server-rest.json @@ -4010,12 +4010,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-followers-of-a-user", "subcategory": "followers", diff --git a/src/github-apps/data/ghes-3.13-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.13-2022-11-28/user-to-server-rest.json index 89d8fea4f3..4073a1c518 100644 --- a/src/github-apps/data/ghes-3.13-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.13-2022-11-28/user-to-server-rest.json @@ -4372,12 +4372,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-followers-of-a-user", "subcategory": "followers", diff --git a/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat.json index dee659738e..b39f293596 100644 --- a/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat.json @@ -4010,12 +4010,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-followers-of-a-user", "subcategory": "followers", diff --git a/src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-rest.json index cceb8e942e..33678edac7 100644 --- a/src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-rest.json @@ -3642,12 +3642,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-followers-of-a-user", "subcategory": "followers", diff --git a/src/github-apps/data/ghes-3.9-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.9-2022-11-28/user-to-server-rest.json index dee659738e..b39f293596 100644 --- a/src/github-apps/data/ghes-3.9-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.9-2022-11-28/user-to-server-rest.json @@ -4010,12 +4010,6 @@ "verb": "get", "requestPath": "/users" }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, { "slug": "list-followers-of-a-user", "subcategory": "followers", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 8a604fbeba..a6c3b71d4e 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "d2303fdde41a01ecb82983c478eba68dd73f8dcf" + "sha": "3c07521af936565853d6ba44db0ca6598fa90c8f" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index f4947aba1f..7417e77fdb 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -20565,7 +20565,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -20586,7 +20587,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -20621,7 +20623,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -23288,7 +23291,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -23309,7 +23313,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -23344,7 +23349,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -26549,7 +26555,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -26570,7 +26577,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -26605,7 +26613,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -29428,6 +29437,7 @@ "id": { "description": "The id of the environment.", "type": "integer", + "format": "int64", "examples": [ 56780428 ] @@ -30057,6 +30067,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -31701,7 +31712,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -31722,7 +31734,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -31757,7 +31770,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -85032,7 +85046,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -96288,7 +96303,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -97299,7 +97315,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -124015,7 +124032,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -124036,7 +124054,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -124071,7 +124090,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -125234,7 +125254,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -125255,7 +125276,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -125290,7 +125312,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -126466,7 +126489,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -126487,7 +126511,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -126522,7 +126547,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -127933,7 +127959,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -127954,7 +127981,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -127989,7 +128017,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -129537,7 +129566,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -129558,7 +129588,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -129593,7 +129624,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -130854,7 +130886,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -130875,7 +130908,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -130910,7 +130944,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -131899,7 +131934,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -131920,7 +131956,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -131955,7 +131992,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -133700,7 +133738,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -133721,7 +133760,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -133756,7 +133796,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -136734,7 +136775,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -136755,7 +136797,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -136790,7 +136833,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -138607,7 +138651,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -138628,7 +138673,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -138663,7 +138709,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -142255,10 +142302,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -143540,10 +143587,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -144140,10 +144187,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -144436,10 +144483,10 @@ "in": "body", "description": "

Required when the state is dismissed. The reason for dismissing or closing the alert.

", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, { @@ -144793,10 +144840,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -203389,6 +203436,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -229029,7 +229077,8 @@ "downloadLocation": "NOASSERTION", "filesAnalyzed": false, "licenseConcluded": "MIT", - "licenseDeclared": "MIT" + "licenseDeclared": "MIT", + "copyrightText": "Copyright (c) 1985 GitHub.com" } ] } @@ -229174,6 +229223,13 @@ "NOASSERTION" ] }, + "copyrightText": { + "type": "string", + "description": "The copyright holders of the package, and any dates present with those notices, if available.", + "examples": [ + "Copyright (c) 1985 GitHub.com" + ] + }, "externalRefs": { "type": "array", "items": { @@ -229952,6 +230008,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -230764,6 +230821,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -231531,6 +231589,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -236411,6 +236470,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -237220,6 +237280,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -237975,6 +238036,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -257606,7 +257668,8 @@ "serverToServer": true, "fineGrainedPat": true, "permissions": [], - "allowPermissionlessAccess": true + "allowPermissionlessAccess": true, + "allowsPublicRead": true }, "codeExamples": [ { @@ -257674,7 +257737,8 @@ "serverToServer": true, "fineGrainedPat": true, "permissions": [], - "allowPermissionlessAccess": true + "allowPermissionlessAccess": true, + "allowsPublicRead": true }, "codeExamples": [ { @@ -324798,6 +324862,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -324805,6 +324870,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -354162,7 +354228,8 @@ "properties": { "id": { "description": "The unique identifier of the role.", - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "description": "The name of the role.", @@ -354502,7 +354569,8 @@ "properties": { "id": { "description": "The unique identifier of the role.", - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "description": "The name of the role.", @@ -355261,7 +355329,8 @@ "properties": { "id": { "description": "The unique identifier of the role.", - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "description": "The name of the role.", @@ -355599,7 +355668,8 @@ "properties": { "id": { "description": "The unique identifier of the role.", - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "description": "The name of the role.", @@ -361231,6 +361301,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -361257,6 +361335,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -362268,6 +362354,15 @@ "name": "property_values", "description": "

The values to match for the repository property

", "isRequired": true + }, + { + "type": "string", + "name": "source", + "description": "

The source of the repository property. Defaults to 'custom' if not specified.

", + "enum": [ + "custom", + "system" + ] } ] }, @@ -362287,6 +362382,15 @@ "name": "property_values", "description": "

The values to match for the repository property

", "isRequired": true + }, + { + "type": "string", + "name": "source", + "description": "

The source of the repository property. Defaults to 'custom' if not specified.

", + "enum": [ + "custom", + "system" + ] } ] } @@ -363551,6 +363655,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -363577,6 +363689,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -364804,6 +364924,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -364830,6 +364958,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -365847,6 +365983,15 @@ "name": "property_values", "description": "

The values to match for the repository property

", "isRequired": true + }, + { + "type": "string", + "name": "source", + "description": "

The source of the repository property. Defaults to 'custom' if not specified.

", + "enum": [ + "custom", + "system" + ] } ] }, @@ -365866,6 +366011,15 @@ "name": "property_values", "description": "

The values to match for the repository property

", "isRequired": true + }, + { + "type": "string", + "name": "source", + "description": "

The source of the repository property. Defaults to 'custom' if not specified.

", + "enum": [ + "custom", + "system" + ] } ] } @@ -367131,6 +367285,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -367157,6 +367319,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -394040,6 +394210,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -398727,6 +398898,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -402568,6 +402740,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -406459,6 +406632,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -411292,6 +411466,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -411299,6 +411474,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -411926,6 +412102,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -411933,6 +412110,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -412574,6 +412752,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -412581,6 +412760,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -413344,6 +413524,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -413351,6 +413532,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -414064,6 +414246,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -414071,6 +414254,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -414726,6 +414910,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -414733,6 +414918,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -416392,6 +416578,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -421038,6 +421225,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -427447,12 +427635,14 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] }, "id": { "type": "integer", + "format": "int64", "examples": [ 10 ] @@ -488341,6 +488531,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -488367,6 +488565,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -490504,6 +490710,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -490530,6 +490744,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -491768,6 +491990,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -491794,6 +492024,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -493938,6 +494176,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -493964,6 +494210,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -556946,6 +557200,1340 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/user/{account_id}", + "title": "Get a user using their ID", + "category": "users", + "subcategory": "users", + "parameters": [ + { + "name": "account_id", + "description": "

account_id parameter

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "codeExamples": [ + { + "key": "default-response", + "request": { + "description": "Example 1: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "account_id": "ACCOUNT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Default 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, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "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" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + } + } + }, + { + "key": "response-with-git-hub-plan-information", + "request": { + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "account_id": "ACCOUNT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response with GitHub plan information

", + "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, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "plan": { + "name": "pro", + "space": 976562499, + "collaborators": 0, + "private_repos": 9999 + } + }, + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "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" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -557213,13 +558801,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - }, "codeExamples": [ { "key": "default-response", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 572af4d23e..da82d0543f 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -29485,7 +29485,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -29506,7 +29507,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -29541,7 +29543,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -32232,7 +32235,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -32253,7 +32257,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -32288,7 +32293,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -35517,7 +35523,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -35538,7 +35545,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -35573,7 +35581,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -38420,6 +38429,7 @@ "id": { "description": "The id of the environment.", "type": "integer", + "format": "int64", "examples": [ 56780428 ] @@ -39049,6 +39059,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -40693,7 +40704,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -40714,7 +40726,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -40749,7 +40762,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -94672,7 +94686,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -105928,7 +105943,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -106939,7 +106955,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -133850,7 +133867,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -133871,7 +133889,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -133906,7 +133925,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -135069,7 +135089,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -135090,7 +135111,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -135125,7 +135147,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -136301,7 +136324,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -136322,7 +136346,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -136357,7 +136382,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -137768,7 +137794,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -137789,7 +137816,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -137824,7 +137852,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -139372,7 +139401,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -139393,7 +139423,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -139428,7 +139459,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -140689,7 +140721,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -140710,7 +140743,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -140745,7 +140779,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -141734,7 +141769,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -141755,7 +141791,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -141790,7 +141827,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -143547,7 +143585,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -143568,7 +143607,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -143603,7 +143643,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -146605,7 +146646,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -146626,7 +146668,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -146661,7 +146704,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -148490,7 +148534,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -148511,7 +148556,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -148546,7 +148592,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -152127,10 +152174,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -153542,10 +153589,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -154827,10 +154874,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -155427,10 +155474,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -155723,10 +155770,10 @@ "in": "body", "description": "

Required when the state is dismissed. The reason for dismissing or closing the alert.

", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, { @@ -156080,10 +156127,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -214940,6 +214987,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -240604,7 +240652,8 @@ "downloadLocation": "NOASSERTION", "filesAnalyzed": false, "licenseConcluded": "MIT", - "licenseDeclared": "MIT" + "licenseDeclared": "MIT", + "copyrightText": "Copyright (c) 1985 GitHub.com" } ] } @@ -240749,6 +240798,13 @@ "NOASSERTION" ] }, + "copyrightText": { + "type": "string", + "description": "The copyright holders of the package, and any dates present with those notices, if available.", + "examples": [ + "Copyright (c) 1985 GitHub.com" + ] + }, "externalRefs": { "type": "array", "items": { @@ -241527,6 +241583,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -242339,6 +242396,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -243106,6 +243164,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -247986,6 +248045,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -248795,6 +248855,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -249550,6 +249611,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -277203,7 +277265,8 @@ "serverToServer": true, "fineGrainedPat": true, "permissions": [], - "allowPermissionlessAccess": true + "allowPermissionlessAccess": true, + "allowsPublicRead": true }, "codeExamples": [ { @@ -277271,7 +277334,8 @@ "serverToServer": true, "fineGrainedPat": true, "permissions": [], - "allowPermissionlessAccess": true + "allowPermissionlessAccess": true, + "allowsPublicRead": true }, "codeExamples": [ { @@ -344395,6 +344459,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -344402,6 +344467,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -377451,7 +377517,8 @@ "properties": { "id": { "description": "The unique identifier of the role.", - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "description": "The name of the role.", @@ -377791,7 +377858,8 @@ "properties": { "id": { "description": "The unique identifier of the role.", - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "description": "The name of the role.", @@ -378550,7 +378618,8 @@ "properties": { "id": { "description": "The unique identifier of the role.", - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "description": "The name of the role.", @@ -378888,7 +378957,8 @@ "properties": { "id": { "description": "The unique identifier of the role.", - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "description": "The name of the role.", @@ -384550,6 +384620,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -384576,6 +384654,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -385587,6 +385673,15 @@ "name": "property_values", "description": "

The values to match for the repository property

", "isRequired": true + }, + { + "type": "string", + "name": "source", + "description": "

The source of the repository property. Defaults to 'custom' if not specified.

", + "enum": [ + "custom", + "system" + ] } ] }, @@ -385606,6 +385701,15 @@ "name": "property_values", "description": "

The values to match for the repository property

", "isRequired": true + }, + { + "type": "string", + "name": "source", + "description": "

The source of the repository property. Defaults to 'custom' if not specified.

", + "enum": [ + "custom", + "system" + ] } ] } @@ -386870,6 +386974,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -386896,6 +387008,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -388123,6 +388243,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -388149,6 +388277,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -389166,6 +389302,15 @@ "name": "property_values", "description": "

The values to match for the repository property

", "isRequired": true + }, + { + "type": "string", + "name": "source", + "description": "

The source of the repository property. Defaults to 'custom' if not specified.

", + "enum": [ + "custom", + "system" + ] } ] }, @@ -389185,6 +389330,15 @@ "name": "property_values", "description": "

The values to match for the repository property

", "isRequired": true + }, + { + "type": "string", + "name": "source", + "description": "

The source of the repository property. Defaults to 'custom' if not specified.

", + "enum": [ + "custom", + "system" + ] } ] } @@ -390450,6 +390604,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -390476,6 +390638,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -417473,6 +417643,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -422160,6 +422331,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -426001,6 +426173,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -429892,6 +430065,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -434725,6 +434899,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -434732,6 +434907,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -435359,6 +435535,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -435366,6 +435543,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -436007,6 +436185,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -436014,6 +436193,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -436777,6 +436957,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -436784,6 +436965,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -437497,6 +437679,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -437504,6 +437687,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -438159,6 +438343,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -438166,6 +438351,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -439825,6 +440011,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -444471,6 +444658,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -450880,12 +451068,14 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] }, "id": { "type": "integer", + "format": "int64", "examples": [ 10 ] @@ -512061,6 +512251,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -512087,6 +512285,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -514224,6 +514430,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -514250,6 +514464,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -515488,6 +515710,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -515514,6 +515744,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -517658,6 +517896,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -517684,6 +517930,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -584890,6 +585144,1340 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/user/{account_id}", + "title": "Get a user using their ID", + "category": "users", + "subcategory": "users", + "parameters": [ + { + "name": "account_id", + "description": "

account_id parameter

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "codeExamples": [ + { + "key": "default-response", + "request": { + "description": "Example 1: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "account_id": "ACCOUNT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Default 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, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "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" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + } + } + }, + { + "key": "response-with-git-hub-plan-information", + "request": { + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "account_id": "ACCOUNT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response with GitHub plan information

", + "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, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "plan": { + "name": "pro", + "space": 976562499, + "collaborators": 0, + "private_repos": 9999 + } + }, + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "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" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Cloud profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -585157,13 +586745,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - }, "codeExamples": [ { "key": "default-response", diff --git a/src/rest/data/ghes-3.10-2022-11-28/schema.json b/src/rest/data/ghes-3.10-2022-11-28/schema.json index 353aa08d5f..d0fb972855 100644 --- a/src/rest/data/ghes-3.10-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.10-2022-11-28/schema.json @@ -29662,7 +29662,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -29683,7 +29684,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -29718,7 +29720,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -32385,7 +32388,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -32406,7 +32410,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -32441,7 +32446,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -35555,7 +35561,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -35576,7 +35583,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -35611,7 +35619,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -38347,6 +38356,7 @@ "id": { "description": "The id of the environment.", "type": "integer", + "format": "int64", "examples": [ 56780428 ] @@ -38976,6 +38986,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -40376,7 +40387,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -40397,7 +40409,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -40432,7 +40445,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -93673,7 +93687,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -101934,7 +101949,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -102920,7 +102936,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -129150,7 +129167,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -129171,7 +129189,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -129206,7 +129225,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -130369,7 +130389,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -130390,7 +130411,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -130425,7 +130447,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -131601,7 +131624,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -131622,7 +131646,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -131657,7 +131682,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -133068,7 +133094,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -133089,7 +133116,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -133124,7 +133152,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -134672,7 +134701,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -134693,7 +134723,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -134728,7 +134759,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -135989,7 +136021,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -136010,7 +136043,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -136045,7 +136079,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -137034,7 +137069,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -137055,7 +137091,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -137090,7 +137127,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -138835,7 +138873,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -138856,7 +138895,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -138891,7 +138931,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -141869,7 +141910,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -141890,7 +141932,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -141925,7 +141968,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -143742,7 +143786,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -143763,7 +143808,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -143798,7 +143844,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -145765,10 +145812,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -147180,10 +147227,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -148465,10 +148512,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -149065,10 +149112,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -149361,10 +149408,10 @@ "in": "body", "description": "

Required when the state is dismissed. The reason for dismissing or closing the alert.

", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, { @@ -149718,10 +149765,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -158769,6 +158816,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -179924,6 +179972,13 @@ "NOASSERTION" ] }, + "copyrightText": { + "type": "string", + "description": "The copyright holders of the package, and any dates present with those notices, if available.", + "examples": [ + "Copyright (c) 1985 GitHub.com" + ] + }, "externalRefs": { "type": "array", "items": { @@ -180704,6 +180759,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -181516,6 +181572,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -182283,6 +182340,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -186997,6 +187055,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -187806,6 +187865,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -188561,6 +188621,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -205398,7 +205459,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -206775,7 +206837,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -207684,7 +207747,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -225901,7 +225965,8 @@ "serverToServer": true, "fineGrainedPat": true, "permissions": [], - "allowPermissionlessAccess": true + "allowPermissionlessAccess": true, + "allowsPublicRead": true }, "codeExamples": [ { @@ -225969,7 +226034,8 @@ "serverToServer": true, "fineGrainedPat": true, "permissions": [], - "allowPermissionlessAccess": true + "allowPermissionlessAccess": true, + "allowsPublicRead": true }, "codeExamples": [ { @@ -292210,6 +292276,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -292217,6 +292284,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -306813,6 +306881,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -307134,6 +307203,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -307548,7 +307618,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -308538,7 +308609,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -309543,7 +309615,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -310455,7 +310528,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -311464,7 +311538,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -312377,7 +312452,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -313324,7 +313400,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -314322,7 +314399,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -353108,6 +353186,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -357795,6 +357874,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -361636,6 +361716,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -365527,6 +365608,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -370360,6 +370442,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -370367,6 +370450,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -370994,6 +371078,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -371001,6 +371086,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -371642,6 +371728,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -371649,6 +371736,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -372412,6 +372500,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -372419,6 +372508,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -373132,6 +373222,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -373139,6 +373230,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -373794,6 +373886,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -373801,6 +373894,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -375460,6 +375554,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -380106,6 +380201,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -386515,12 +386611,14 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] }, "id": { "type": "integer", + "format": "int64", "examples": [ 10 ] @@ -483947,6 +484045,1340 @@ } ] }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/user/{account_id}", + "title": "Get a user using their ID", + "category": "users", + "subcategory": "users", + "parameters": [ + { + "name": "account_id", + "description": "

account_id parameter

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "codeExamples": [ + { + "key": "default-response", + "request": { + "description": "Example 1: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "account_id": "ACCOUNT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Default 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, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "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" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + } + } + }, + { + "key": "response-with-git-hub-plan-information", + "request": { + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "account_id": "ACCOUNT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response with GitHub plan information

", + "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, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "plan": { + "name": "pro", + "space": 976562499, + "collaborators": 0, + "private_repos": 9999 + } + }, + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "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" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", @@ -484214,13 +485646,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - }, "codeExamples": [ { "key": "default-response", diff --git a/src/rest/data/ghes-3.11-2022-11-28/schema.json b/src/rest/data/ghes-3.11-2022-11-28/schema.json index 1301f0dd96..0a686d76f3 100644 --- a/src/rest/data/ghes-3.11-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.11-2022-11-28/schema.json @@ -29686,7 +29686,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -29707,7 +29708,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -29742,7 +29744,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -32409,7 +32412,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -32430,7 +32434,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -32465,7 +32470,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -35579,7 +35585,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -35600,7 +35607,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -35635,7 +35643,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -38371,6 +38380,7 @@ "id": { "description": "The id of the environment.", "type": "integer", + "format": "int64", "examples": [ 56780428 ] @@ -39000,6 +39010,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -40400,7 +40411,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -40421,7 +40433,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -40456,7 +40469,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -93697,7 +93711,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -101958,7 +101973,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -102944,7 +102960,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -129174,7 +129191,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -129195,7 +129213,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -129230,7 +129249,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -130393,7 +130413,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -130414,7 +130435,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -130449,7 +130471,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -131625,7 +131648,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -131646,7 +131670,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -131681,7 +131706,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -133092,7 +133118,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -133113,7 +133140,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -133148,7 +133176,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -134696,7 +134725,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -134717,7 +134747,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -134752,7 +134783,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -136013,7 +136045,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -136034,7 +136067,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -136069,7 +136103,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -137058,7 +137093,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -137079,7 +137115,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -137114,7 +137151,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -138859,7 +138897,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -138880,7 +138919,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -138915,7 +138955,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -141893,7 +141934,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -141914,7 +141956,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -141949,7 +141992,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -143766,7 +143810,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -143787,7 +143832,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -143822,7 +143868,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -145789,10 +145836,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -147204,10 +147251,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -148489,10 +148536,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -149089,10 +149136,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -149385,10 +149432,10 @@ "in": "body", "description": "

Required when the state is dismissed. The reason for dismissing or closing the alert.

", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, { @@ -149742,10 +149789,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -158805,6 +158852,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -179960,6 +180008,13 @@ "NOASSERTION" ] }, + "copyrightText": { + "type": "string", + "description": "The copyright holders of the package, and any dates present with those notices, if available.", + "examples": [ + "Copyright (c) 1985 GitHub.com" + ] + }, "externalRefs": { "type": "array", "items": { @@ -180738,6 +180793,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -181550,6 +181606,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -182317,6 +182374,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -187062,6 +187120,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -187871,6 +187930,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -188626,6 +188686,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -205463,7 +205524,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -206840,7 +206902,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -207749,7 +207812,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -225966,7 +226030,8 @@ "serverToServer": true, "fineGrainedPat": true, "permissions": [], - "allowPermissionlessAccess": true + "allowPermissionlessAccess": true, + "allowsPublicRead": true }, "codeExamples": [ { @@ -226034,7 +226099,8 @@ "serverToServer": true, "fineGrainedPat": true, "permissions": [], - "allowPermissionlessAccess": true + "allowPermissionlessAccess": true, + "allowsPublicRead": true }, "codeExamples": [ { @@ -292275,6 +292341,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -292282,6 +292349,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -306878,6 +306946,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -307199,6 +307268,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -307613,7 +307683,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -308603,7 +308674,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -309608,7 +309680,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -310520,7 +310593,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -311529,7 +311603,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -312442,7 +312517,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -313389,7 +313465,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -314387,7 +314464,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -358721,6 +358799,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -363408,6 +363487,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -367249,6 +367329,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -371140,6 +371221,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -375973,6 +376055,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -375980,6 +376063,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -376607,6 +376691,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -376614,6 +376699,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -377255,6 +377341,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -377262,6 +377349,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -378025,6 +378113,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -378032,6 +378121,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -378745,6 +378835,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -378752,6 +378843,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -379407,6 +379499,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -379414,6 +379507,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -381073,6 +381167,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -385719,6 +385814,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -392128,12 +392224,14 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] }, "id": { "type": "integer", + "format": "int64", "examples": [ 10 ] @@ -497992,6 +498090,1340 @@ } ] }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/user/{account_id}", + "title": "Get a user using their ID", + "category": "users", + "subcategory": "users", + "parameters": [ + { + "name": "account_id", + "description": "

account_id parameter

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "codeExamples": [ + { + "key": "default-response", + "request": { + "description": "Example 1: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "account_id": "ACCOUNT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Default 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, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "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" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + } + } + }, + { + "key": "response-with-git-hub-plan-information", + "request": { + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "account_id": "ACCOUNT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response with GitHub plan information

", + "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, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "plan": { + "name": "pro", + "space": 976562499, + "collaborators": 0, + "private_repos": 9999 + } + }, + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "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" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", @@ -498259,13 +499691,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - }, "codeExamples": [ { "key": "default-response", diff --git a/src/rest/data/ghes-3.12-2022-11-28/schema.json b/src/rest/data/ghes-3.12-2022-11-28/schema.json index 3177e84d92..29be4a5974 100644 --- a/src/rest/data/ghes-3.12-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.12-2022-11-28/schema.json @@ -29686,7 +29686,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -29707,7 +29708,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -29742,7 +29744,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -32409,7 +32412,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -32430,7 +32434,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -32465,7 +32470,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -35579,7 +35585,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -35600,7 +35607,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -35635,7 +35643,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -38458,6 +38467,7 @@ "id": { "description": "The id of the environment.", "type": "integer", + "format": "int64", "examples": [ 56780428 ] @@ -39087,6 +39097,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -40487,7 +40498,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -40508,7 +40520,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -40543,7 +40556,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -93873,7 +93887,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -102219,7 +102234,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -103222,7 +103238,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -129495,7 +129512,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -129516,7 +129534,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -129551,7 +129570,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -130714,7 +130734,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -130735,7 +130756,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -130770,7 +130792,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -131946,7 +131969,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -131967,7 +131991,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -132002,7 +132027,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -133413,7 +133439,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -133434,7 +133461,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -133469,7 +133497,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -135017,7 +135046,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -135038,7 +135068,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -135073,7 +135104,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -136334,7 +136366,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -136355,7 +136388,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -136390,7 +136424,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -137379,7 +137414,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -137400,7 +137436,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -137435,7 +137472,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -139180,7 +139218,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -139201,7 +139240,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -139236,7 +139276,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -142214,7 +142255,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -142235,7 +142277,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -142270,7 +142313,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -144087,7 +144131,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -144108,7 +144153,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -144143,7 +144189,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -146110,10 +146157,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -147525,10 +147572,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -148810,10 +148857,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -149410,10 +149457,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -149706,10 +149753,10 @@ "in": "body", "description": "

Required when the state is dismissed. The reason for dismissing or closing the alert.

", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, { @@ -150063,10 +150110,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -159125,6 +159172,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -180280,6 +180328,13 @@ "NOASSERTION" ] }, + "copyrightText": { + "type": "string", + "description": "The copyright holders of the package, and any dates present with those notices, if available.", + "examples": [ + "Copyright (c) 1985 GitHub.com" + ] + }, "externalRefs": { "type": "array", "items": { @@ -181058,6 +181113,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -181870,6 +181926,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -182637,6 +182694,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -187514,6 +187572,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -188323,6 +188382,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -189078,6 +189138,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -207645,7 +207706,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -209039,7 +209101,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -209965,7 +210028,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -228199,7 +228263,8 @@ "serverToServer": true, "fineGrainedPat": true, "permissions": [], - "allowPermissionlessAccess": true + "allowPermissionlessAccess": true, + "allowsPublicRead": true }, "codeExamples": [ { @@ -228267,7 +228332,8 @@ "serverToServer": true, "fineGrainedPat": true, "permissions": [], - "allowPermissionlessAccess": true + "allowPermissionlessAccess": true, + "allowsPublicRead": true }, "codeExamples": [ { @@ -294508,6 +294574,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -294515,6 +294582,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -309111,6 +309179,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -309432,6 +309501,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -309846,7 +309916,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -310853,7 +310924,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -311875,7 +311947,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -312804,7 +312877,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -313830,7 +313904,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -314760,7 +314835,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -315724,7 +315800,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -316739,7 +316816,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -361573,6 +361651,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -366260,6 +366339,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -370101,6 +370181,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -373992,6 +374073,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -378825,6 +378907,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -378832,6 +378915,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -379459,6 +379543,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -379466,6 +379551,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -380107,6 +380193,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -380114,6 +380201,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -380877,6 +380965,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -380884,6 +380973,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -381597,6 +381687,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -381604,6 +381695,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -382259,6 +382351,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -382266,6 +382359,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -383925,6 +384019,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -388571,6 +388666,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -394980,12 +395076,14 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] }, "id": { "type": "integer", + "format": "int64", "examples": [ 10 ] @@ -501449,6 +501547,1340 @@ } ] }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/user/{account_id}", + "title": "Get a user using their ID", + "category": "users", + "subcategory": "users", + "parameters": [ + { + "name": "account_id", + "description": "

account_id parameter

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "codeExamples": [ + { + "key": "default-response", + "request": { + "description": "Example 1: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "account_id": "ACCOUNT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Default 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, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "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" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + } + } + }, + { + "key": "response-with-git-hub-plan-information", + "request": { + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "account_id": "ACCOUNT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response with GitHub plan information

", + "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, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "plan": { + "name": "pro", + "space": 976562499, + "collaborators": 0, + "private_repos": 9999 + } + }, + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "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" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", @@ -501716,13 +503148,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - }, "codeExamples": [ { "key": "default-response", diff --git a/src/rest/data/ghes-3.13-2022-11-28/schema.json b/src/rest/data/ghes-3.13-2022-11-28/schema.json index efe2968c36..7213646d60 100644 --- a/src/rest/data/ghes-3.13-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.13-2022-11-28/schema.json @@ -29686,7 +29686,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -29707,7 +29708,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -29742,7 +29744,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -32409,7 +32412,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -32430,7 +32434,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -32465,7 +32470,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -35579,7 +35585,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -35600,7 +35607,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -35635,7 +35643,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -38458,6 +38467,7 @@ "id": { "description": "The id of the environment.", "type": "integer", + "format": "int64", "examples": [ 56780428 ] @@ -39087,6 +39097,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -40487,7 +40498,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -40508,7 +40520,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -40543,7 +40556,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -93965,7 +93979,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -102351,7 +102366,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -103362,7 +103378,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -129639,7 +129656,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -129660,7 +129678,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -129695,7 +129714,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -130858,7 +130878,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -130879,7 +130900,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -130914,7 +130936,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -132090,7 +132113,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -132111,7 +132135,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -132146,7 +132171,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -133557,7 +133583,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -133578,7 +133605,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -133613,7 +133641,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -135161,7 +135190,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -135182,7 +135212,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -135217,7 +135248,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -136478,7 +136510,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -136499,7 +136532,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -136534,7 +136568,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -137523,7 +137558,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -137544,7 +137580,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -137579,7 +137616,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -139324,7 +139362,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -139345,7 +139384,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -139380,7 +139420,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -142358,7 +142399,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -142379,7 +142421,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -142414,7 +142457,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -144231,7 +144275,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -144252,7 +144297,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -144287,7 +144333,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -146254,10 +146301,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -147669,10 +147716,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -148954,10 +149001,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -149554,10 +149601,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -149850,10 +149897,10 @@ "in": "body", "description": "

Required when the state is dismissed. The reason for dismissing or closing the alert.

", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, { @@ -150207,10 +150254,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -159269,6 +159316,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -180424,6 +180472,13 @@ "NOASSERTION" ] }, + "copyrightText": { + "type": "string", + "description": "The copyright holders of the package, and any dates present with those notices, if available.", + "examples": [ + "Copyright (c) 1985 GitHub.com" + ] + }, "externalRefs": { "type": "array", "items": { @@ -181202,6 +181257,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -182014,6 +182070,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -182781,6 +182838,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -187658,6 +187716,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -188467,6 +188526,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -189222,6 +189282,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -207821,7 +207882,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -209223,7 +209285,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -210157,7 +210220,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -228399,7 +228463,8 @@ "serverToServer": true, "fineGrainedPat": true, "permissions": [], - "allowPermissionlessAccess": true + "allowPermissionlessAccess": true, + "allowsPublicRead": true }, "codeExamples": [ { @@ -228467,7 +228532,8 @@ "serverToServer": true, "fineGrainedPat": true, "permissions": [], - "allowPermissionlessAccess": true + "allowPermissionlessAccess": true, + "allowsPublicRead": true }, "codeExamples": [ { @@ -294708,6 +294774,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -294715,6 +294782,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -309321,6 +309389,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -309642,6 +309711,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -310056,7 +310126,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -311071,7 +311142,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -312101,7 +312173,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -313038,7 +313111,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -314072,7 +314146,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -315010,7 +315085,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -315982,7 +316058,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -317005,7 +317082,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -328079,7 +328157,8 @@ "properties": { "id": { "description": "The unique identifier of the role.", - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "description": "The name of the role.", @@ -328419,7 +328498,8 @@ "properties": { "id": { "description": "The unique identifier of the role.", - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "description": "The name of the role.", @@ -329178,7 +329258,8 @@ "properties": { "id": { "description": "The unique identifier of the role.", - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "description": "The name of the role.", @@ -329516,7 +329597,8 @@ "properties": { "id": { "description": "The unique identifier of the role.", - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "description": "The name of the role.", @@ -335145,6 +335227,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -335171,6 +335261,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -335995,6 +336093,15 @@ "name": "property_values", "description": "

The values to match for the repository property

", "isRequired": true + }, + { + "type": "string", + "name": "source", + "description": "

The source of the repository property. Defaults to 'custom' if not specified.

", + "enum": [ + "custom", + "system" + ] } ] }, @@ -336014,6 +336121,15 @@ "name": "property_values", "description": "

The values to match for the repository property

", "isRequired": true + }, + { + "type": "string", + "name": "source", + "description": "

The source of the repository property. Defaults to 'custom' if not specified.

", + "enum": [ + "custom", + "system" + ] } ] } @@ -337082,6 +337198,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -337108,6 +337232,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -338145,6 +338277,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -338171,6 +338311,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -339001,6 +339149,15 @@ "name": "property_values", "description": "

The values to match for the repository property

", "isRequired": true + }, + { + "type": "string", + "name": "source", + "description": "

The source of the repository property. Defaults to 'custom' if not specified.

", + "enum": [ + "custom", + "system" + ] } ] }, @@ -339020,6 +339177,15 @@ "name": "property_values", "description": "

The values to match for the repository property

", "isRequired": true + }, + { + "type": "string", + "name": "source", + "description": "

The source of the repository property. Defaults to 'custom' if not specified.

", + "enum": [ + "custom", + "system" + ] } ] } @@ -340089,6 +340255,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -340115,6 +340289,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -366366,6 +366548,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -371053,6 +371236,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -374894,6 +375078,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -378785,6 +378970,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -383618,6 +383804,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -383625,6 +383812,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -384252,6 +384440,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -384259,6 +384448,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -384900,6 +385090,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -384907,6 +385098,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -385670,6 +385862,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -385677,6 +385870,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -386390,6 +386584,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -386397,6 +386592,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -387052,6 +387248,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -387059,6 +387256,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -388718,6 +388916,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -393364,6 +393563,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -399773,12 +399973,14 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] }, "id": { "type": "integer", + "format": "int64", "examples": [ 10 ] @@ -460019,6 +460221,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -460045,6 +460255,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -461799,6 +462017,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -461825,6 +462051,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -462873,6 +463107,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -462899,6 +463141,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -464660,6 +464910,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -464686,6 +464944,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -506890,6 +507156,1340 @@ } ] }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/user/{account_id}", + "title": "Get a user using their ID", + "category": "users", + "subcategory": "users", + "parameters": [ + { + "name": "account_id", + "description": "

account_id parameter

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "codeExamples": [ + { + "key": "default-response", + "request": { + "description": "Example 1: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "account_id": "ACCOUNT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Default 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, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "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" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + } + } + }, + { + "key": "response-with-git-hub-plan-information", + "request": { + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "account_id": "ACCOUNT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response with GitHub plan information

", + "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, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "plan": { + "name": "pro", + "space": 976562499, + "collaborators": 0, + "private_repos": 9999 + } + }, + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "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" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", @@ -507157,13 +508757,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - }, "codeExamples": [ { "key": "default-response", diff --git a/src/rest/data/ghes-3.9-2022-11-28/schema.json b/src/rest/data/ghes-3.9-2022-11-28/schema.json index 120c28fa68..d49affa463 100644 --- a/src/rest/data/ghes-3.9-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.9-2022-11-28/schema.json @@ -28921,7 +28921,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -28942,7 +28943,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -28977,7 +28979,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -31616,7 +31619,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -31637,7 +31641,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -31672,7 +31677,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -34758,7 +34764,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -34779,7 +34786,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -34814,7 +34822,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -37441,6 +37450,7 @@ "id": { "description": "The id of the environment.", "type": "integer", + "format": "int64", "examples": [ 56780428 ] @@ -38060,6 +38070,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -39460,7 +39471,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -39481,7 +39493,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -39516,7 +39529,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -92659,7 +92673,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -100916,7 +100931,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -101902,7 +101918,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -127925,7 +127942,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -127946,7 +127964,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -127981,7 +128000,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -129144,7 +129164,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -129165,7 +129186,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -129200,7 +129222,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -130376,7 +130399,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -130397,7 +130421,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -130432,7 +130457,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -131843,7 +131869,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -131864,7 +131891,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -131899,7 +131927,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -133447,7 +133476,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -133468,7 +133498,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -133503,7 +133534,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -134764,7 +134796,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -134785,7 +134818,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -134820,7 +134854,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -135809,7 +135844,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -135830,7 +135866,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -135865,7 +135902,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -137596,7 +137634,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -137617,7 +137656,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -137652,7 +137692,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -140602,7 +140643,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -140623,7 +140665,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -140658,7 +140701,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -142461,7 +142505,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -142482,7 +142527,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -142517,7 +142563,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -144470,10 +144517,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -145885,10 +145932,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -147170,10 +147217,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -147770,10 +147817,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -148066,10 +148113,10 @@ "in": "body", "description": "

Required when the state is dismissed. The reason for dismissing or closing the alert.

", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, { @@ -148423,10 +148470,10 @@ ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ - null, "false positive", "won't fix", - "used in tests" + "used in tests", + null ] }, "dismissed_comment": { @@ -157425,6 +157472,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -178542,6 +178590,13 @@ "NOASSERTION" ] }, + "copyrightText": { + "type": "string", + "description": "The copyright holders of the package, and any dates present with those notices, if available.", + "examples": [ + "Copyright (c) 1985 GitHub.com" + ] + }, "externalRefs": { "type": "array", "items": { @@ -179322,6 +179377,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -180134,6 +180190,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -180901,6 +180958,7 @@ "id": { "description": "Unique identifier of the deployment", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -184758,6 +184816,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -185567,6 +185626,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -186322,6 +186382,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -202787,7 +202848,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -204164,7 +204226,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -205073,7 +205136,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -223290,7 +223354,8 @@ "serverToServer": true, "fineGrainedPat": true, "permissions": [], - "allowPermissionlessAccess": true + "allowPermissionlessAccess": true, + "allowsPublicRead": true }, "codeExamples": [ { @@ -223358,7 +223423,8 @@ "serverToServer": true, "fineGrainedPat": true, "permissions": [], - "allowPermissionlessAccess": true + "allowPermissionlessAccess": true, + "allowsPublicRead": true }, "codeExamples": [ { @@ -289539,6 +289605,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -289546,6 +289613,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -304114,6 +304182,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -304435,6 +304504,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -304849,7 +304919,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -305839,7 +305910,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -306844,7 +306916,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -307756,7 +307829,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -308765,7 +308839,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -309678,7 +309753,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -310625,7 +310701,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -311623,7 +311700,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -346898,6 +346976,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -351573,6 +351652,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -355405,6 +355485,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -359287,6 +359368,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -364113,6 +364195,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -364120,6 +364203,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -364747,6 +364831,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -364754,6 +364839,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -365395,6 +365481,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -365402,6 +365489,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -366165,6 +366253,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -366172,6 +366261,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -366885,6 +366975,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -366892,6 +366983,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -367547,6 +367639,7 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] @@ -367554,6 +367647,7 @@ "id": { "description": "The ID of the pull request review comment.", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -369200,6 +369294,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -373830,6 +373925,7 @@ }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -380229,12 +380325,14 @@ "integer", "null" ], + "format": "int64", "examples": [ 42 ] }, "id": { "type": "integer", + "format": "int64", "examples": [ 10 ] @@ -477122,6 +477220,1340 @@ } ] }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/user/{account_id}", + "title": "Get a user using their ID", + "category": "users", + "subcategory": "users", + "parameters": [ + { + "name": "account_id", + "description": "

account_id parameter

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "codeExamples": [ + { + "key": "default-response", + "request": { + "description": "Example 1: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "account_id": "ACCOUNT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Default 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, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "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" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + } + } + }, + { + "key": "response-with-git-hub-plan-information", + "request": { + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "account_id": "ACCOUNT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response with GitHub plan information

", + "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, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "plan": { + "name": "pro", + "space": 976562499, + "collaborators": 0, + "private_repos": 9999 + } + }, + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "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" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "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", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", @@ -477389,13 +478821,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - }, "codeExamples": [ { "key": "default-response", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 1f9df0a3e4..75c07b3355 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -47,5 +47,5 @@ ] } }, - "sha": "d2303fdde41a01ecb82983c478eba68dd73f8dcf" + "sha": "3c07521af936565853d6ba44db0ca6598fa90c8f" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 746188f2e4..8b6fa27135 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -95396,6 +95396,823 @@ "category": "projects_v2_item" } }, + "projects_v2_status_update": { + "created": { + "descriptionHtml": "

A status update was added to a project in the organization.

", + "summaryHtml": "

This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"

\n

For activity relating to a project, use the projects_v2 event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_status_update", + "in": "body", + "description": "

An status update belonging to a project

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

The GitHub user that triggered the event. This property is included in every webhook payload.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "created", + "category": "projects_v2_status_update" + }, + "deleted": { + "descriptionHtml": "

A status update was removed from a project in the organization.

", + "summaryHtml": "

This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"

\n

For activity relating to a project, use the projects_v2 event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_status_update", + "in": "body", + "description": "

An status update belonging to a project

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

The GitHub user that triggered the event. This property is included in every webhook payload.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "deleted", + "category": "projects_v2_status_update" + }, + "edited": { + "descriptionHtml": "

A status update was edited on a project in the organization.

", + "summaryHtml": "

This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"

\n

For activity relating to a project, use the projects_v2 event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + }, + { + "type": "object", + "name": "status", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string or null", + "name": "to", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + } + ] + }, + { + "type": "object", + "name": "start_date", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + }, + { + "type": "object", + "name": "target_date", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_status_update", + "in": "body", + "description": "

An status update belonging to a project

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

The GitHub user that triggered the event. This property is included in every webhook payload.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "edited", + "category": "projects_v2_status_update" + } + }, "public": { "default": { "descriptionHtml": "", diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index 2118670dc1..14d87665cd 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -97730,6 +97730,823 @@ "category": "projects_v2_item" } }, + "projects_v2_status_update": { + "created": { + "descriptionHtml": "

A status update was added to a project in the organization.

", + "summaryHtml": "

This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"

\n

For activity relating to a project, use the projects_v2 event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_status_update", + "in": "body", + "description": "

An status update belonging to a project

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

The GitHub user that triggered the event. This property is included in every webhook payload.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "created", + "category": "projects_v2_status_update" + }, + "deleted": { + "descriptionHtml": "

A status update was removed from a project in the organization.

", + "summaryHtml": "

This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"

\n

For activity relating to a project, use the projects_v2 event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_status_update", + "in": "body", + "description": "

An status update belonging to a project

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

The GitHub user that triggered the event. This property is included in every webhook payload.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "deleted", + "category": "projects_v2_status_update" + }, + "edited": { + "descriptionHtml": "

A status update was edited on a project in the organization.

", + "summaryHtml": "

This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"

\n

For activity relating to a project, use the projects_v2 event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + }, + { + "type": "object", + "name": "status", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string or null", + "name": "to", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + } + ] + }, + { + "type": "object", + "name": "start_date", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + }, + { + "type": "object", + "name": "target_date", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_status_update", + "in": "body", + "description": "

An status update belonging to a project

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

The GitHub user that triggered the event. This property is included in every webhook payload.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "edited", + "category": "projects_v2_status_update" + } + }, "public": { "default": { "descriptionHtml": "", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 8736fb4309..e1f51d64ea 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "d2303fdde41a01ecb82983c478eba68dd73f8dcf" + "sha": "3c07521af936565853d6ba44db0ca6598fa90c8f" } \ No newline at end of file