Skip to content

Commit 95d266b

Browse files
docs-botheiskr
andauthored
GraphQL schema update (#53877)
Co-authored-by: heiskr <[email protected]>
1 parent 1be6912 commit 95d266b

File tree

5 files changed

+164
-0
lines changed

5 files changed

+164
-0
lines changed

src/graphql/data/fpt/changelog.json

+14
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,18 @@
11
[
2+
{
3+
"schemaChanges": [
4+
{
5+
"title": "The GraphQL schema includes these changes:",
6+
"changes": [
7+
"<p>Type <code>CopilotLicenseType</code> was added</p>",
8+
"<p>Field <code>copilotLicenseType</code> was added to object type <code>User</code></p>"
9+
]
10+
}
11+
],
12+
"previewChanges": [],
13+
"upcomingChanges": [],
14+
"date": "2025-01-13"
15+
},
216
{
317
"schemaChanges": [
418
{

src/graphql/data/fpt/schema.docs.graphql

+36
Original file line numberDiff line numberDiff line change
@@ -6979,6 +6979,36 @@ type CopilotEndpoints {
69796979
telemetry: String!
69806980
}
69816981

6982+
"""
6983+
Indicates the type of access a user has to GitHub Copilot
6984+
"""
6985+
enum CopilotLicenseType @requiredCapabilities(requiredCapabilities: ["access_copilot_limited_graphql_api"]) {
6986+
"""
6987+
Business access
6988+
"""
6989+
COPILOT_BUSINESS
6990+
6991+
"""
6992+
Enterprise access
6993+
"""
6994+
COPILOT_ENTERPRISE
6995+
6996+
"""
6997+
Limited free access
6998+
"""
6999+
COPILOT_FREE
7000+
7001+
"""
7002+
Individual access
7003+
"""
7004+
COPILOT_INDIVIDUAL
7005+
7006+
"""
7007+
No access found
7008+
"""
7009+
NO_ACCESS
7010+
}
7011+
69827012
"""
69837013
The type of the activity that was performed.
69847014
"""
@@ -63233,6 +63263,12 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner &
6323363263
"""
6323463264
copilotEndpoints: CopilotEndpoints
6323563265

63266+
"""
63267+
The user's license type for Copilot
63268+
"""
63269+
copilotLicenseType: CopilotLicenseType
63270+
@requiredCapabilities(requiredCapabilities: ["access_copilot_limited_graphql_api"])
63271+
6323663272
"""
6323763273
Properties of the current Copilot user, if limited by Copilot Free.
6323863274
"""

src/graphql/data/fpt/schema.json

+39
Original file line numberDiff line numberDiff line change
@@ -76727,6 +76727,15 @@
7672776727
"kind": "objects",
7672876728
"href": "/graphql/reference/objects#copilotendpoints"
7672976729
},
76730+
{
76731+
"name": "copilotLicenseType",
76732+
"description": "<p>The user's license type for Copilot.</p>",
76733+
"type": "CopilotLicenseType",
76734+
"id": "copilotlicensetype",
76735+
"kind": "enums",
76736+
"href": "/graphql/reference/enums#copilotlicensetype",
76737+
"isDeprecated": false
76738+
},
7673076739
{
7673176740
"name": "copilotLimitedUser",
7673276741
"description": "<p>Properties of the current Copilot user, if limited by Copilot Free.</p>",
@@ -85740,6 +85749,36 @@
8574085749
}
8574185750
]
8574285751
},
85752+
{
85753+
"name": "CopilotLicenseType",
85754+
"kind": "enums",
85755+
"id": "copilotlicensetype",
85756+
"href": "/graphql/reference/enums#copilotlicensetype",
85757+
"description": "<p>Indicates the type of access a user has to GitHub Copilot.</p>",
85758+
"isDeprecated": false,
85759+
"values": [
85760+
{
85761+
"name": "COPILOT_BUSINESS",
85762+
"description": "<p>Business access.</p>"
85763+
},
85764+
{
85765+
"name": "COPILOT_ENTERPRISE",
85766+
"description": "<p>Enterprise access.</p>"
85767+
},
85768+
{
85769+
"name": "COPILOT_FREE",
85770+
"description": "<p>Limited free access.</p>"
85771+
},
85772+
{
85773+
"name": "COPILOT_INDIVIDUAL",
85774+
"description": "<p>Individual access.</p>"
85775+
},
85776+
{
85777+
"name": "NO_ACCESS",
85778+
"description": "<p>No access found.</p>"
85779+
}
85780+
]
85781+
},
8574385782
{
8574485783
"name": "CopilotLimitedFeature",
8574585784
"kind": "enums",

src/graphql/data/ghec/schema.docs.graphql

+36
Original file line numberDiff line numberDiff line change
@@ -6979,6 +6979,36 @@ type CopilotEndpoints {
69796979
telemetry: String!
69806980
}
69816981

6982+
"""
6983+
Indicates the type of access a user has to GitHub Copilot
6984+
"""
6985+
enum CopilotLicenseType @requiredCapabilities(requiredCapabilities: ["access_copilot_limited_graphql_api"]) {
6986+
"""
6987+
Business access
6988+
"""
6989+
COPILOT_BUSINESS
6990+
6991+
"""
6992+
Enterprise access
6993+
"""
6994+
COPILOT_ENTERPRISE
6995+
6996+
"""
6997+
Limited free access
6998+
"""
6999+
COPILOT_FREE
7000+
7001+
"""
7002+
Individual access
7003+
"""
7004+
COPILOT_INDIVIDUAL
7005+
7006+
"""
7007+
No access found
7008+
"""
7009+
NO_ACCESS
7010+
}
7011+
69827012
"""
69837013
The type of the activity that was performed.
69847014
"""
@@ -63233,6 +63263,12 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner &
6323363263
"""
6323463264
copilotEndpoints: CopilotEndpoints
6323563265

63266+
"""
63267+
The user's license type for Copilot
63268+
"""
63269+
copilotLicenseType: CopilotLicenseType
63270+
@requiredCapabilities(requiredCapabilities: ["access_copilot_limited_graphql_api"])
63271+
6323663272
"""
6323763273
Properties of the current Copilot user, if limited by Copilot Free.
6323863274
"""

src/graphql/data/ghec/schema.json

+39
Original file line numberDiff line numberDiff line change
@@ -76727,6 +76727,15 @@
7672776727
"kind": "objects",
7672876728
"href": "/graphql/reference/objects#copilotendpoints"
7672976729
},
76730+
{
76731+
"name": "copilotLicenseType",
76732+
"description": "<p>The user's license type for Copilot.</p>",
76733+
"type": "CopilotLicenseType",
76734+
"id": "copilotlicensetype",
76735+
"kind": "enums",
76736+
"href": "/graphql/reference/enums#copilotlicensetype",
76737+
"isDeprecated": false
76738+
},
7673076739
{
7673176740
"name": "copilotLimitedUser",
7673276741
"description": "<p>Properties of the current Copilot user, if limited by Copilot Free.</p>",
@@ -85740,6 +85749,36 @@
8574085749
}
8574185750
]
8574285751
},
85752+
{
85753+
"name": "CopilotLicenseType",
85754+
"kind": "enums",
85755+
"id": "copilotlicensetype",
85756+
"href": "/graphql/reference/enums#copilotlicensetype",
85757+
"description": "<p>Indicates the type of access a user has to GitHub Copilot.</p>",
85758+
"isDeprecated": false,
85759+
"values": [
85760+
{
85761+
"name": "COPILOT_BUSINESS",
85762+
"description": "<p>Business access.</p>"
85763+
},
85764+
{
85765+
"name": "COPILOT_ENTERPRISE",
85766+
"description": "<p>Enterprise access.</p>"
85767+
},
85768+
{
85769+
"name": "COPILOT_FREE",
85770+
"description": "<p>Limited free access.</p>"
85771+
},
85772+
{
85773+
"name": "COPILOT_INDIVIDUAL",
85774+
"description": "<p>Individual access.</p>"
85775+
},
85776+
{
85777+
"name": "NO_ACCESS",
85778+
"description": "<p>No access found.</p>"
85779+
}
85780+
]
85781+
},
8574385782
{
8574485783
"name": "CopilotLimitedFeature",
8574585784
"kind": "enums",

0 commit comments

Comments
 (0)