1
0
mirror of synced 2025-12-19 18:10:59 -05:00

GraphQL schema update (#50629)

Co-authored-by: rachmari <9831992+rachmari@users.noreply.github.com>
This commit is contained in:
docs-bot
2024-05-15 09:37:05 -07:00
committed by GitHub
parent 99c622a261
commit b47d2b74b3
5 changed files with 1415 additions and 0 deletions

View File

@@ -1,4 +1,33 @@
[
{
"schemaChanges": [
{
"title": "The GraphQL schema includes these changes:",
"changes": [
"<p>Type <code>EnvironmentPinnedFilterField</code> was added</p>",
"<p>Type <code>PinEnvironmentInput</code> was added</p>",
"<p>Type <code>PinEnvironmentPayload</code> was added</p>",
"<p>Type <code>PinnedEnvironment</code> was added</p>",
"<p>Type <code>PinnedEnvironmentConnection</code> was added</p>",
"<p>Type <code>PinnedEnvironmentEdge</code> was added</p>",
"<p>Type <code>PinnedEnvironmentOrder</code> was added</p>",
"<p>Type <code>PinnedEnvironmentOrderField</code> was added</p>",
"<p>Type <code>ReorderEnvironmentInput</code> was added</p>",
"<p>Type <code>ReorderEnvironmentPayload</code> was added</p>",
"<p>Field <code>isPinned</code> was added to object type <code>Environment</code></p>",
"<p>Field <code>latestCompletedDeployment</code> was added to object type <code>Environment</code></p>",
"<p>Field <code>pinnedPosition</code> was added to object type <code>Environment</code></p>",
"<p>Field <code>pinEnvironment</code> was added to object type <code>Mutation</code></p>",
"<p>Field <code>reorderEnvironment</code> was added to object type <code>Mutation</code></p>",
"<p>Field <code>pinnedEnvironments</code> was added to object type <code>Repository</code></p>",
"<p>Argument <code>pinnedEnvironmentFilter: EnvironmentPinnedFilterField</code> (with default value) added to field <code>Repository.environments</code></p>"
]
}
],
"previewChanges": [],
"upcomingChanges": [],
"date": "2024-05-15"
},
{
"schemaChanges": [
{

View File

@@ -15459,11 +15459,26 @@ type Environment implements Node {
"""
id: ID!
"""
Indicates whether or not this environment is currently pinned to the repository
"""
isPinned: Boolean
"""
The latest completed deployment with status success, failure, or error if it exists
"""
latestCompletedDeployment: Deployment
"""
The name of the environment
"""
name: String!
"""
The position of the environment if it is pinned, null if it is not pinned
"""
pinnedPosition: Int
"""
The protection rules defined for this environment
"""
@@ -15540,6 +15555,26 @@ enum EnvironmentOrderField {
NAME
}
"""
Properties by which environments connections can be ordered
"""
enum EnvironmentPinnedFilterField {
"""
All environments will be returned.
"""
ALL
"""
Environments exclude pinned will be returned
"""
NONE
"""
Only pinned environment will be returned
"""
ONLY
}
"""
Ordering options for environments
"""
@@ -23440,6 +23475,16 @@ type Mutation {
input: MoveProjectColumnInput!
): MoveProjectColumnPayload
"""
Pin an environment to a repository
"""
pinEnvironment(
"""
Parameters for PinEnvironment
"""
input: PinEnvironmentInput!
): PinEnvironmentPayload
"""
Pin an issue to a repository
"""
@@ -23631,6 +23676,16 @@ type Mutation {
input: ReopenPullRequestInput!
): ReopenPullRequestPayload
"""
Reorder a pinned repository environment
"""
reorderEnvironment(
"""
Parameters for ReorderEnvironment
"""
input: ReorderEnvironmentInput!
): ReorderEnvironmentPayload
"""
Set review requests on a pull request.
"""
@@ -31076,6 +31131,46 @@ type PermissionSource {
source: PermissionGranter!
}
"""
Autogenerated input type of PinEnvironment
"""
input PinEnvironmentInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the environment to modify
"""
environmentId: ID! @possibleTypes(concreteTypes: ["Environment"])
"""
The desired state of the environment. If true, environment will be pinned. If false, it will be unpinned.
"""
pinned: Boolean!
}
"""
Autogenerated return type of PinEnvironment
"""
type PinEnvironmentPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The environment that was pinned
"""
environment: Environment
"""
The pinned environment if we pinned
"""
pinnedEnvironment: PinnedEnvironment
}
"""
Autogenerated input type of PinIssue
"""
@@ -31356,6 +31451,106 @@ enum PinnedDiscussionPattern {
ZAP
}
"""
Represents a pinned environment on a given repository
"""
type PinnedEnvironment implements Node {
"""
Identifies the date and time when the pinned environment was created
"""
createdAt: DateTime!
"""
Identifies the primary key from the database.
"""
databaseId: Int
"""
Identifies the environment associated.
"""
environment: Environment!
"""
The Node ID of the PinnedEnvironment object
"""
id: ID!
"""
Identifies the position of the pinned environment.
"""
position: Int!
"""
The repository that this environment was pinned to.
"""
repository: Repository!
}
"""
The connection type for PinnedEnvironment.
"""
type PinnedEnvironmentConnection {
"""
A list of edges.
"""
edges: [PinnedEnvironmentEdge]
"""
A list of nodes.
"""
nodes: [PinnedEnvironment]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type PinnedEnvironmentEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: PinnedEnvironment
}
"""
Ordering options for pinned environments
"""
input PinnedEnvironmentOrder {
"""
The direction in which to order pinned environments by the specified field.
"""
direction: OrderDirection!
"""
The field to order pinned environments by.
"""
field: PinnedEnvironmentOrderField!
}
"""
Properties by which pinned environments connections can be ordered
"""
enum PinnedEnvironmentOrderField {
"""
Order pinned environments by position
"""
POSITION
}
"""
Represents a 'pinned' event on a given issue or pull request.
"""
@@ -40957,6 +41152,41 @@ type ReopenedEvent implements Node {
stateReason: IssueStateReason
}
"""
Autogenerated input type of ReorderEnvironment
"""
input ReorderEnvironmentInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the environment to modify
"""
environmentId: ID! @possibleTypes(concreteTypes: ["Environment"])
"""
The desired position of the environment
"""
position: Int!
}
"""
Autogenerated return type of ReorderEnvironment
"""
type ReorderEnvironmentPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The environment that was reordered
"""
environment: Environment
}
"""
Audit log entry for a repo.access event.
"""
@@ -43825,6 +44055,11 @@ type Repository implements Node & PackageOwner & ProjectOwner & ProjectV2Recent
Ordering options for the environments
"""
orderBy: Environments = {field: NAME, direction: ASC}
"""
Filter to control pinned environments return
"""
pinnedEnvironmentFilter: EnvironmentPinnedFilterField = ALL
): EnvironmentConnection!
"""
@@ -44394,6 +44629,36 @@ type Repository implements Node & PackageOwner & ProjectOwner & ProjectV2Recent
last: Int
): PinnedDiscussionConnection!
"""
A list of pinned environments for this repository.
"""
pinnedEnvironments(
"""
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
"""
Ordering options for the environments
"""
orderBy: PinnedEnvironmentOrder = {field: POSITION, direction: ASC}
): PinnedEnvironmentConnection
"""
A list of pinned issues for this repository.
"""

View File

@@ -5166,6 +5166,48 @@
}
]
},
{
"name": "pinEnvironment",
"kind": "mutations",
"id": "pinenvironment",
"href": "/graphql/reference/mutations#pinenvironment",
"description": "<p>Pin an environment to a repository.</p>",
"inputFields": [
{
"name": "input",
"type": "PinEnvironmentInput!",
"id": "pinenvironmentinput",
"kind": "input-objects",
"href": "/graphql/reference/input-objects#pinenvironmentinput"
}
],
"returnFields": [
{
"name": "clientMutationId",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string",
"description": "<p>A unique identifier for the client performing the mutation.</p>"
},
{
"name": "environment",
"type": "Environment",
"id": "environment",
"kind": "objects",
"href": "/graphql/reference/objects#environment",
"description": "<p>The environment that was pinned.</p>"
},
{
"name": "pinnedEnvironment",
"type": "PinnedEnvironment",
"id": "pinnedenvironment",
"kind": "objects",
"href": "/graphql/reference/objects#pinnedenvironment",
"description": "<p>The pinned environment if we pinned.</p>"
}
]
},
{
"name": "pinIssue",
"kind": "mutations",
@@ -5884,6 +5926,40 @@
}
]
},
{
"name": "reorderEnvironment",
"kind": "mutations",
"id": "reorderenvironment",
"href": "/graphql/reference/mutations#reorderenvironment",
"description": "<p>Reorder a pinned repository environment.</p>",
"inputFields": [
{
"name": "input",
"type": "ReorderEnvironmentInput!",
"id": "reorderenvironmentinput",
"kind": "input-objects",
"href": "/graphql/reference/input-objects#reorderenvironmentinput"
}
],
"returnFields": [
{
"name": "clientMutationId",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string",
"description": "<p>A unique identifier for the client performing the mutation.</p>"
},
{
"name": "environment",
"type": "Environment",
"id": "environment",
"kind": "objects",
"href": "/graphql/reference/objects#environment",
"description": "<p>The environment that was reordered.</p>"
}
]
},
{
"name": "requestReviews",
"kind": "mutations",
@@ -25114,6 +25190,22 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#id"
},
{
"name": "isPinned",
"description": "<p>Indicates whether or not this environment is currently pinned to the repository.</p>",
"type": "Boolean",
"id": "boolean",
"kind": "scalars",
"href": "/graphql/reference/scalars#boolean"
},
{
"name": "latestCompletedDeployment",
"description": "<p>The latest completed deployment with status success, failure, or error if it exists.</p>",
"type": "Deployment",
"id": "deployment",
"kind": "objects",
"href": "/graphql/reference/objects#deployment"
},
{
"name": "name",
"description": "<p>The name of the environment.</p>",
@@ -25122,6 +25214,14 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "pinnedPosition",
"description": "<p>The position of the environment if it is pinned, null if it is not pinned.</p>",
"type": "Int",
"id": "int",
"kind": "scalars",
"href": "/graphql/reference/scalars#int"
},
{
"name": "protectionRules",
"description": "<p>The protection rules defined for this environment.</p>",
@@ -43343,6 +43443,136 @@
}
]
},
{
"name": "PinnedEnvironment",
"kind": "objects",
"id": "pinnedenvironment",
"href": "/graphql/reference/objects#pinnedenvironment",
"description": "<p>Represents a pinned environment on a given repository.</p>",
"implements": [
{
"name": "Node",
"id": "node",
"href": "/graphql/reference/interfaces#node"
}
],
"fields": [
{
"name": "createdAt",
"description": "<p>Identifies the date and time when the pinned environment was created.</p>",
"type": "DateTime!",
"id": "datetime",
"kind": "scalars",
"href": "/graphql/reference/scalars#datetime"
},
{
"name": "databaseId",
"description": "<p>Identifies the primary key from the database.</p>",
"type": "Int",
"id": "int",
"kind": "scalars",
"href": "/graphql/reference/scalars#int"
},
{
"name": "environment",
"description": "<p>Identifies the environment associated.</p>",
"type": "Environment!",
"id": "environment",
"kind": "objects",
"href": "/graphql/reference/objects#environment"
},
{
"name": "id",
"description": "<p>The Node ID of the PinnedEnvironment object.</p>",
"type": "ID!",
"id": "id",
"kind": "scalars",
"href": "/graphql/reference/scalars#id"
},
{
"name": "position",
"description": "<p>Identifies the position of the pinned environment.</p>",
"type": "Int!",
"id": "int",
"kind": "scalars",
"href": "/graphql/reference/scalars#int"
},
{
"name": "repository",
"description": "<p>The repository that this environment was pinned to.</p>",
"type": "Repository!",
"id": "repository",
"kind": "objects",
"href": "/graphql/reference/objects#repository"
}
]
},
{
"name": "PinnedEnvironmentConnection",
"kind": "objects",
"id": "pinnedenvironmentconnection",
"href": "/graphql/reference/objects#pinnedenvironmentconnection",
"description": "<p>The connection type for PinnedEnvironment.</p>",
"fields": [
{
"name": "edges",
"description": "<p>A list of edges.</p>",
"type": "[PinnedEnvironmentEdge]",
"id": "pinnedenvironmentedge",
"kind": "objects",
"href": "/graphql/reference/objects#pinnedenvironmentedge"
},
{
"name": "nodes",
"description": "<p>A list of nodes.</p>",
"type": "[PinnedEnvironment]",
"id": "pinnedenvironment",
"kind": "objects",
"href": "/graphql/reference/objects#pinnedenvironment"
},
{
"name": "pageInfo",
"description": "<p>Information to aid in pagination.</p>",
"type": "PageInfo!",
"id": "pageinfo",
"kind": "objects",
"href": "/graphql/reference/objects#pageinfo"
},
{
"name": "totalCount",
"description": "<p>Identifies the total count of items in the connection.</p>",
"type": "Int!",
"id": "int",
"kind": "scalars",
"href": "/graphql/reference/scalars#int"
}
]
},
{
"name": "PinnedEnvironmentEdge",
"kind": "objects",
"id": "pinnedenvironmentedge",
"href": "/graphql/reference/objects#pinnedenvironmentedge",
"description": "<p>An edge in a connection.</p>",
"fields": [
{
"name": "cursor",
"description": "<p>A cursor for use in pagination.</p>",
"type": "String!",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "node",
"description": "<p>The item at the end of the edge.</p>",
"type": "PinnedEnvironment",
"id": "pinnedenvironment",
"kind": "objects",
"href": "/graphql/reference/objects#pinnedenvironment"
}
]
},
{
"name": "PinnedEvent",
"kind": "objects",
@@ -59959,6 +60189,17 @@
"kind": "input-objects",
"href": "/graphql/reference/input-objects#environments"
}
},
{
"name": "pinnedEnvironmentFilter",
"defaultValue": "ALL",
"description": "<p>Filter to control pinned environments return.</p>",
"type": {
"name": "EnvironmentPinnedFilterField",
"id": "environmentpinnedfilterfield",
"kind": "enums",
"href": "/graphql/reference/enums#environmentpinnedfilterfield"
}
}
]
},
@@ -61008,6 +61249,66 @@
}
]
},
{
"name": "pinnedEnvironments",
"description": "<p>A list of pinned environments for this repository.</p>",
"type": "PinnedEnvironmentConnection",
"id": "pinnedenvironmentconnection",
"kind": "objects",
"href": "/graphql/reference/objects#pinnedenvironmentconnection",
"arguments": [
{
"name": "after",
"description": "<p>Returns the elements in the list that come after the specified cursor.</p>",
"type": {
"name": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
}
},
{
"name": "before",
"description": "<p>Returns the elements in the list that come before the specified cursor.</p>",
"type": {
"name": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
}
},
{
"name": "first",
"description": "<p>Returns the first <em>n</em> elements from the list.</p>",
"type": {
"name": "Int",
"id": "int",
"kind": "scalars",
"href": "/graphql/reference/scalars#int"
}
},
{
"name": "last",
"description": "<p>Returns the last <em>n</em> elements from the list.</p>",
"type": {
"name": "Int",
"id": "int",
"kind": "scalars",
"href": "/graphql/reference/scalars#int"
}
},
{
"name": "orderBy",
"description": "<p>Ordering options for the environments.</p>",
"type": {
"name": "PinnedEnvironmentOrder",
"id": "pinnedenvironmentorder",
"kind": "input-objects",
"href": "/graphql/reference/input-objects#pinnedenvironmentorder"
}
}
]
},
{
"name": "pinnedIssues",
"description": "<p>A list of pinned issues for this repository.</p>",
@@ -82694,6 +82995,27 @@
}
]
},
{
"name": "EnvironmentPinnedFilterField",
"kind": "enums",
"id": "environmentpinnedfilterfield",
"href": "/graphql/reference/enums#environmentpinnedfilterfield",
"description": "<p>Properties by which environments connections can be ordered.</p>",
"values": [
{
"name": "ALL",
"description": "<p>All environments will be returned.</p>"
},
{
"name": "NONE",
"description": "<p>Environments exclude pinned will be returned.</p>"
},
{
"name": "ONLY",
"description": "<p>Only pinned environment will be returned.</p>"
}
]
},
{
"name": "FileViewedState",
"kind": "enums",
@@ -84254,6 +84576,19 @@
}
]
},
{
"name": "PinnedEnvironmentOrderField",
"kind": "enums",
"id": "pinnedenvironmentorderfield",
"href": "/graphql/reference/enums#pinnedenvironmentorderfield",
"description": "<p>Properties by which pinned environments connections can be ordered.</p>",
"values": [
{
"name": "POSITION",
"description": "<p>Order pinned environments by position.</p>"
}
]
},
{
"name": "ProjectCardArchivedState",
"kind": "enums",
@@ -96953,6 +97288,40 @@
}
]
},
{
"name": "PinEnvironmentInput",
"kind": "inputObjects",
"id": "pinenvironmentinput",
"href": "/graphql/reference/input-objects#pinenvironmentinput",
"description": "<p>Autogenerated input type of PinEnvironment.</p>",
"inputFields": [
{
"name": "clientMutationId",
"description": "<p>A unique identifier for the client performing the mutation.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "environmentId",
"description": "<p>The ID of the environment to modify.</p>",
"type": "ID!",
"id": "id",
"kind": "scalars",
"href": "/graphql/reference/scalars#id",
"isDeprecated": false
},
{
"name": "pinned",
"description": "<p>The desired state of the environment. If true, environment will be pinned. If false, it will be unpinned.</p>",
"type": "Boolean!",
"id": "boolean",
"kind": "scalars",
"href": "/graphql/reference/scalars#boolean"
}
]
},
{
"name": "PinIssueInput",
"kind": "inputObjects",
@@ -96979,6 +97348,31 @@
}
]
},
{
"name": "PinnedEnvironmentOrder",
"kind": "inputObjects",
"id": "pinnedenvironmentorder",
"href": "/graphql/reference/input-objects#pinnedenvironmentorder",
"description": "<p>Ordering options for pinned environments.</p>",
"inputFields": [
{
"name": "direction",
"description": "<p>The direction in which to order pinned environments by the specified field.</p>",
"type": "OrderDirection!",
"id": "orderdirection",
"kind": "enums",
"href": "/graphql/reference/enums#orderdirection"
},
{
"name": "field",
"description": "<p>The field to order pinned environments by.</p>",
"type": "PinnedEnvironmentOrderField!",
"id": "pinnedenvironmentorderfield",
"kind": "enums",
"href": "/graphql/reference/enums#pinnedenvironmentorderfield"
}
]
},
{
"name": "ProjectCardImport",
"kind": "inputObjects",
@@ -98139,6 +98533,40 @@
}
]
},
{
"name": "ReorderEnvironmentInput",
"kind": "inputObjects",
"id": "reorderenvironmentinput",
"href": "/graphql/reference/input-objects#reorderenvironmentinput",
"description": "<p>Autogenerated input type of ReorderEnvironment.</p>",
"inputFields": [
{
"name": "clientMutationId",
"description": "<p>A unique identifier for the client performing the mutation.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "environmentId",
"description": "<p>The ID of the environment to modify.</p>",
"type": "ID!",
"id": "id",
"kind": "scalars",
"href": "/graphql/reference/scalars#id",
"isDeprecated": false
},
{
"name": "position",
"description": "<p>The desired position of the environment.</p>",
"type": "Int!",
"id": "int",
"kind": "scalars",
"href": "/graphql/reference/scalars#int"
}
]
},
{
"name": "RepositoryIdConditionTargetInput",
"kind": "inputObjects",

View File

@@ -15459,11 +15459,26 @@ type Environment implements Node {
"""
id: ID!
"""
Indicates whether or not this environment is currently pinned to the repository
"""
isPinned: Boolean
"""
The latest completed deployment with status success, failure, or error if it exists
"""
latestCompletedDeployment: Deployment
"""
The name of the environment
"""
name: String!
"""
The position of the environment if it is pinned, null if it is not pinned
"""
pinnedPosition: Int
"""
The protection rules defined for this environment
"""
@@ -15540,6 +15555,26 @@ enum EnvironmentOrderField {
NAME
}
"""
Properties by which environments connections can be ordered
"""
enum EnvironmentPinnedFilterField {
"""
All environments will be returned.
"""
ALL
"""
Environments exclude pinned will be returned
"""
NONE
"""
Only pinned environment will be returned
"""
ONLY
}
"""
Ordering options for environments
"""
@@ -23440,6 +23475,16 @@ type Mutation {
input: MoveProjectColumnInput!
): MoveProjectColumnPayload
"""
Pin an environment to a repository
"""
pinEnvironment(
"""
Parameters for PinEnvironment
"""
input: PinEnvironmentInput!
): PinEnvironmentPayload
"""
Pin an issue to a repository
"""
@@ -23631,6 +23676,16 @@ type Mutation {
input: ReopenPullRequestInput!
): ReopenPullRequestPayload
"""
Reorder a pinned repository environment
"""
reorderEnvironment(
"""
Parameters for ReorderEnvironment
"""
input: ReorderEnvironmentInput!
): ReorderEnvironmentPayload
"""
Set review requests on a pull request.
"""
@@ -31076,6 +31131,46 @@ type PermissionSource {
source: PermissionGranter!
}
"""
Autogenerated input type of PinEnvironment
"""
input PinEnvironmentInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the environment to modify
"""
environmentId: ID! @possibleTypes(concreteTypes: ["Environment"])
"""
The desired state of the environment. If true, environment will be pinned. If false, it will be unpinned.
"""
pinned: Boolean!
}
"""
Autogenerated return type of PinEnvironment
"""
type PinEnvironmentPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The environment that was pinned
"""
environment: Environment
"""
The pinned environment if we pinned
"""
pinnedEnvironment: PinnedEnvironment
}
"""
Autogenerated input type of PinIssue
"""
@@ -31356,6 +31451,106 @@ enum PinnedDiscussionPattern {
ZAP
}
"""
Represents a pinned environment on a given repository
"""
type PinnedEnvironment implements Node {
"""
Identifies the date and time when the pinned environment was created
"""
createdAt: DateTime!
"""
Identifies the primary key from the database.
"""
databaseId: Int
"""
Identifies the environment associated.
"""
environment: Environment!
"""
The Node ID of the PinnedEnvironment object
"""
id: ID!
"""
Identifies the position of the pinned environment.
"""
position: Int!
"""
The repository that this environment was pinned to.
"""
repository: Repository!
}
"""
The connection type for PinnedEnvironment.
"""
type PinnedEnvironmentConnection {
"""
A list of edges.
"""
edges: [PinnedEnvironmentEdge]
"""
A list of nodes.
"""
nodes: [PinnedEnvironment]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type PinnedEnvironmentEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: PinnedEnvironment
}
"""
Ordering options for pinned environments
"""
input PinnedEnvironmentOrder {
"""
The direction in which to order pinned environments by the specified field.
"""
direction: OrderDirection!
"""
The field to order pinned environments by.
"""
field: PinnedEnvironmentOrderField!
}
"""
Properties by which pinned environments connections can be ordered
"""
enum PinnedEnvironmentOrderField {
"""
Order pinned environments by position
"""
POSITION
}
"""
Represents a 'pinned' event on a given issue or pull request.
"""
@@ -40957,6 +41152,41 @@ type ReopenedEvent implements Node {
stateReason: IssueStateReason
}
"""
Autogenerated input type of ReorderEnvironment
"""
input ReorderEnvironmentInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the environment to modify
"""
environmentId: ID! @possibleTypes(concreteTypes: ["Environment"])
"""
The desired position of the environment
"""
position: Int!
}
"""
Autogenerated return type of ReorderEnvironment
"""
type ReorderEnvironmentPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The environment that was reordered
"""
environment: Environment
}
"""
Audit log entry for a repo.access event.
"""
@@ -43825,6 +44055,11 @@ type Repository implements Node & PackageOwner & ProjectOwner & ProjectV2Recent
Ordering options for the environments
"""
orderBy: Environments = {field: NAME, direction: ASC}
"""
Filter to control pinned environments return
"""
pinnedEnvironmentFilter: EnvironmentPinnedFilterField = ALL
): EnvironmentConnection!
"""
@@ -44394,6 +44629,36 @@ type Repository implements Node & PackageOwner & ProjectOwner & ProjectV2Recent
last: Int
): PinnedDiscussionConnection!
"""
A list of pinned environments for this repository.
"""
pinnedEnvironments(
"""
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
"""
Ordering options for the environments
"""
orderBy: PinnedEnvironmentOrder = {field: POSITION, direction: ASC}
): PinnedEnvironmentConnection
"""
A list of pinned issues for this repository.
"""

View File

@@ -5166,6 +5166,48 @@
}
]
},
{
"name": "pinEnvironment",
"kind": "mutations",
"id": "pinenvironment",
"href": "/graphql/reference/mutations#pinenvironment",
"description": "<p>Pin an environment to a repository.</p>",
"inputFields": [
{
"name": "input",
"type": "PinEnvironmentInput!",
"id": "pinenvironmentinput",
"kind": "input-objects",
"href": "/graphql/reference/input-objects#pinenvironmentinput"
}
],
"returnFields": [
{
"name": "clientMutationId",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string",
"description": "<p>A unique identifier for the client performing the mutation.</p>"
},
{
"name": "environment",
"type": "Environment",
"id": "environment",
"kind": "objects",
"href": "/graphql/reference/objects#environment",
"description": "<p>The environment that was pinned.</p>"
},
{
"name": "pinnedEnvironment",
"type": "PinnedEnvironment",
"id": "pinnedenvironment",
"kind": "objects",
"href": "/graphql/reference/objects#pinnedenvironment",
"description": "<p>The pinned environment if we pinned.</p>"
}
]
},
{
"name": "pinIssue",
"kind": "mutations",
@@ -5884,6 +5926,40 @@
}
]
},
{
"name": "reorderEnvironment",
"kind": "mutations",
"id": "reorderenvironment",
"href": "/graphql/reference/mutations#reorderenvironment",
"description": "<p>Reorder a pinned repository environment.</p>",
"inputFields": [
{
"name": "input",
"type": "ReorderEnvironmentInput!",
"id": "reorderenvironmentinput",
"kind": "input-objects",
"href": "/graphql/reference/input-objects#reorderenvironmentinput"
}
],
"returnFields": [
{
"name": "clientMutationId",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string",
"description": "<p>A unique identifier for the client performing the mutation.</p>"
},
{
"name": "environment",
"type": "Environment",
"id": "environment",
"kind": "objects",
"href": "/graphql/reference/objects#environment",
"description": "<p>The environment that was reordered.</p>"
}
]
},
{
"name": "requestReviews",
"kind": "mutations",
@@ -25114,6 +25190,22 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#id"
},
{
"name": "isPinned",
"description": "<p>Indicates whether or not this environment is currently pinned to the repository.</p>",
"type": "Boolean",
"id": "boolean",
"kind": "scalars",
"href": "/graphql/reference/scalars#boolean"
},
{
"name": "latestCompletedDeployment",
"description": "<p>The latest completed deployment with status success, failure, or error if it exists.</p>",
"type": "Deployment",
"id": "deployment",
"kind": "objects",
"href": "/graphql/reference/objects#deployment"
},
{
"name": "name",
"description": "<p>The name of the environment.</p>",
@@ -25122,6 +25214,14 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "pinnedPosition",
"description": "<p>The position of the environment if it is pinned, null if it is not pinned.</p>",
"type": "Int",
"id": "int",
"kind": "scalars",
"href": "/graphql/reference/scalars#int"
},
{
"name": "protectionRules",
"description": "<p>The protection rules defined for this environment.</p>",
@@ -43343,6 +43443,136 @@
}
]
},
{
"name": "PinnedEnvironment",
"kind": "objects",
"id": "pinnedenvironment",
"href": "/graphql/reference/objects#pinnedenvironment",
"description": "<p>Represents a pinned environment on a given repository.</p>",
"implements": [
{
"name": "Node",
"id": "node",
"href": "/graphql/reference/interfaces#node"
}
],
"fields": [
{
"name": "createdAt",
"description": "<p>Identifies the date and time when the pinned environment was created.</p>",
"type": "DateTime!",
"id": "datetime",
"kind": "scalars",
"href": "/graphql/reference/scalars#datetime"
},
{
"name": "databaseId",
"description": "<p>Identifies the primary key from the database.</p>",
"type": "Int",
"id": "int",
"kind": "scalars",
"href": "/graphql/reference/scalars#int"
},
{
"name": "environment",
"description": "<p>Identifies the environment associated.</p>",
"type": "Environment!",
"id": "environment",
"kind": "objects",
"href": "/graphql/reference/objects#environment"
},
{
"name": "id",
"description": "<p>The Node ID of the PinnedEnvironment object.</p>",
"type": "ID!",
"id": "id",
"kind": "scalars",
"href": "/graphql/reference/scalars#id"
},
{
"name": "position",
"description": "<p>Identifies the position of the pinned environment.</p>",
"type": "Int!",
"id": "int",
"kind": "scalars",
"href": "/graphql/reference/scalars#int"
},
{
"name": "repository",
"description": "<p>The repository that this environment was pinned to.</p>",
"type": "Repository!",
"id": "repository",
"kind": "objects",
"href": "/graphql/reference/objects#repository"
}
]
},
{
"name": "PinnedEnvironmentConnection",
"kind": "objects",
"id": "pinnedenvironmentconnection",
"href": "/graphql/reference/objects#pinnedenvironmentconnection",
"description": "<p>The connection type for PinnedEnvironment.</p>",
"fields": [
{
"name": "edges",
"description": "<p>A list of edges.</p>",
"type": "[PinnedEnvironmentEdge]",
"id": "pinnedenvironmentedge",
"kind": "objects",
"href": "/graphql/reference/objects#pinnedenvironmentedge"
},
{
"name": "nodes",
"description": "<p>A list of nodes.</p>",
"type": "[PinnedEnvironment]",
"id": "pinnedenvironment",
"kind": "objects",
"href": "/graphql/reference/objects#pinnedenvironment"
},
{
"name": "pageInfo",
"description": "<p>Information to aid in pagination.</p>",
"type": "PageInfo!",
"id": "pageinfo",
"kind": "objects",
"href": "/graphql/reference/objects#pageinfo"
},
{
"name": "totalCount",
"description": "<p>Identifies the total count of items in the connection.</p>",
"type": "Int!",
"id": "int",
"kind": "scalars",
"href": "/graphql/reference/scalars#int"
}
]
},
{
"name": "PinnedEnvironmentEdge",
"kind": "objects",
"id": "pinnedenvironmentedge",
"href": "/graphql/reference/objects#pinnedenvironmentedge",
"description": "<p>An edge in a connection.</p>",
"fields": [
{
"name": "cursor",
"description": "<p>A cursor for use in pagination.</p>",
"type": "String!",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "node",
"description": "<p>The item at the end of the edge.</p>",
"type": "PinnedEnvironment",
"id": "pinnedenvironment",
"kind": "objects",
"href": "/graphql/reference/objects#pinnedenvironment"
}
]
},
{
"name": "PinnedEvent",
"kind": "objects",
@@ -59959,6 +60189,17 @@
"kind": "input-objects",
"href": "/graphql/reference/input-objects#environments"
}
},
{
"name": "pinnedEnvironmentFilter",
"defaultValue": "ALL",
"description": "<p>Filter to control pinned environments return.</p>",
"type": {
"name": "EnvironmentPinnedFilterField",
"id": "environmentpinnedfilterfield",
"kind": "enums",
"href": "/graphql/reference/enums#environmentpinnedfilterfield"
}
}
]
},
@@ -61008,6 +61249,66 @@
}
]
},
{
"name": "pinnedEnvironments",
"description": "<p>A list of pinned environments for this repository.</p>",
"type": "PinnedEnvironmentConnection",
"id": "pinnedenvironmentconnection",
"kind": "objects",
"href": "/graphql/reference/objects#pinnedenvironmentconnection",
"arguments": [
{
"name": "after",
"description": "<p>Returns the elements in the list that come after the specified cursor.</p>",
"type": {
"name": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
}
},
{
"name": "before",
"description": "<p>Returns the elements in the list that come before the specified cursor.</p>",
"type": {
"name": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
}
},
{
"name": "first",
"description": "<p>Returns the first <em>n</em> elements from the list.</p>",
"type": {
"name": "Int",
"id": "int",
"kind": "scalars",
"href": "/graphql/reference/scalars#int"
}
},
{
"name": "last",
"description": "<p>Returns the last <em>n</em> elements from the list.</p>",
"type": {
"name": "Int",
"id": "int",
"kind": "scalars",
"href": "/graphql/reference/scalars#int"
}
},
{
"name": "orderBy",
"description": "<p>Ordering options for the environments.</p>",
"type": {
"name": "PinnedEnvironmentOrder",
"id": "pinnedenvironmentorder",
"kind": "input-objects",
"href": "/graphql/reference/input-objects#pinnedenvironmentorder"
}
}
]
},
{
"name": "pinnedIssues",
"description": "<p>A list of pinned issues for this repository.</p>",
@@ -82694,6 +82995,27 @@
}
]
},
{
"name": "EnvironmentPinnedFilterField",
"kind": "enums",
"id": "environmentpinnedfilterfield",
"href": "/graphql/reference/enums#environmentpinnedfilterfield",
"description": "<p>Properties by which environments connections can be ordered.</p>",
"values": [
{
"name": "ALL",
"description": "<p>All environments will be returned.</p>"
},
{
"name": "NONE",
"description": "<p>Environments exclude pinned will be returned.</p>"
},
{
"name": "ONLY",
"description": "<p>Only pinned environment will be returned.</p>"
}
]
},
{
"name": "FileViewedState",
"kind": "enums",
@@ -84254,6 +84576,19 @@
}
]
},
{
"name": "PinnedEnvironmentOrderField",
"kind": "enums",
"id": "pinnedenvironmentorderfield",
"href": "/graphql/reference/enums#pinnedenvironmentorderfield",
"description": "<p>Properties by which pinned environments connections can be ordered.</p>",
"values": [
{
"name": "POSITION",
"description": "<p>Order pinned environments by position.</p>"
}
]
},
{
"name": "ProjectCardArchivedState",
"kind": "enums",
@@ -96953,6 +97288,40 @@
}
]
},
{
"name": "PinEnvironmentInput",
"kind": "inputObjects",
"id": "pinenvironmentinput",
"href": "/graphql/reference/input-objects#pinenvironmentinput",
"description": "<p>Autogenerated input type of PinEnvironment.</p>",
"inputFields": [
{
"name": "clientMutationId",
"description": "<p>A unique identifier for the client performing the mutation.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "environmentId",
"description": "<p>The ID of the environment to modify.</p>",
"type": "ID!",
"id": "id",
"kind": "scalars",
"href": "/graphql/reference/scalars#id",
"isDeprecated": false
},
{
"name": "pinned",
"description": "<p>The desired state of the environment. If true, environment will be pinned. If false, it will be unpinned.</p>",
"type": "Boolean!",
"id": "boolean",
"kind": "scalars",
"href": "/graphql/reference/scalars#boolean"
}
]
},
{
"name": "PinIssueInput",
"kind": "inputObjects",
@@ -96979,6 +97348,31 @@
}
]
},
{
"name": "PinnedEnvironmentOrder",
"kind": "inputObjects",
"id": "pinnedenvironmentorder",
"href": "/graphql/reference/input-objects#pinnedenvironmentorder",
"description": "<p>Ordering options for pinned environments.</p>",
"inputFields": [
{
"name": "direction",
"description": "<p>The direction in which to order pinned environments by the specified field.</p>",
"type": "OrderDirection!",
"id": "orderdirection",
"kind": "enums",
"href": "/graphql/reference/enums#orderdirection"
},
{
"name": "field",
"description": "<p>The field to order pinned environments by.</p>",
"type": "PinnedEnvironmentOrderField!",
"id": "pinnedenvironmentorderfield",
"kind": "enums",
"href": "/graphql/reference/enums#pinnedenvironmentorderfield"
}
]
},
{
"name": "ProjectCardImport",
"kind": "inputObjects",
@@ -98139,6 +98533,40 @@
}
]
},
{
"name": "ReorderEnvironmentInput",
"kind": "inputObjects",
"id": "reorderenvironmentinput",
"href": "/graphql/reference/input-objects#reorderenvironmentinput",
"description": "<p>Autogenerated input type of ReorderEnvironment.</p>",
"inputFields": [
{
"name": "clientMutationId",
"description": "<p>A unique identifier for the client performing the mutation.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "environmentId",
"description": "<p>The ID of the environment to modify.</p>",
"type": "ID!",
"id": "id",
"kind": "scalars",
"href": "/graphql/reference/scalars#id",
"isDeprecated": false
},
{
"name": "position",
"description": "<p>The desired position of the environment.</p>",
"type": "Int!",
"id": "int",
"kind": "scalars",
"href": "/graphql/reference/scalars#int"
}
]
},
{
"name": "RepositoryIdConditionTargetInput",
"kind": "inputObjects",