jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-23 21:07:12 -05:00
Code Issues Projects Releases Wiki Activity

GraphQL schema update (#46981)

Browse Source 
Co-authored-by: rachmari <rachmari@users.noreply.github.com>
This commit is contained in:
docs-bot
2023-11-30 11:35:01 -05:00
committed by GitHub
parent b6642de80f
commit b52475548f
7 changed files with 3342 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

415
data/graphql/ghae/schema.docs-ghae.graphql
View File

@@ -7497,6 +7497,51 @@ type CreateTeamDiscussionPayload {
)
}
"""
Autogenerated input type of CreateUserList
"""
input CreateUserListInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
A description of the list
"""
description: String
"""
Whether or not the list is private
"""
isPrivate: Boolean = false
"""
The name of the new list
"""
name: String!
}
"""
Autogenerated return type of CreateUserList
"""
type CreateUserListPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The list that was just created
"""
list: UserList
"""
The user who created the list
"""
viewer: User
}
"""
Represents the contribution a user made by committing to a repository.
"""
@@ -8552,6 +8597,36 @@ type DeleteTeamDiscussionPayload {
clientMutationId: String
}
"""
Autogenerated input type of DeleteUserList
"""
input DeleteUserListInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the list to delete.
"""
listId: ID! @possibleTypes(concreteTypes: ["UserList"])
}
"""
Autogenerated return type of DeleteUserList
"""
type DeleteUserListPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The owner of the list that will be deleted
"""
user: User
}
"""
Represents a 'demilestoned' event on a given issue or pull request.
"""
@@ -19704,6 +19779,16 @@ type Mutation {
input: CreateTeamDiscussionCommentInput!
): CreateTeamDiscussionCommentPayload
"""
Creates a new user list.
"""
createUserList(
"""
Parameters for CreateUserList
"""
input: CreateUserListInput!
): CreateUserListPayload
"""
Delete a branch protection rule
"""
@@ -19894,6 +19979,16 @@ type Mutation {
input: DeleteTeamDiscussionCommentInput!
): DeleteTeamDiscussionCommentPayload
"""
Deletes a user list.
"""
deleteUserList(
"""
Parameters for DeleteUserList
"""
input: DeleteUserListInput!
): DeleteUserListPayload
"""
Disable auto merge on the given pull request
"""
@@ -20910,6 +21005,26 @@ type Mutation {
"""
input: UpdateTopicsInput!
): UpdateTopicsPayload
"""
Updates an existing user list.
"""
updateUserList(
"""
Parameters for UpdateUserList
"""
input: UpdateUserListInput!
): UpdateUserListPayload
"""
Updates which of the viewer's lists an item belongs to
"""
updateUserListsForItem(
"""
Parameters for UpdateUserListsForItem
"""
input: UpdateUserListsForItemInput!
): UpdateUserListsForItemPayload
}
"""
@@ -47061,6 +47176,101 @@ type UpdateTopicsPayload {
repository: Repository
}
"""
Autogenerated input type of UpdateUserList
"""
input UpdateUserListInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
A description of the list
"""
description: String
"""
Whether or not the list is private
"""
isPrivate: Boolean
"""
The ID of the list to update.
"""
listId: ID! @possibleTypes(concreteTypes: ["UserList"])
"""
The name of the list
"""
name: String
}
"""
Autogenerated return type of UpdateUserList
"""
type UpdateUserListPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The list that was just updated
"""
list: UserList
}
"""
Autogenerated input type of UpdateUserListsForItem
"""
input UpdateUserListsForItemInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The item to add to the list
"""
itemId: ID! @possibleTypes(concreteTypes: ["Repository"], abstractType: "UserListItems")
"""
The lists to which this item should belong
"""
listIds: [ID!]! @possibleTypes(concreteTypes: ["UserList"])
"""
The suggested lists to create and add this item to
"""
suggestedListIds: [ID!] @possibleTypes(concreteTypes: ["UserListSuggestion"])
}
"""
Autogenerated return type of UpdateUserListsForItem
"""
type UpdateUserListsForItemPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The item that was added
"""
item: UserListItems
"""
The lists to which this item belongs
"""
lists: [UserList!]
"""
The user who owns the lists
"""
user: User
}
"""
A user is an individual's account on GitHub that owns repositories and can make new content.
"""
@@ -47473,6 +47683,31 @@ type User implements Actor & Node & ProfileOwner & ProjectOwner & RepositoryDisc
"""
itemShowcase: ProfileItemShowcase!
"""
A user-curated list of repositories
"""
lists(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): UserListConnection!
"""
The user's public profile location.
"""
@@ -48064,6 +48299,11 @@ type User implements Actor & Node & ProfileOwner & ProjectOwner & RepositoryDisc
"""
status: UserStatus
"""
Suggested names for user lists
"""
suggestedListNames: [UserListSuggestion!]!
"""
Identifies the date and time when the user was suspended.
"""
@@ -48409,6 +48649,181 @@ type UserEmailMetadata {
value: String!
}
"""
A user-curated list of repositories
"""
type UserList implements Node {
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The description of this list
"""
description: String
"""
The Node ID of the UserList object
"""
id: ID!
"""
Whether or not this list is private
"""
isPrivate: Boolean!
"""
The items associated with this list
"""
items(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): UserListItemsConnection!
"""
The date and time at which this list was created or last had items added to it
"""
lastAddedAt: DateTime!
"""
The name of this list
"""
name: String!
"""
The slug of this list
"""
slug: String!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
"""
The user to which this list belongs
"""
user: User!
}
"""
The connection type for UserList.
"""
type UserListConnection {
"""
A list of edges.
"""
edges: [UserListEdge]
"""
A list of nodes.
"""
nodes: [UserList]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type UserListEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: UserList
}
"""
Types that can be added to a user list.
"""
union UserListItems = Repository
"""
The connection type for UserListItems.
"""
type UserListItemsConnection {
"""
A list of edges.
"""
edges: [UserListItemsEdge]
"""
A list of nodes.
"""
nodes: [UserListItems]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type UserListItemsEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: UserListItems
}
"""
Represents a suggested user list.
"""
type UserListSuggestion {
"""
The ID of the suggested user list
"""
id: ID
"""
The name of the suggested user list
"""
name: String
}
"""
The user's description of what they're currently doing.
"""

415
data/graphql/ghec/schema.docs.graphql
View File

@@ -8361,6 +8361,51 @@ type CreateTeamDiscussionPayload {
)
}
"""
Autogenerated input type of CreateUserList
"""
input CreateUserListInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
A description of the list
"""
description: String
"""
Whether or not the list is private
"""
isPrivate: Boolean = false
"""
The name of the new list
"""
name: String!
}
"""
Autogenerated return type of CreateUserList
"""
type CreateUserListPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The list that was just created
"""
list: UserList
"""
The user who created the list
"""
viewer: User
}
"""
Represents the contribution a user made by committing to a repository.
"""
@@ -9620,6 +9665,36 @@ type DeleteTeamDiscussionPayload {
clientMutationId: String
}
"""
Autogenerated input type of DeleteUserList
"""
input DeleteUserListInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the list to delete.
"""
listId: ID! @possibleTypes(concreteTypes: ["UserList"])
}
"""
Autogenerated return type of DeleteUserList
"""
type DeleteUserListPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The owner of the list that will be deleted
"""
user: User
}
"""
Autogenerated input type of DeleteVerifiableDomain
"""
@@ -22591,6 +22666,16 @@ type Mutation {
input: CreateTeamDiscussionCommentInput!
): CreateTeamDiscussionCommentPayload
"""
Creates a new user list.
"""
createUserList(
"""
Parameters for CreateUserList
"""
input: CreateUserListInput!
): CreateUserListPayload
"""
Rejects a suggested topic for the repository.
"""
@@ -22841,6 +22926,16 @@ type Mutation {
input: DeleteTeamDiscussionCommentInput!
): DeleteTeamDiscussionCommentPayload
"""
Deletes a user list.
"""
deleteUserList(
"""
Parameters for DeleteUserList
"""
input: DeleteUserListInput!
): DeleteUserListPayload
"""
Deletes a verifiable domain.
"""
@@ -24202,6 +24297,26 @@ type Mutation {
input: UpdateTopicsInput!
): UpdateTopicsPayload
"""
Updates an existing user list.
"""
updateUserList(
"""
Parameters for UpdateUserList
"""
input: UpdateUserListInput!
): UpdateUserListPayload
"""
Updates which of the viewer's lists an item belongs to
"""
updateUserListsForItem(
"""
Parameters for UpdateUserListsForItem
"""
input: UpdateUserListsForItemInput!
): UpdateUserListsForItemPayload
"""
Verify that a verifiable domain has the expected DNS record.
"""
@@ -58639,6 +58754,101 @@ type UpdateTopicsPayload {
repository: Repository
}
"""
Autogenerated input type of UpdateUserList
"""
input UpdateUserListInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
A description of the list
"""
description: String
"""
Whether or not the list is private
"""
isPrivate: Boolean
"""
The ID of the list to update.
"""
listId: ID! @possibleTypes(concreteTypes: ["UserList"])
"""
The name of the list
"""
name: String
}
"""
Autogenerated return type of UpdateUserList
"""
type UpdateUserListPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The list that was just updated
"""
list: UserList
}
"""
Autogenerated input type of UpdateUserListsForItem
"""
input UpdateUserListsForItemInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The item to add to the list
"""
itemId: ID! @possibleTypes(concreteTypes: ["Repository"], abstractType: "UserListItems")
"""
The lists to which this item should belong
"""
listIds: [ID!]! @possibleTypes(concreteTypes: ["UserList"])
"""
The suggested lists to create and add this item to
"""
suggestedListIds: [ID!] @possibleTypes(concreteTypes: ["UserListSuggestion"])
}
"""
Autogenerated return type of UpdateUserListsForItem
"""
type UpdateUserListsForItemPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The item that was added
"""
item: UserListItems
"""
The lists to which this item belongs
"""
lists: [UserList!]
"""
The user who owns the lists
"""
user: User
}
"""
A user is an individual's account on GitHub that owns repositories and can make new content.
"""
@@ -59081,6 +59291,31 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner &
"""
itemShowcase: ProfileItemShowcase!
"""
A user-curated list of repositories
"""
lists(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): UserListConnection!
"""
The user's public profile location.
"""
@@ -60064,6 +60299,11 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner &
"""
status: UserStatus
"""
Suggested names for user lists
"""
suggestedListNames: [UserListSuggestion!]!
"""
Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created
"""
@@ -60436,6 +60676,181 @@ type UserEmailMetadata {
value: String!
}
"""
A user-curated list of repositories
"""
type UserList implements Node {
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The description of this list
"""
description: String
"""
The Node ID of the UserList object
"""
id: ID!
"""
Whether or not this list is private
"""
isPrivate: Boolean!
"""
The items associated with this list
"""
items(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): UserListItemsConnection!
"""
The date and time at which this list was created or last had items added to it
"""
lastAddedAt: DateTime!
"""
The name of this list
"""
name: String!
"""
The slug of this list
"""
slug: String!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
"""
The user to which this list belongs
"""
user: User!
}
"""
The connection type for UserList.
"""
type UserListConnection {
"""
A list of edges.
"""
edges: [UserListEdge]
"""
A list of nodes.
"""
nodes: [UserList]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type UserListEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: UserList
}
"""
Types that can be added to a user list.
"""
union UserListItems = Repository
"""
The connection type for UserListItems.
"""
type UserListItemsConnection {
"""
A list of edges.
"""
edges: [UserListItemsEdge]
"""
A list of nodes.
"""
nodes: [UserListItems]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type UserListItemsEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: UserListItems
}
"""
Represents a suggested user list.
"""
type UserListSuggestion {
"""
The ID of the suggested user list
"""
id: ID
"""
The name of the suggested user list
"""
name: String
}
"""
The user's description of what they're currently doing.
"""

415
data/graphql/schema.docs.graphql
View File

@@ -8361,6 +8361,51 @@ type CreateTeamDiscussionPayload {
)
}
"""
Autogenerated input type of CreateUserList
"""
input CreateUserListInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
A description of the list
"""
description: String
"""
Whether or not the list is private
"""
isPrivate: Boolean = false
"""
The name of the new list
"""
name: String!
}
"""
Autogenerated return type of CreateUserList
"""
type CreateUserListPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The list that was just created
"""
list: UserList
"""
The user who created the list
"""
viewer: User
}
"""
Represents the contribution a user made by committing to a repository.
"""
@@ -9620,6 +9665,36 @@ type DeleteTeamDiscussionPayload {
clientMutationId: String
}
"""
Autogenerated input type of DeleteUserList
"""
input DeleteUserListInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the list to delete.
"""
listId: ID! @possibleTypes(concreteTypes: ["UserList"])
}
"""
Autogenerated return type of DeleteUserList
"""
type DeleteUserListPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The owner of the list that will be deleted
"""
user: User
}
"""
Autogenerated input type of DeleteVerifiableDomain
"""
@@ -22591,6 +22666,16 @@ type Mutation {
input: CreateTeamDiscussionCommentInput!
): CreateTeamDiscussionCommentPayload
"""
Creates a new user list.
"""
createUserList(
"""
Parameters for CreateUserList
"""
input: CreateUserListInput!
): CreateUserListPayload
"""
Rejects a suggested topic for the repository.
"""
@@ -22841,6 +22926,16 @@ type Mutation {
input: DeleteTeamDiscussionCommentInput!
): DeleteTeamDiscussionCommentPayload
"""
Deletes a user list.
"""
deleteUserList(
"""
Parameters for DeleteUserList
"""
input: DeleteUserListInput!
): DeleteUserListPayload
"""
Deletes a verifiable domain.
"""
@@ -24202,6 +24297,26 @@ type Mutation {
input: UpdateTopicsInput!
): UpdateTopicsPayload
"""
Updates an existing user list.
"""
updateUserList(
"""
Parameters for UpdateUserList
"""
input: UpdateUserListInput!
): UpdateUserListPayload
"""
Updates which of the viewer's lists an item belongs to
"""
updateUserListsForItem(
"""
Parameters for UpdateUserListsForItem
"""
input: UpdateUserListsForItemInput!
): UpdateUserListsForItemPayload
"""
Verify that a verifiable domain has the expected DNS record.
"""
@@ -58639,6 +58754,101 @@ type UpdateTopicsPayload {
repository: Repository
}
"""
Autogenerated input type of UpdateUserList
"""
input UpdateUserListInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
A description of the list
"""
description: String
"""
Whether or not the list is private
"""
isPrivate: Boolean
"""
The ID of the list to update.
"""
listId: ID! @possibleTypes(concreteTypes: ["UserList"])
"""
The name of the list
"""
name: String
}
"""
Autogenerated return type of UpdateUserList
"""
type UpdateUserListPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The list that was just updated
"""
list: UserList
}
"""
Autogenerated input type of UpdateUserListsForItem
"""
input UpdateUserListsForItemInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The item to add to the list
"""
itemId: ID! @possibleTypes(concreteTypes: ["Repository"], abstractType: "UserListItems")
"""
The lists to which this item should belong
"""
listIds: [ID!]! @possibleTypes(concreteTypes: ["UserList"])
"""
The suggested lists to create and add this item to
"""
suggestedListIds: [ID!] @possibleTypes(concreteTypes: ["UserListSuggestion"])
}
"""
Autogenerated return type of UpdateUserListsForItem
"""
type UpdateUserListsForItemPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The item that was added
"""
item: UserListItems
"""
The lists to which this item belongs
"""
lists: [UserList!]
"""
The user who owns the lists
"""
user: User
}
"""
A user is an individual's account on GitHub that owns repositories and can make new content.
"""
@@ -59081,6 +59291,31 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner &
"""
itemShowcase: ProfileItemShowcase!
"""
A user-curated list of repositories
"""
lists(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): UserListConnection!
"""
The user's public profile location.
"""
@@ -60064,6 +60299,11 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner &
"""
status: UserStatus
"""
Suggested names for user lists
"""
suggestedListNames: [UserListSuggestion!]!
"""
Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created
"""
@@ -60436,6 +60676,181 @@ type UserEmailMetadata {
value: String!
}
"""
A user-curated list of repositories
"""
type UserList implements Node {
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The description of this list
"""
description: String
"""
The Node ID of the UserList object
"""
id: ID!
"""
Whether or not this list is private
"""
isPrivate: Boolean!
"""
The items associated with this list
"""
items(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): UserListItemsConnection!
"""
The date and time at which this list was created or last had items added to it
"""
lastAddedAt: DateTime!
"""
The name of this list
"""
name: String!
"""
The slug of this list
"""
slug: String!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
"""
The user to which this list belongs
"""
user: User!
}
"""
The connection type for UserList.
"""
type UserListConnection {
"""
A list of edges.
"""
edges: [UserListEdge]
"""
A list of nodes.
"""
nodes: [UserList]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type UserListEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: UserList
}
"""
Types that can be added to a user list.
"""
union UserListItems = Repository
"""
The connection type for UserListItems.
"""
type UserListItemsConnection {
"""
A list of edges.
"""
edges: [UserListItemsEdge]
"""
A list of nodes.
"""
nodes: [UserListItems]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type UserListItemsEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: UserListItems
}
"""
Represents a suggested user list.
"""
type UserListSuggestion {
"""
The ID of the suggested user list
"""
id: ID
"""
The name of the suggested user list
"""
name: String
}
"""
The user's description of what they're currently doing.
"""