Grafbase API

The Grafbase Platform GraphQL API.

API Endpoints

https://api.grafbase.com/graphql

Queries

`accessTokens`

Description

Returns user access tokens for the user issuing the request.

Response

Returns an AccessTokenConnection!

Arguments

Name	Description
`after` - `String`
`before` - `String`
`first` - `Int`
`last` - `Int`

Example

Query

query accessTokens(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  accessTokens(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      ...AccessTokenEdgeFragment
    }
    nodes {
      ...AccessTokenFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}

Variables

{
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 987
}

Response

{
  "data": {
    "accessTokens": {
      "edges": [AccessTokenEdge],
      "nodes": [AccessToken],
      "pageInfo": PageInfo
    }
  }
}

Queries

`accountBySlug`

Response

Returns an Account

Arguments

Name	Description
`slug` - `String!`	slug of the account

Example

Query

query accountBySlug($slug: String!) {
  accountBySlug(slug: $slug) {
    accessTokens {
      ...AccessTokenConnectionFragment
    }
    createdAt
    graphs {
      ...GraphConnectionFragment
    }
    id
    name
    plan
    slug
    status {
      ...AccountStatusFragment
    }
    usage {
      ...AccountUsageTimeSeriesFragment
    }
  }
}

Variables

{"slug": "abc123"}

Response

{
  "data": {
    "accountBySlug": {
      "accessTokens": AccessTokenConnection,
      "createdAt": "2007-12-03T10:15:30Z",
      "graphs": GraphConnection,
      "id": 4,
      "name": "xyz789",
      "plan": "TRIAL",
      "slug": "xyz789",
      "status": AccountStatus,
      "usage": AccountUsageTimeSeries
    }
  }
}

Queries

`accountCreationValidate`

Response

Returns an AccountCreationValidatePayload!

Arguments

Name	Description
`input` - `AccountCreationValidateInput!`

Example

Query

query accountCreationValidate($input: AccountCreationValidateInput!) {
  accountCreationValidate(input: $input) {
    slugAvailable
  }
}

Variables

{"input": AccountCreationValidateInput}

Response

{"data": {"accountCreationValidate": {"slugAvailable": false}}}

Queries

`auditLogDirectDownload`

Description

Get a graph by account slug and slug of the graph itself.

Response

Returns an AuditLogDirectDownloadUrlPayload!

Arguments

Name	Description
`organizationId` - `ID!`
`start` - `DateTime!`
`end` - `DateTime`

Example

Query

query auditLogDirectDownload(
  $organizationId: ID!,
  $start: DateTime!,
  $end: DateTime
) {
  auditLogDirectDownload(
    organizationId: $organizationId,
    start: $start,
    end: $end
  ) {
    ... on AuditLogDirectDownloadSuccess {
      ...AuditLogDirectDownloadSuccessFragment
    }
    ... on NotAllowedError {
      ...NotAllowedErrorFragment
    }
    ... on OrganizationDoesNotExistError {
      ...OrganizationDoesNotExistErrorFragment
    }
  }
}

Variables

{
  "organizationId": "4",
  "start": "2007-12-03T10:15:30Z",
  "end": "2007-12-03T10:15:30Z"
}

Response

{
  "data": {
    "auditLogDirectDownload": AuditLogDirectDownloadSuccess
  }
}

Queries

`branch`

Description

Get branch by account slug, graph slug and the name of the branch.

Response

Returns a Branch

Arguments

Name	Description
`name` - `String`	name of the branch
`accountSlug` - `String`	slug of the account
`graphSlug` - `String`	slug of the graph

Example

Query

query branch(
  $name: String,
  $accountSlug: String,
  $graphSlug: String
) {
  branch(
    name: $name,
    accountSlug: $accountSlug,
    graphSlug: $graphSlug
  ) {
    activeDeployment {
      ...DeploymentFragment
    }
    analytics {
      ...GraphAnalyticsFragment
    }
    deployments {
      ...DeploymentConnectionFragment
    }
    domains
    endpointConfig {
      ...EndpointConfigFragment
    }
    environment
    federatedSchema
    graph {
      ...GraphFragment
    }
    id
    latestDeployment {
      ...DeploymentFragment
    }
    name
    operationChecksEnabled
    operationChecksIgnoreUsageData
    operationChecksSchemaProposalApprovalEnabled
    schema
    schemaProposals {
      ...SchemaProposalConnectionFragment
    }
    schemaProposalsConfiguration {
      ...SchemaProposalsConfigurationFragment
    }
    subgraphs {
      ...SubgraphFragment
    }
  }
}

Variables

{
  "name": "abc123",
  "accountSlug": "abc123",
  "graphSlug": "abc123"
}

Response

{
  "data": {
    "branch": {
      "activeDeployment": Deployment,
      "analytics": GraphAnalytics,
      "deployments": DeploymentConnection,
      "domains": ["abc123"],
      "endpointConfig": EndpointConfig,
      "environment": "PREVIEW",
      "federatedSchema": "abc123",
      "graph": Graph,
      "id": 4,
      "latestDeployment": Deployment,
      "name": "xyz789",
      "operationChecksEnabled": true,
      "operationChecksIgnoreUsageData": false,
      "operationChecksSchemaProposalApprovalEnabled": true,
      "schema": "xyz789",
      "schemaProposals": SchemaProposalConnection,
      "schemaProposalsConfiguration": SchemaProposalsConfiguration,
      "subgraphs": [Subgraph]
    }
  }
}

Queries

`deployment`

Description

Get deployment by ID.

Response

Returns a Deployment

Arguments

Name	Description
`id` - `ID!`	ID of the deployment

Example

Query

query deployment($id: ID!) {
  deployment(id: $id) {
    apiSchema
    apiSchemaDiff {
      ...DiffSnippetFragment
    }
    branch {
      ...BranchFragment
    }
    changeCounts {
      ...DeploymentChangeCountsFragment
    }
    compositionInputs {
      ...DeploymentSubgraphFragment
    }
    createdAt
    duration
    federatedSdl
    finishedAt
    id
    isRedeployable
    message
    schemaVersion {
      ...SchemaVersionFragment
    }
    startedAt
    status
    steps {
      ...DeploymentStepFragment
    }
    subgraph {
      ...DeploymentSubgraphFragment
    }
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "deployment": {
      "apiSchema": "xyz789",
      "apiSchemaDiff": [DiffSnippet],
      "branch": Branch,
      "changeCounts": DeploymentChangeCounts,
      "compositionInputs": [DeploymentSubgraph],
      "createdAt": "2007-12-03T10:15:30Z",
      "duration": 987,
      "federatedSdl": "xyz789",
      "finishedAt": "2007-12-03T10:15:30Z",
      "id": 4,
      "isRedeployable": false,
      "message": "xyz789",
      "schemaVersion": SchemaVersion,
      "startedAt": "2007-12-03T10:15:30Z",
      "status": "QUEUED",
      "steps": [DeploymentStep],
      "subgraph": DeploymentSubgraph
    }
  }
}

Queries

`extensionByName`

Response

Returns an Extension

Arguments

Name	Description
`name` - `String!`

Example

Query

query extensionByName($name: String!) {
  extensionByName(name: $name) {
    highestVersion {
      ...ExtensionVersionFragment
    }
    id
    name
    owners {
      ...UserFragment
    }
    versions {
      ...ExtensionVersionFragment
    }
  }
}

Variables

{"name": "xyz789"}

Response

{
  "data": {
    "extensionByName": {
      "highestVersion": ExtensionVersion,
      "id": "4",
      "name": "xyz789",
      "owners": [User],
      "versions": [ExtensionVersion]
    }
  }
}

Queries

`extensionVersionByNameAndVersion`

Response

Returns an ExtensionVersion

Arguments

Name	Description
`version` - `SemverVersion!`
`extensionName` - `String!`

Example

Query

query extensionVersionByNameAndVersion(
  $version: SemverVersion!,
  $extensionName: String!
) {
  extensionVersionByNameAndVersion(
    version: $version,
    extensionName: $extensionName
  ) {
    createdAt
    defaultPermissions
    definitionsSdl
    description
    extension {
      ...ExtensionFragment
    }
    homepageUrl
    kind
    license
    minimumCompatibleGatewayVersion
    publishedBy {
      ...UserFragment
    }
    readme
    repositoryUrl
    sdkVersion
    sdl
    version
  }
}

Variables

{
  "version": SemverVersion,
  "extensionName": "xyz789"
}

Response

{
  "data": {
    "extensionVersionByNameAndVersion": {
      "createdAt": "2007-12-03T10:15:30Z",
      "defaultPermissions": ["NETWORK"],
      "definitionsSdl": "xyz789",
      "description": "xyz789",
      "extension": Extension,
      "homepageUrl": Url,
      "kind": "FIELD_RESOLVER",
      "license": "xyz789",
      "minimumCompatibleGatewayVersion": SemverVersion,
      "publishedBy": User,
      "readme": "abc123",
      "repositoryUrl": Url,
      "sdkVersion": SemverVersion,
      "sdl": "abc123",
      "version": SemverVersion
    }
  }
}

Queries

`extensionVersionsByVersionRequirement`

Description

Looks for extension versions that match the requirements.

The results are returned in the same order as the requirements.

Response

Returns [ExtensionVersionMatch!]

Arguments

Name	Description
`requirements` - `[ExtensionVersionRequirement!]!`

Example

Query

query extensionVersionsByVersionRequirement($requirements: [ExtensionVersionRequirement!]!) {
  extensionVersionsByVersionRequirement(requirements: $requirements) {
    ... on ExtensionDoesNotExistError {
      ...ExtensionDoesNotExistErrorFragment
    }
    ... on ExtensionVersion {
      ...ExtensionVersionFragment
    }
    ... on ExtensionVersionDoesNotExistError {
      ...ExtensionVersionDoesNotExistErrorFragment
    }
  }
}

Variables

{"requirements": [ExtensionVersionRequirement]}

Response

{
  "data": {
    "extensionVersionsByVersionRequirement": [
      ExtensionDoesNotExistError
    ]
  }
}

Queries

`extensions`

Response

Returns an ExtensionConnection!

Arguments

Name	Description
`after` - `String`
`first` - `Int`
`filter` - `ExtensionFilter`

Example

Query

query extensions(
  $after: String,
  $first: Int,
  $filter: ExtensionFilter
) {
  extensions(
    after: $after,
    first: $first,
    filter: $filter
  ) {
    edges {
      ...ExtensionEdgeFragment
    }
    nodes {
      ...ExtensionFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}

Variables

{
  "after": "xyz789",
  "first": 123,
  "filter": ExtensionFilter
}

Response

{
  "data": {
    "extensions": {
      "edges": [ExtensionEdge],
      "nodes": [Extension],
      "pageInfo": PageInfo
    }
  }
}

Queries

`graphByAccountSlug`

Description

Get a graph by account slug and slug of the graph itself.

Response

Returns a Graph

Arguments

Name	Description
`accountSlug` - `String!`	slug of the account
`graphSlug` - `String!`	slug of the graph

Example

Query

query graphByAccountSlug(
  $accountSlug: String!,
  $graphSlug: String!
) {
  graphByAccountSlug(
    accountSlug: $accountSlug,
    graphSlug: $graphSlug
  ) {
    account {
      ...AccountFragment
    }
    analytics {
      ...GraphAnalyticsFragment
    }
    branch {
      ...BranchFragment
    }
    branches {
      ...BranchConnectionFragment
    }
    createdAt
    customCheckWebhooks {
      ...CustomCheckWebhookFragment
    }
    id
    operationChecksConfiguration {
      ...GraphOperationCheckConfigurationFragment
    }
    owners {
      ...TeamFragment
    }
    productionBranch {
      ...BranchFragment
    }
    request {
      ...RequestFragment
    }
    requests {
      ...RequestConnectionFragment
    }
    schemaChecks {
      ...SchemaCheckConnectionFragment
    }
    schemaProposals {
      ...SchemaProposalConnectionFragment
    }
    slug
  }
}

Variables

{
  "accountSlug": "abc123",
  "graphSlug": "xyz789"
}

Response

{
  "data": {
    "graphByAccountSlug": {
      "account": Account,
      "analytics": GraphAnalytics,
      "branch": Branch,
      "branches": BranchConnection,
      "createdAt": "2007-12-03T10:15:30Z",
      "customCheckWebhooks": [CustomCheckWebhook],
      "id": 4,
      "operationChecksConfiguration": GraphOperationCheckConfiguration,
      "owners": [Team],
      "productionBranch": Branch,
      "request": Request,
      "requests": RequestConnection,
      "schemaChecks": SchemaCheckConnection,
      "schemaProposals": SchemaProposalConnection,
      "slug": "xyz789"
    }
  }
}

Queries

`invite`

Response

Returns an Invite

Arguments

Name	Description
`id` - `ID!`

Example

Query

query invite($id: ID!) {
  invite(id: $id) {
    createdAt
    email
    id
    invitedBy {
      ...UserFragment
    }
    lastRenewedAt
    organization {
      ...OrganizationFragment
    }
    role
    status
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "invite": {
      "createdAt": "2007-12-03T10:15:30Z",
      "email": "abc123",
      "id": "4",
      "invitedBy": User,
      "lastRenewedAt": "2007-12-03T10:15:30Z",
      "organization": Organization,
      "role": "OWNER",
      "status": "PENDING"
    }
  }
}

Queries

`node`

Response

Returns a Node

Arguments

Name	Description
`id` - `ID!`

Example

Query

query node($id: ID!) {
  node(id: $id) {
    id
  }
}

Variables

{"id": 4}

Response

{"data": {"node": {"id": 4}}}

Queries

`notificationsInbox`

Description

Return the notifications inbox of the currently connected user.

Response

Returns a NotificationsInbox

Example

Query

query notificationsInbox {
  notificationsInbox {
    messages {
      ...InboxMessageFragment
    }
  }
}

Response

{
  "data": {
    "notificationsInbox": {"messages": [InboxMessage]}
  }
}

Queries

`schemaCheck`

Response

Returns a SchemaCheck

Arguments

Name	Description
`id` - `ID!`

Example

Query

query schemaCheck($id: ID!) {
  schemaCheck(id: $id) {
    compositionCheckErrors {
      ...CompositionCheckErrorFragment
    }
    createdAt
    diagnostics {
      ...SchemaCheckDiagnosticFragment
    }
    errorCount
    gitCommit {
      ...SchemaCheckGitCommitFragment
    }
    id
    lintCheckErrors {
      ...LintCheckErrorFragment
    }
    operationCheckErrors {
      ...OperationCheckErrorFragment
    }
    proposalCheckErrors {
      ...ProposalCheckErrorFragment
    }
    schema
    subgraphName
    validationCheckErrors {
      ...ValidationCheckErrorFragment
    }
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "schemaCheck": {
      "compositionCheckErrors": [CompositionCheckError],
      "createdAt": "2007-12-03T10:15:30Z",
      "diagnostics": [SchemaCheckDiagnostic],
      "errorCount": 123,
      "gitCommit": SchemaCheckGitCommit,
      "id": "4",
      "lintCheckErrors": [LintCheckError],
      "operationCheckErrors": [OperationCheckError],
      "proposalCheckErrors": [ProposalCheckError],
      "schema": "xyz789",
      "subgraphName": "abc123",
      "validationCheckErrors": [ValidationCheckError]
    }
  }
}

Queries

`schemaProposal`

Response

Returns a SchemaProposal

Arguments

Name	Description
`id` - `ID!`

Example

Query

query schemaProposal($id: ID!) {
  schemaProposal(id: $id) {
    activityFeed {
      ...SchemaProposalActivityFeedItemFragment
    }
    author {
      ...UserFragment
    }
    branch {
      ...BranchFragment
    }
    comments {
      ...SchemaProposalCommentFragment
    }
    createdAt
    description
    id
    reviewers {
      ... on SchemaProposalReviewerTeam {
        ...SchemaProposalReviewerTeamFragment
      }
      ... on SchemaProposalReviewerUser {
        ...SchemaProposalReviewerUserFragment
      }
    }
    revision
    status
    subgraph {
      ...SchemaProposalSubgraphFragment
    }
    subgraphs {
      ...SchemaProposalSubgraphFragment
    }
    title
    viewerIsReviewer
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "schemaProposal": {
      "activityFeed": [SchemaProposalActivityFeedItem],
      "author": User,
      "branch": Branch,
      "comments": [SchemaProposalComment],
      "createdAt": "2007-12-03T10:15:30Z",
      "description": "xyz789",
      "id": "4",
      "reviewers": [SchemaProposalReviewerTeam],
      "revision": 987,
      "status": "APPROVED",
      "subgraph": SchemaProposalSubgraph,
      "subgraphs": [SchemaProposalSubgraph],
      "title": "abc123",
      "viewerIsReviewer": true
    }
  }
}

Queries

`schemaVersion`

Response

Returns a SchemaVersion

Arguments

Name	Description
`id` - `ID!`

Example

Query

query schemaVersion($id: ID!) {
  schemaVersion(id: $id) {
    changes {
      ...SchemaVersionChangeConnectionFragment
    }
    createdAt
    delta {
      ...SchemaVersionDeltaFragment
    }
    id
    message
    schema
    subgraph {
      ...SubgraphFragment
    }
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "schemaVersion": {
      "changes": SchemaVersionChangeConnection,
      "createdAt": "2007-12-03T10:15:30Z",
      "delta": SchemaVersionDelta,
      "id": 4,
      "message": "abc123",
      "schema": "xyz789",
      "subgraph": Subgraph
    }
  }
}

Queries

`schemaVersions`

Response

Returns a SchemaVersionConnection!

Arguments

Name	Description
`after` - `String`
`before` - `String`
`first` - `Int`
`last` - `Int`
`accountSlug` - `String!`	account slug
`graphSlug` - `String`	graph slug
`branch` - `String`	name of the branch
`subgraphName` - `String`	name of the subgraph
`populated` - `Boolean!`	return only versions with changes. Default = `true`

Example

Query

query schemaVersions(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $accountSlug: String!,
  $graphSlug: String,
  $branch: String,
  $subgraphName: String,
  $populated: Boolean!
) {
  schemaVersions(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    accountSlug: $accountSlug,
    graphSlug: $graphSlug,
    branch: $branch,
    subgraphName: $subgraphName,
    populated: $populated
  ) {
    edges {
      ...SchemaVersionEdgeFragment
    }
    nodes {
      ...SchemaVersionFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}

Variables

{
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 123,
  "accountSlug": "abc123",
  "graphSlug": "abc123",
  "branch": "xyz789",
  "subgraphName": "abc123",
  "populated": true
}

Response

{
  "data": {
    "schemaVersions": {
      "edges": [SchemaVersionEdge],
      "nodes": [SchemaVersion],
      "pageInfo": PageInfo
    }
  }
}

Queries

`subgraph`

Description

Get subgraph.

Response

Returns a Subgraph

Arguments

Name	Description
`accountSlug` - `String!`	account slug
`graphSlug` - `String`	graph slug
`branch` - `String`	name of the branch
`subgraphName` - `String!`	name of the subgraph

Example

Query

query subgraph(
  $accountSlug: String!,
  $graphSlug: String,
  $branch: String,
  $subgraphName: String!
) {
  subgraph(
    accountSlug: $accountSlug,
    graphSlug: $graphSlug,
    branch: $branch,
    subgraphName: $subgraphName
  ) {
    createdAt
    name
    owners {
      ...TeamFragment
    }
    schema
    updatedAt
    url
  }
}

Variables

{
  "accountSlug": "xyz789",
  "graphSlug": "abc123",
  "branch": "abc123",
  "subgraphName": "abc123"
}

Response

{
  "data": {
    "subgraph": {
      "createdAt": "2007-12-03T10:15:30Z",
      "name": "xyz789",
      "owners": [Team],
      "schema": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z",
      "url": "xyz789"
    }
  }
}

Queries

`team`

Response

Returns a Team

Arguments

Name	Description
`id` - `ID!`

Example

Query

query team($id: ID!) {
  team(id: $id) {
    id
    members {
      ...UserConnectionFragment
    }
    name
    parent {
      ...TeamFragment
    }
    parentTeamId
    query {
      ...QueryFragment
    }
    slug
    subteams {
      ...TeamConnectionFragment
    }
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "team": {
      "id": "4",
      "members": UserConnection,
      "name": "xyz789",
      "parent": Team,
      "parentTeamId": 4,
      "query": Query,
      "slug": "abc123",
      "subteams": TeamConnection
    }
  }
}

Queries

`teamBySlug`

Response

Returns a Team

Arguments

Name	Description
`slug` - `String!`
`organizationSlug` - `String!`

Example

Query

query teamBySlug(
  $slug: String!,
  $organizationSlug: String!
) {
  teamBySlug(
    slug: $slug,
    organizationSlug: $organizationSlug
  ) {
    id
    members {
      ...UserConnectionFragment
    }
    name
    parent {
      ...TeamFragment
    }
    parentTeamId
    query {
      ...QueryFragment
    }
    slug
    subteams {
      ...TeamConnectionFragment
    }
  }
}

Variables

{
  "slug": "abc123",
  "organizationSlug": "xyz789"
}

Response

{
  "data": {
    "teamBySlug": {
      "id": 4,
      "members": UserConnection,
      "name": "abc123",
      "parent": Team,
      "parentTeamId": 4,
      "query": Query,
      "slug": "xyz789",
      "subteams": TeamConnection
    }
  }
}

Queries

`viewer`

Description

Give the actual connected user.

Response

Returns a User

Example

Query

query viewer {
  viewer {
    avatarUrl
    canStartNewTrial
    createdAt
    email
    id
    name
    organizationMemberships {
      ...MemberFragment
    }
    organizations {
      ...OrganizationConnectionFragment
    }
  }
}

Response

{
  "data": {
    "viewer": {
      "avatarUrl": "xyz789",
      "canStartNewTrial": true,
      "createdAt": "2007-12-03T10:15:30Z",
      "email": "xyz789",
      "id": "4",
      "name": "abc123",
      "organizationMemberships": [Member],
      "organizations": OrganizationConnection
    }
  }
}

Queries

`zitadelStatus`

Response

Returns a ZitadelStatus

Example

Query

query zitadelStatus {
  zitadelStatus {
    clientId
    idp
    organizationId
    redirect
    resources
  }
}

Response

{
  "data": {
    "zitadelStatus": {
      "clientId": "abc123",
      "idp": false,
      "organizationId": "abc123",
      "redirect": false,
      "resources": false
    }
  }
}

Mutations

`accessTokenCreate`

Description

Create a new access token.

Response

Returns an AccessTokenCreatePayload!

Arguments

Name	Description
`input` - `AccessTokenCreateInput!`

Example

Query

mutation accessTokenCreate($input: AccessTokenCreateInput!) {
  accessTokenCreate(input: $input) {
    ... on AccessTokenCreateSuccess {
      ...AccessTokenCreateSuccessFragment
    }
    ... on AccountIdMissingForAccountAccessTokenError {
      ...AccountIdMissingForAccountAccessTokenErrorFragment
    }
    ... on CouldNotFindGraphsError {
      ...CouldNotFindGraphsErrorFragment
    }
    ... on GraphScopeLimitExceededError {
      ...GraphScopeLimitExceededErrorFragment
    }
    ... on InvalidAccountError {
      ...InvalidAccountErrorFragment
    }
    ... on TokenLimitExceededError {
      ...TokenLimitExceededErrorFragment
    }
    ... on UserAccessTokensCannotBeScopedToAGraphError {
      ...UserAccessTokensCannotBeScopedToAGraphErrorFragment
    }
  }
}

Variables

{"input": AccessTokenCreateInput}

Response

{"data": {"accessTokenCreate": AccessTokenCreateSuccess}}

Mutations

`accessTokenDelete`

Description

Delete a given access token.

Response

Returns an AccessTokenDeletePayload!

Arguments

Name	Description
`input` - `AccessTokenDeleteInput!`

Example

Query

mutation accessTokenDelete($input: AccessTokenDeleteInput!) {
  accessTokenDelete(input: $input) {
    ... on AccessTokenDeleteSuccess {
      ...AccessTokenDeleteSuccessFragment
    }
    ... on TokenDoesNotExistError {
      ...TokenDoesNotExistErrorFragment
    }
  }
}

Variables

{"input": AccessTokenDeleteInput}

Response

{"data": {"accessTokenDelete": AccessTokenDeleteSuccess}}

Mutations

`branchCreate`

Response

Returns a BranchCreatePayload!

Arguments

Name	Description
`input` - `BranchCreateInput!`

Example

Query

mutation branchCreate($input: BranchCreateInput!) {
  branchCreate(input: $input) {
    ... on BranchAlreadyExistsError {
      ...BranchAlreadyExistsErrorFragment
    }
    ... on GraphDoesNotExistError {
      ...GraphDoesNotExistErrorFragment
    }
    ... on GraphNotSelfHostedError {
      ...GraphNotSelfHostedErrorFragment
    }
    ... on Query {
      ...QueryFragment
    }
  }
}

Variables

{"input": BranchCreateInput}

Response

{"data": {"branchCreate": BranchAlreadyExistsError}}

Mutations

`branchDelete`

Response

Returns a BranchDeletePayload!

Arguments

Name	Description
`accountSlug` - `String!`	slug of the account
`graphSlug` - `String`	slug of the graph
`branchName` - `String!`	name of the branch

Example

Query

mutation branchDelete(
  $accountSlug: String!,
  $graphSlug: String,
  $branchName: String!
) {
  branchDelete(
    accountSlug: $accountSlug,
    graphSlug: $graphSlug,
    branchName: $branchName
  ) {
    ... on BranchDoesNotExistError {
      ...BranchDoesNotExistErrorFragment
    }
    ... on CannotDeleteProductionBranchError {
      ...CannotDeleteProductionBranchErrorFragment
    }
    ... on Query {
      ...QueryFragment
    }
  }
}

Variables

{
  "accountSlug": "abc123",
  "graphSlug": "abc123",
  "branchName": "abc123"
}

Response

{"data": {"branchDelete": BranchDoesNotExistError}}

Mutations

`branchSchemaProposalsConfiguredReviewerAdd`

Response

Returns a SchemaProposalsConfiguredReviewerAddPayload!

Arguments

Name	Description
`input` - `SchemaProposalsConfiguredReviewerAddInput!`

Example

Query

mutation branchSchemaProposalsConfiguredReviewerAdd($input: SchemaProposalsConfiguredReviewerAddInput!) {
  branchSchemaProposalsConfiguredReviewerAdd(input: $input) {
    ... on AlreadyExistsError {
      ...AlreadyExistsErrorFragment
    }
    ... on BranchDoesNotExistError {
      ...BranchDoesNotExistErrorFragment
    }
    ... on SchemaProposalsConfiguredReviewerAddSuccess {
      ...SchemaProposalsConfiguredReviewerAddSuccessFragment
    }
    ... on TeamDoesNotExistError {
      ...TeamDoesNotExistErrorFragment
    }
    ... on UserDoesNotExistError {
      ...UserDoesNotExistErrorFragment
    }
  }
}

Variables

{"input": SchemaProposalsConfiguredReviewerAddInput}

Response

{
  "data": {
    "branchSchemaProposalsConfiguredReviewerAdd": AlreadyExistsError
  }
}

Mutations

`branchSchemaProposalsConfiguredReviewerRemove`

Response

Returns a SchemaProposalsConfiguredReviewerRemovePayload!

Arguments

Name	Description
`input` - `SchemaProposalsConfiguredReviewerRemoveInput!`

Example

Query

mutation branchSchemaProposalsConfiguredReviewerRemove($input: SchemaProposalsConfiguredReviewerRemoveInput!) {
  branchSchemaProposalsConfiguredReviewerRemove(input: $input) {
    ... on BranchDoesNotExistError {
      ...BranchDoesNotExistErrorFragment
    }
    ... on ReviewerDoesNotExistError {
      ...ReviewerDoesNotExistErrorFragment
    }
    ... on SchemaProposalsConfiguredReviewerRemoveSuccess {
      ...SchemaProposalsConfiguredReviewerRemoveSuccessFragment
    }
  }
}

Variables

{"input": SchemaProposalsConfiguredReviewerRemoveInput}

Response

{
  "data": {
    "branchSchemaProposalsConfiguredReviewerRemove": BranchDoesNotExistError
  }
}

Mutations

`branchUpdate`

Response

Returns a BranchUpdatePayload!

Arguments

Name	Description
`input` - `BranchUpdateInput!`

Example

Query

mutation branchUpdate($input: BranchUpdateInput!) {
  branchUpdate(input: $input) {
    ... on GraphDoesNotExistError {
      ...GraphDoesNotExistErrorFragment
    }
    ... on Query {
      ...QueryFragment
    }
  }
}

Variables

{"input": BranchUpdateInput}

Response

{"data": {"branchUpdate": GraphDoesNotExistError}}

Mutations

`deleteSubgraph`

Description

Delete a subgraph

Response

Returns a DeleteSubgraphPayload!

Arguments

Name	Description
`input` - `DeleteSubgraphInput!`

Example

Query

mutation deleteSubgraph($input: DeleteSubgraphInput!) {
  deleteSubgraph(input: $input) {
    ... on DeleteSubgraphDeploymentFailure {
      ...DeleteSubgraphDeploymentFailureFragment
    }
    ... on DeleteSubgraphSuccess {
      ...DeleteSubgraphSuccessFragment
    }
    ... on FederatedGraphCompositionError {
      ...FederatedGraphCompositionErrorFragment
    }
    ... on GraphBranchDoesNotExistError {
      ...GraphBranchDoesNotExistErrorFragment
    }
    ... on GraphDoesNotExistError {
      ...GraphDoesNotExistErrorFragment
    }
    ... on GraphNotFederatedError {
      ...GraphNotFederatedErrorFragment
    }
    ... on SubgraphNotFoundError {
      ...SubgraphNotFoundErrorFragment
    }
  }
}

Variables

{"input": DeleteSubgraphInput}

Response

{
  "data": {
    "deleteSubgraph": DeleteSubgraphDeploymentFailure
  }
}

Mutations

`endpointConfigUpdate`

Response

Returns an EndpointConfigUpdatePayload!

Arguments

Name	Description
`input` - `EndpointConfigUpdateInput!`

Example

Query

mutation endpointConfigUpdate($input: EndpointConfigUpdateInput!) {
  endpointConfigUpdate(input: $input) {
    ... on GraphDoesNotExistError {
      ...GraphDoesNotExistErrorFragment
    }
    ... on Query {
      ...QueryFragment
    }
  }
}

Variables

{"input": EndpointConfigUpdateInput}

Response

{"data": {"endpointConfigUpdate": GraphDoesNotExistError}}

Mutations

`extensionAddOwner`

Response

Returns an ExtensionAddOwnerPayload

Arguments

Name	Description
`extensionName` - `String!`
`userId` - `ID!`

Example

Query

mutation extensionAddOwner(
  $extensionName: String!,
  $userId: ID!
) {
  extensionAddOwner(
    extensionName: $extensionName,
    userId: $userId
  ) {
    ... on ExtensionAddOwnerSuccess {
      ...ExtensionAddOwnerSuccessFragment
    }
    ... on ExtensionDoesNotExistError {
      ...ExtensionDoesNotExistErrorFragment
    }
    ... on ExtensionUnauthorized {
      ...ExtensionUnauthorizedFragment
    }
  }
}

Variables

{
  "extensionName": "xyz789",
  "userId": "4"
}

Response

{"data": {"extensionAddOwner": ExtensionAddOwnerSuccess}}

Mutations

`extensionPublish`

Description

Publish a version of an extension to the registry. If the extension does not already exist, it will be created.

Response

Returns an ExtensionPublishPayload

Arguments

Name	Description
`manifest` - `VersionedExtensionManifest!`
`wasmModule` - `Upload!`

Example

Query

mutation extensionPublish(
  $manifest: VersionedExtensionManifest!,
  $wasmModule: Upload!
) {
  extensionPublish(
    manifest: $manifest,
    wasmModule: $wasmModule
  ) {
    ... on BadWasmModuleError {
      ...BadWasmModuleErrorFragment
    }
    ... on ExtensionPublishSuccess {
      ...ExtensionPublishSuccessFragment
    }
    ... on ExtensionUnauthorized {
      ...ExtensionUnauthorizedFragment
    }
    ... on ExtensionValidationError {
      ...ExtensionValidationErrorFragment
    }
    ... on ExtensionVersionAlreadyExistsError {
      ...ExtensionVersionAlreadyExistsErrorFragment
    }
  }
}

Variables

{
  "manifest": VersionedExtensionManifest,
  "wasmModule": Upload
}

Response

{"data": {"extensionPublish": BadWasmModuleError}}

Mutations

`extensionRemoveOwner`

Response

Returns an ExtensionRemoveOwnerPayload

Arguments

Name	Description
`extensionName` - `String!`
`userId` - `ID!`

Example

Query

mutation extensionRemoveOwner(
  $extensionName: String!,
  $userId: ID!
) {
  extensionRemoveOwner(
    extensionName: $extensionName,
    userId: $userId
  ) {
    ... on ExtensionDoesNotExistError {
      ...ExtensionDoesNotExistErrorFragment
    }
    ... on ExtensionRemoveOwnerSuccess {
      ...ExtensionRemoveOwnerSuccessFragment
    }
    ... on ExtensionUnauthorized {
      ...ExtensionUnauthorizedFragment
    }
  }
}

Variables

{
  "extensionName": "xyz789",
  "userId": "4"
}

Response

{
  "data": {
    "extensionRemoveOwner": ExtensionDoesNotExistError
  }
}

Mutations

`graphAddOwner`

Response

Returns a GraphAddOwnerPayload!

Arguments

Name	Description
`graphId` - `ID!`
`ownerId` - `ID!`

Example

Query

mutation graphAddOwner(
  $graphId: ID!,
  $ownerId: ID!
) {
  graphAddOwner(
    graphId: $graphId,
    ownerId: $ownerId
  ) {
    ... on GraphAddOwnerSuccess {
      ...GraphAddOwnerSuccessFragment
    }
    ... on GraphDoesNotExistError {
      ...GraphDoesNotExistErrorFragment
    }
    ... on NotAllowedError {
      ...NotAllowedErrorFragment
    }
  }
}

Variables

{"graphId": 4, "ownerId": "4"}

Response

{"data": {"graphAddOwner": GraphAddOwnerSuccess}}

Mutations

`graphCreate`

Description

Create a new graph without any source for an initial deployment.

Response

Returns a GraphCreatePayload!

Arguments

Name	Description
`input` - `GraphCreateInput!`

Example

Query

mutation graphCreate($input: GraphCreateInput!) {
  graphCreate(input: $input) {
    ... on AccountDoesNotExistError {
      ...AccountDoesNotExistErrorFragment
    }
    ... on CurrentPlanLimitReachedError {
      ...CurrentPlanLimitReachedErrorFragment
    }
    ... on DisabledAccountError {
      ...DisabledAccountErrorFragment
    }
    ... on GraphCreateSuccess {
      ...GraphCreateSuccessFragment
    }
    ... on ManagedGraphsNoLongerSupportedError {
      ...ManagedGraphsNoLongerSupportedErrorFragment
    }
    ... on SlugAlreadyExistsError {
      ...SlugAlreadyExistsErrorFragment
    }
    ... on SlugInvalidError {
      ...SlugInvalidErrorFragment
    }
    ... on SlugTooLongError {
      ...SlugTooLongErrorFragment
    }
    ... on StandaloneGraphsNoLongerSupportedError {
      ...StandaloneGraphsNoLongerSupportedErrorFragment
    }
  }
}

Variables

{"input": GraphCreateInput}

Response

{"data": {"graphCreate": AccountDoesNotExistError}}

Mutations

`graphDelete`

Response

Returns a GraphDeletePayload!

Arguments

Name	Description
`input` - `GraphDeleteInput!`

Example

Query

mutation graphDelete($input: GraphDeleteInput!) {
  graphDelete(input: $input) {
    ... on GraphDeleteSuccess {
      ...GraphDeleteSuccessFragment
    }
    ... on GraphDoesNotExistError {
      ...GraphDoesNotExistErrorFragment
    }
    ... on NotAllowedError {
      ...NotAllowedErrorFragment
    }
  }
}

Variables

{"input": GraphDeleteInput}

Response

{"data": {"graphDelete": GraphDeleteSuccess}}

Mutations

`graphOperationCheckConfigurationUpdate`

Response

Returns a GraphOperationCheckConfigurationUpdatePayload!

Arguments

Name	Description
`input` - `GraphOperationCheckConfigurationInput!`

Example

Query

mutation graphOperationCheckConfigurationUpdate($input: GraphOperationCheckConfigurationInput!) {
  graphOperationCheckConfigurationUpdate(input: $input) {
    ... on GraphDoesNotExistError {
      ...GraphDoesNotExistErrorFragment
    }
    ... on GraphOperationCheckConfiguration {
      ...GraphOperationCheckConfigurationFragment
    }
    ... on NotAllowedError {
      ...NotAllowedErrorFragment
    }
  }
}

Variables

{"input": GraphOperationCheckConfigurationInput}

Response

{
  "data": {
    "graphOperationCheckConfigurationUpdate": GraphDoesNotExistError
  }
}

Mutations

`graphRemoveOwner`

Response

Returns a GraphRemoveOwnerPayload!

Arguments

Name	Description
`graphId` - `ID!`
`ownerId` - `ID!`

Example

Query

mutation graphRemoveOwner(
  $graphId: ID!,
  $ownerId: ID!
) {
  graphRemoveOwner(
    graphId: $graphId,
    ownerId: $ownerId
  ) {
    ... on GraphDoesNotExistError {
      ...GraphDoesNotExistErrorFragment
    }
    ... on GraphRemoveOwnerSuccess {
      ...GraphRemoveOwnerSuccessFragment
    }
    ... on NotAllowedError {
      ...NotAllowedErrorFragment
    }
  }
}

Variables

{
  "graphId": "4",
  "ownerId": "4"
}

Response

{"data": {"graphRemoveOwner": GraphDoesNotExistError}}

Mutations

`graphUpdate`

Response

Returns a GraphUpdatePayload!

Arguments

Name	Description
`input` - `GraphUpdateInput!`

Example

Query

mutation graphUpdate($input: GraphUpdateInput!) {
  graphUpdate(input: $input) {
    ... on CannotBeRenamedError {
      ...CannotBeRenamedErrorFragment
    }
    ... on GraphDoesNotExistError {
      ...GraphDoesNotExistErrorFragment
    }
    ... on GraphUpdateSuccess {
      ...GraphUpdateSuccessFragment
    }
    ... on NotAllowedError {
      ...NotAllowedErrorFragment
    }
    ... on SlugAlreadyExistsError {
      ...SlugAlreadyExistsErrorFragment
    }
    ... on SlugInvalidError {
      ...SlugInvalidErrorFragment
    }
    ... on SlugTooLongError {
      ...SlugTooLongErrorFragment
    }
  }
}

Variables

{"input": GraphUpdateInput}

Response

{"data": {"graphUpdate": CannotBeRenamedError}}

Mutations

`inviteAccept`

Response

Returns an InviteAcceptPayload!

Arguments

Name	Description
`input` - `InviteAcceptInput!`

Example

Query

mutation inviteAccept($input: InviteAcceptInput!) {
  inviteAccept(input: $input) {
    ... on AlreadyMemberError {
      ...AlreadyMemberErrorFragment
    }
    ... on CannotUseInvitationsWithSso {
      ...CannotUseInvitationsWithSsoFragment
    }
    ... on InviteAcceptSuccess {
      ...InviteAcceptSuccessFragment
    }
    ... on InviteDoesNotExistError {
      ...InviteDoesNotExistErrorFragment
    }
  }
}

Variables

{"input": InviteAcceptInput}

Response

{"data": {"inviteAccept": AlreadyMemberError}}

Mutations

`inviteCancel`

Response

Returns an InviteCancelPayload!

Arguments

Name	Description
`input` - `InviteCancelInput!`

Example

Query

mutation inviteCancel($input: InviteCancelInput!) {
  inviteCancel(input: $input) {
    ... on InviteCancelSuccess {
      ...InviteCancelSuccessFragment
    }
    ... on InviteDoesNotExistError {
      ...InviteDoesNotExistErrorFragment
    }
    ... on NotAllowedToCancelInvitesError {
      ...NotAllowedToCancelInvitesErrorFragment
    }
  }
}

Variables

{"input": InviteCancelInput}

Response

{"data": {"inviteCancel": InviteCancelSuccess}}

Mutations

`inviteDecline`

Response

Returns an InviteDeclinePayload!

Arguments

Name	Description
`input` - `InviteDeclineInput!`

Example

Query

mutation inviteDecline($input: InviteDeclineInput!) {
  inviteDecline(input: $input) {
    ... on InviteDeclineSuccess {
      ...InviteDeclineSuccessFragment
    }
    ... on InviteDoesNotExistError {
      ...InviteDoesNotExistErrorFragment
    }
  }
}

Variables

{"input": InviteDeclineInput}

Response

{"data": {"inviteDecline": InviteDeclineSuccess}}

Mutations

`inviteSend`

Response

Returns an InviteSendPayload!

Arguments

Name	Description
`input` - `InviteSendInput!`

Example

Query

mutation inviteSend($input: InviteSendInput!) {
  inviteSend(input: $input) {
    ... on CannotUseInvitationsWithSso {
      ...CannotUseInvitationsWithSsoFragment
    }
    ... on InvalidEmailAddressError {
      ...InvalidEmailAddressErrorFragment
    }
    ... on InviteSendSuccess {
      ...InviteSendSuccessFragment
    }
    ... on NotAllowedToSendInvitesError {
      ...NotAllowedToSendInvitesErrorFragment
    }
    ... on OrganizationDoesNotExistError {
      ...OrganizationDoesNotExistErrorFragment
    }
  }
}

Variables

{"input": InviteSendInput}

Response

{"data": {"inviteSend": CannotUseInvitationsWithSso}}

Mutations

`memberDelete`

Description

Remove member from an organization

Response

Returns a MemberDeletePayload!

Arguments

Name	Description
`input` - `MemberDeleteInput!`

Example

Query

mutation memberDelete($input: MemberDeleteInput!) {
  memberDelete(input: $input) {
    deletedMemberId
    query {
      ...QueryFragment
    }
  }
}

Variables

{"input": MemberDeleteInput}

Response

{
  "data": {
    "memberDelete": {"deletedMemberId": 4, "query": Query}
  }
}

Mutations

`memberUpdate`

Description

Update role of an organization member

Response

Returns a MemberUpdatePayload!

Arguments

Name	Description
`input` - `MemberUpdateInput!`

Example

Query

mutation memberUpdate($input: MemberUpdateInput!) {
  memberUpdate(input: $input) {
    member {
      ...MemberFragment
    }
    query {
      ...QueryFragment
    }
  }
}

Variables

{"input": MemberUpdateInput}

Response

{
  "data": {
    "memberUpdate": {
      "member": Member,
      "query": Query
    }
  }
}

Mutations

`notificationsMarkAsRead`

Response

Returns a NotificationsMarkAsReadPayload!

Arguments

Name	Description
`notificationIds` - `[ID!]!`

Example

Query

mutation notificationsMarkAsRead($notificationIds: [ID!]!) {
  notificationsMarkAsRead(notificationIds: $notificationIds) {
    ... on NotificationsMarkAsReadSuccess {
      ...NotificationsMarkAsReadSuccessFragment
    }
  }
}

Variables

{"notificationIds": ["4"]}

Response

{
  "data": {
    "notificationsMarkAsRead": NotificationsMarkAsReadSuccess
  }
}

Mutations

`organizationCreate`

Description

Create new organization account owned by the current user. Slug must be unique.

Response

Returns an OrganizationCreatePayload!

Arguments

Name	Description
`input` - `OrganizationCreateInput!`

Example

Query

mutation organizationCreate($input: OrganizationCreateInput!) {
  organizationCreate(input: $input) {
    ... on NameSizeCheckError {
      ...NameSizeCheckErrorFragment
    }
    ... on OrganizationCreateSuccess {
      ...OrganizationCreateSuccessFragment
    }
    ... on ReservedSlugsCheckError {
      ...ReservedSlugsCheckErrorFragment
    }
    ... on SlugAlreadyExistsError {
      ...SlugAlreadyExistsErrorFragment
    }
    ... on SlugError {
      ...SlugErrorFragment
    }
    ... on SlugSizeCheckError {
      ...SlugSizeCheckErrorFragment
    }
    ... on TrialPlanUnavailableError {
      ...TrialPlanUnavailableErrorFragment
    }
  }
}

Variables

{"input": OrganizationCreateInput}

Response

{"data": {"organizationCreate": NameSizeCheckError}}

Mutations

`organizationDelete`

Response

Returns an OrganizationDeletePayload!

Arguments

Name	Description
`input` - `OrganizationDeleteInput!`

Example

Query

mutation organizationDelete($input: OrganizationDeleteInput!) {
  organizationDelete(input: $input) {
    ... on NotAllowedToDeleteOrganizationError {
      ...NotAllowedToDeleteOrganizationErrorFragment
    }
    ... on OrganizationDeleteSuccess {
      ...OrganizationDeleteSuccessFragment
    }
    ... on OrganizationDoesNotExistError {
      ...OrganizationDoesNotExistErrorFragment
    }
  }
}

Variables

{"input": OrganizationDeleteInput}

Response

{
  "data": {
    "organizationDelete": NotAllowedToDeleteOrganizationError
  }
}

Mutations

`organizationSlugUpdate`

Response

Returns an OrganizationSlugUpdatePayload!

Arguments

Name	Description
`input` - `OrganizationSlugUpdateInput!`

Example

Query

mutation organizationSlugUpdate($input: OrganizationSlugUpdateInput!) {
  organizationSlugUpdate(input: $input) {
    ... on NotAllowedToSlugUpdateError {
      ...NotAllowedToSlugUpdateErrorFragment
    }
    ... on OrganizationDoesNotExistError {
      ...OrganizationDoesNotExistErrorFragment
    }
    ... on OrganizationSlugUpdateSuccess {
      ...OrganizationSlugUpdateSuccessFragment
    }
    ... on ReservedSlugsCheckError {
      ...ReservedSlugsCheckErrorFragment
    }
    ... on SlugAlreadyExistsError {
      ...SlugAlreadyExistsErrorFragment
    }
    ... on SlugError {
      ...SlugErrorFragment
    }
    ... on SlugSizeCheckError {
      ...SlugSizeCheckErrorFragment
    }
  }
}

Variables

{"input": OrganizationSlugUpdateInput}

Response

{
  "data": {
    "organizationSlugUpdate": NotAllowedToSlugUpdateError
  }
}

Mutations

`organizationUpdate`

Response

Returns an OrganizationUpdatePayload!

Arguments

Name	Description
`input` - `OrganizationUpdateInput!`

Example

Query

mutation organizationUpdate($input: OrganizationUpdateInput!) {
  organizationUpdate(input: $input) {
    ... on NameSizeCheckError {
      ...NameSizeCheckErrorFragment
    }
    ... on NotAllowedToUpdateOrganizationError {
      ...NotAllowedToUpdateOrganizationErrorFragment
    }
    ... on OrganizationDoesNotExistError {
      ...OrganizationDoesNotExistErrorFragment
    }
    ... on OrganizationUpdateSuccess {
      ...OrganizationUpdateSuccessFragment
    }
  }
}

Variables

{"input": OrganizationUpdateInput}

Response

{"data": {"organizationUpdate": NameSizeCheckError}}

Mutations

`personalAccountUpdate`

to be removed

Response

Returns a PersonalAccountUpdatePayload!

Arguments

Name	Description
`input` - `PersonalAccountUpdateInput!`

Example

Query

mutation personalAccountUpdate($input: PersonalAccountUpdateInput!) {
  personalAccountUpdate(input: $input) {
    ... on NameSizeCheckError {
      ...NameSizeCheckErrorFragment
    }
    ... on PersonalAccountUpdateSuccess {
      ...PersonalAccountUpdateSuccessFragment
    }
  }
}

Variables

{"input": PersonalAccountUpdateInput}

Response

{"data": {"personalAccountUpdate": NameSizeCheckError}}

Mutations

`publish`

Description

Publish a new subgraph.

Response

Returns a PublishPayload!

Arguments

Name	Description
`input` - `PublishInput!`

Example

Query

mutation publish($input: PublishInput!) {
  publish(input: $input) {
    ... on FederatedGraphCompositionError {
      ...FederatedGraphCompositionErrorFragment
    }
    ... on GraphDoesNotExistError {
      ...GraphDoesNotExistErrorFragment
    }
    ... on PublishDeploymentFailure {
      ...PublishDeploymentFailureFragment
    }
    ... on PublishForbidden {
      ...PublishForbiddenFragment
    }
    ... on PublishNoChange {
      ...PublishNoChangeFragment
    }
    ... on PublishSuccess {
      ...PublishSuccessFragment
    }
    ... on SchemaRegistryBranchDoesNotExistError {
      ...SchemaRegistryBranchDoesNotExistErrorFragment
    }
  }
}

Variables

{"input": PublishInput}

Response

{"data": {"publish": FederatedGraphCompositionError}}

Mutations

`schemaCheckCreate`

Description

Run checks against the given schema

Response

Returns a SchemaCheckPayload!

Arguments

Name	Description
`input` - `SchemaCheckCreateInput!`

Example

Query

mutation schemaCheckCreate($input: SchemaCheckCreateInput!) {
  schemaCheckCreate(input: $input) {
    ... on GraphBranchDoesNotExistError {
      ...GraphBranchDoesNotExistErrorFragment
    }
    ... on GraphDoesNotExistError {
      ...GraphDoesNotExistErrorFragment
    }
    ... on SchemaCheck {
      ...SchemaCheckFragment
    }
    ... on SubgraphNameMissingOnFederatedGraphError {
      ...SubgraphNameMissingOnFederatedGraphErrorFragment
    }
  }
}

Variables

{"input": SchemaCheckCreateInput}

Response

{
  "data": {
    "schemaCheckCreate": GraphBranchDoesNotExistError
  }
}

Mutations

`schemaCheckCustomWebhookCreate`

Description

Create a SchemaCheckCustomWebhook for a specific graph. Must be issued while logged in as a user.

Response

Returns a SchemaCheckCustomWebhookCreatePayload

Arguments

Name	Description
`input` - `SchemaCheckCustomWebhookCreateInput!`

Example

Query

mutation schemaCheckCustomWebhookCreate($input: SchemaCheckCustomWebhookCreateInput!) {
  schemaCheckCustomWebhookCreate(input: $input) {
    ... on SchemaCheckCustomWebhookCreateSuccess {
      ...SchemaCheckCustomWebhookCreateSuccessFragment
    }
  }
}

Variables

{"input": SchemaCheckCustomWebhookCreateInput}

Response

{
  "data": {
    "schemaCheckCustomWebhookCreate": SchemaCheckCustomWebhookCreateSuccess
  }
}

Mutations

`schemaCheckCustomWebhookDelete`

Description

Delete a [CustomCheckWebhook] by id.

Response

Returns a SchemaCheckCustomWebhookDeletePayload

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation schemaCheckCustomWebhookDelete($id: ID!) {
  schemaCheckCustomWebhookDelete(id: $id) {
    ... on CustomCheckWebhookNotFoundError {
      ...CustomCheckWebhookNotFoundErrorFragment
    }
    ... on SchemaCheckCustomWebhookDeleteSuccess {
      ...SchemaCheckCustomWebhookDeleteSuccessFragment
    }
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "schemaCheckCustomWebhookDelete": CustomCheckWebhookNotFoundError
  }
}

Mutations

`schemaCheckCustomWebhookUpdate`

Description

Update a [CustomCheckWebhook] by id.

Response

Returns a SchemaCheckCustomWebhookUpdatePayload

Arguments

Name	Description
`input` - `SchemaCheckCustomWebhookUpdateInput!`

Example

Query

mutation schemaCheckCustomWebhookUpdate($input: SchemaCheckCustomWebhookUpdateInput!) {
  schemaCheckCustomWebhookUpdate(input: $input) {
    ... on SchemaCheckCustomWebhookUpdateSuccess {
      ...SchemaCheckCustomWebhookUpdateSuccessFragment
    }
  }
}

Variables

{"input": SchemaCheckCustomWebhookUpdateInput}

Response

{
  "data": {
    "schemaCheckCustomWebhookUpdate": SchemaCheckCustomWebhookUpdateSuccess
  }
}

Mutations

`schemaProposalApprove`

Response

Returns a SchemaProposalApprovePayload!

Arguments

Name	Description
`input` - `SchemaProposalApproveInput!`

Example

Query

mutation schemaProposalApprove($input: SchemaProposalApproveInput!) {
  schemaProposalApprove(input: $input) {
    ... on SchemaProposalApproveSuccess {
      ...SchemaProposalApproveSuccessFragment
    }
    ... on SchemaProposalDoesNotExistError {
      ...SchemaProposalDoesNotExistErrorFragment
    }
  }
}

Variables

{"input": SchemaProposalApproveInput}

Response

{
  "data": {
    "schemaProposalApprove": SchemaProposalApproveSuccess
  }
}

Mutations

`schemaProposalCommentReply`

Response

Returns a SchemaProposalCommentReplyPayload!

Arguments

Name	Description
`parentCommentId` - `ID!`
`text` - `String!`

Example

Query

mutation schemaProposalCommentReply(
  $parentCommentId: ID!,
  $text: String!
) {
  schemaProposalCommentReply(
    parentCommentId: $parentCommentId,
    text: $text
  ) {
    ... on SchemaProposalCommentReplySuccess {
      ...SchemaProposalCommentReplySuccessFragment
    }
  }
}

Variables

{"parentCommentId": 4, "text": "abc123"}

Response

{
  "data": {
    "schemaProposalCommentReply": SchemaProposalCommentReplySuccess
  }
}

Mutations

`schemaProposalCommentThreadCreate`

Response

Returns a SchemaProposalCommentThreadCreatePayload!

Arguments

Name	Description
`input` - `SchemaProposalCommentThreadCreateInput!`

Example

Query

mutation schemaProposalCommentThreadCreate($input: SchemaProposalCommentThreadCreateInput!) {
  schemaProposalCommentThreadCreate(input: $input) {
    ... on SchemaProposalCommentThreadCreateSuccess {
      ...SchemaProposalCommentThreadCreateSuccessFragment
    }
    ... on SchemaProposalDoesNotExistError {
      ...SchemaProposalDoesNotExistErrorFragment
    }
  }
}

Variables

{"input": SchemaProposalCommentThreadCreateInput}

Response

{
  "data": {
    "schemaProposalCommentThreadCreate": SchemaProposalCommentThreadCreateSuccess
  }
}

Mutations

`schemaProposalCommentThreadResolve`

Description

Mark a comment thread as resolved.

Response

Returns a SchemaProposalCommentThreadResolvePayload!

Arguments

Name	Description
`rootCommentId` - `ID!`

Example

Query

mutation schemaProposalCommentThreadResolve($rootCommentId: ID!) {
  schemaProposalCommentThreadResolve(rootCommentId: $rootCommentId) {
    ... on SchemaProposalCommentThreadResolveSuccess {
      ...SchemaProposalCommentThreadResolveSuccessFragment
    }
  }
}

Variables

{"rootCommentId": "4"}

Response

{
  "data": {
    "schemaProposalCommentThreadResolve": SchemaProposalCommentThreadResolveSuccess
  }
}

Mutations

`schemaProposalCommentThreadUnresolve`

Description

Reverts the resolution of a comment thread.

Response

Returns a SchemaProposalCommentThreadUnresolvePayload!

Arguments

Name	Description
`rootCommentId` - `ID!`

Example

Query

mutation schemaProposalCommentThreadUnresolve($rootCommentId: ID!) {
  schemaProposalCommentThreadUnresolve(rootCommentId: $rootCommentId) {
    ... on SchemaProposalCommentThreadUnresolveSuccess {
      ...SchemaProposalCommentThreadUnresolveSuccessFragment
    }
  }
}

Variables

{"rootCommentId": 4}

Response

{
  "data": {
    "schemaProposalCommentThreadUnresolve": SchemaProposalCommentThreadUnresolveSuccess
  }
}

Mutations

`schemaProposalCreate`

Response

Returns a SchemaProposalCreatePayload!

Arguments

Name	Description
`input` - `SchemaProposalCreateInput!`

Example

Query

mutation schemaProposalCreate($input: SchemaProposalCreateInput!) {
  schemaProposalCreate(input: $input) {
    ... on SchemaProposalCreateSuccess {
      ...SchemaProposalCreateSuccessFragment
    }
  }
}

Variables

{"input": SchemaProposalCreateInput}

Response

{
  "data": {
    "schemaProposalCreate": SchemaProposalCreateSuccess
  }
}

Mutations

`schemaProposalDelete`

Response

Returns a SchemaProposalDeletePayload!

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation schemaProposalDelete($id: ID!) {
  schemaProposalDelete(id: $id) {
    ... on SchemaProposalDeleteSuccess {
      ...SchemaProposalDeleteSuccessFragment
    }
    ... on SchemaProposalDoesNotExistError {
      ...SchemaProposalDoesNotExistErrorFragment
    }
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "schemaProposalDelete": SchemaProposalDeleteSuccess
  }
}

Mutations

`schemaProposalEdit`

Description

Edit the contents of a proposal.

The proposed subgraphs can be just a subset of the subgraphs being edited in the proposal. The changes from the previous edit on other subgraphs be carried over.

Response

Returns a SchemaProposalEditPayload!

Arguments

Name	Description
`input` - `SchemaProposalEditInput!`

Example

Query

mutation schemaProposalEdit($input: SchemaProposalEditInput!) {
  schemaProposalEdit(input: $input) {
    ... on SchemaProposalDoesNotExistError {
      ...SchemaProposalDoesNotExistErrorFragment
    }
    ... on SchemaProposalEditParserErrors {
      ...SchemaProposalEditParserErrorsFragment
    }
    ... on SchemaProposalEditSuccess {
      ...SchemaProposalEditSuccessFragment
    }
  }
}

Variables

{"input": SchemaProposalEditInput}

Response

{
  "data": {
    "schemaProposalEdit": SchemaProposalDoesNotExistError
  }
}

Mutations

`schemaProposalReject`

Response

Returns a SchemaProposalRejectPayload!

Arguments

Name	Description
`input` - `SchemaProposalRejectInput!`

Example

Query

mutation schemaProposalReject($input: SchemaProposalRejectInput!) {
  schemaProposalReject(input: $input) {
    ... on SchemaProposalDoesNotExistError {
      ...SchemaProposalDoesNotExistErrorFragment
    }
    ... on SchemaProposalRejectSuccess {
      ...SchemaProposalRejectSuccessFragment
    }
  }
}

Variables

{"input": SchemaProposalRejectInput}

Response

{
  "data": {
    "schemaProposalReject": SchemaProposalDoesNotExistError
  }
}

Mutations

`schemaProposalRequestReview`

Response

Returns a SchemaProposalRequestReviewPayload!

Arguments

Name	Description
`input` - `SchemaProposalRequestReviewInput!`

Example

Query

mutation schemaProposalRequestReview($input: SchemaProposalRequestReviewInput!) {
  schemaProposalRequestReview(input: $input) {
    ... on SchemaProposalDoesNotExistError {
      ...SchemaProposalDoesNotExistErrorFragment
    }
    ... on SchemaProposalRequestReviewSuccess {
      ...SchemaProposalRequestReviewSuccessFragment
    }
  }
}

Variables

{"input": SchemaProposalRequestReviewInput}

Response

{
  "data": {
    "schemaProposalRequestReview": SchemaProposalDoesNotExistError
  }
}

Mutations

`schemaProposalRevertToDraft`

Description

Take a schema proposal back to draft status. This is possible from any state.

Response

Returns a SchemaProposalRevertToDraftPayload!

Arguments

Name	Description
`schemaProposalId` - `ID!`

Example

Query

mutation schemaProposalRevertToDraft($schemaProposalId: ID!) {
  schemaProposalRevertToDraft(schemaProposalId: $schemaProposalId) {
    ... on SchemaProposalDoesNotExistError {
      ...SchemaProposalDoesNotExistErrorFragment
    }
    ... on SchemaProposalRevertToDraftSuccess {
      ...SchemaProposalRevertToDraftSuccessFragment
    }
  }
}

Variables

{"schemaProposalId": 4}

Response

{
  "data": {
    "schemaProposalRevertToDraft": SchemaProposalDoesNotExistError
  }
}

Mutations

`schemaProposalReviewRequestCreate`

Description

Request a review for a schema proposal from a user or a team.

Response

Returns a SchemaProposalReviewRequestCreatePayload!

Arguments

Name	Description
`input` - `SchemaProposalReviewRequestCreateInput!`

Example

Query

mutation schemaProposalReviewRequestCreate($input: SchemaProposalReviewRequestCreateInput!) {
  schemaProposalReviewRequestCreate(input: $input) {
    ... on SchemaProposalDoesNotExistError {
      ...SchemaProposalDoesNotExistErrorFragment
    }
    ... on SchemaProposalReviewRequestCreateSuccess {
      ...SchemaProposalReviewRequestCreateSuccessFragment
    }
  }
}

Variables

{"input": SchemaProposalReviewRequestCreateInput}

Response

{
  "data": {
    "schemaProposalReviewRequestCreate": SchemaProposalDoesNotExistError
  }
}

Mutations

`schemaProposalUpdate`

Description

Update schema proposal metadata (title and description).

Response

Returns a SchemaProposalUpdatePayload!

Arguments

Name	Description
`input` - `SchemaProposalUpdateInput!`

Example

Query

mutation schemaProposalUpdate($input: SchemaProposalUpdateInput!) {
  schemaProposalUpdate(input: $input) {
    ... on SchemaProposalDoesNotExistError {
      ...SchemaProposalDoesNotExistErrorFragment
    }
    ... on SchemaProposalUpdateSuccess {
      ...SchemaProposalUpdateSuccessFragment
    }
  }
}

Variables

{"input": SchemaProposalUpdateInput}

Response

{
  "data": {
    "schemaProposalUpdate": SchemaProposalDoesNotExistError
  }
}

Mutations

`slackIntegrationCreate`

Response

Returns a SlackNotificationCreatePayload!

Arguments

Name	Description
`input` - `SlackIntegrationCreateInput!`

Example

Query

mutation slackIntegrationCreate($input: SlackIntegrationCreateInput!) {
  slackIntegrationCreate(input: $input) {
    ... on GraphDoesNotExistError {
      ...GraphDoesNotExistErrorFragment
    }
    ... on SlackNotification {
      ...SlackNotificationFragment
    }
  }
}

Variables

{"input": SlackIntegrationCreateInput}

Response

{
  "data": {
    "slackIntegrationCreate": GraphDoesNotExistError
  }
}

Mutations

`slackNotificationDelete`

Response

Returns a SlackNotificationDeletePayload!

Arguments

Name	Description
`id` - `String!`

Example

Query

mutation slackNotificationDelete($id: String!) {
  slackNotificationDelete(id: $id) {
    ... on Query {
      ...QueryFragment
    }
  }
}

Variables

{"id": "xyz789"}

Response

{"data": {"slackNotificationDelete": Query}}

Mutations

`subgraphAddOwner`

Description

Assign a team as the owner of a subgraph

Response

Returns a SubgraphAddOwnerPayload!

Arguments

Name	Description
`branchId` - `ID!`
`subgraphName` - `String!`
`owner` - `ID!`

Example

Query

mutation subgraphAddOwner(
  $branchId: ID!,
  $subgraphName: String!,
  $owner: ID!
) {
  subgraphAddOwner(
    branchId: $branchId,
    subgraphName: $subgraphName,
    owner: $owner
  ) {
    ... on SubgraphAddOwnerSuccess {
      ...SubgraphAddOwnerSuccessFragment
    }
  }
}

Variables

{
  "branchId": 4,
  "subgraphName": "abc123",
  "owner": 4
}

Response

{"data": {"subgraphAddOwner": SubgraphAddOwnerSuccess}}

Mutations

`subgraphRemoveOwner`

Description

Unassign a team's ownership of a subgraph

Response

Returns a SubgraphRemoveOwnerPayload!

Arguments

Name	Description
`branchId` - `ID!`
`subgraphName` - `String!`

Example

Query

mutation subgraphRemoveOwner(
  $branchId: ID!,
  $subgraphName: String!
) {
  subgraphRemoveOwner(
    branchId: $branchId,
    subgraphName: $subgraphName
  ) {
    ... on SubgraphRemoveOwnerSuccess {
      ...SubgraphRemoveOwnerSuccessFragment
    }
  }
}

Variables

{
  "branchId": "4",
  "subgraphName": "xyz789"
}

Response

{
  "data": {
    "subgraphRemoveOwner": SubgraphRemoveOwnerSuccess
  }
}

Mutations

`teamAddMember`

Response

Returns a TeamAddMemberPayload!

Arguments

Name	Description
`teamId` - `ID!`
`memberId` - `ID!`

Example

Query

mutation teamAddMember(
  $teamId: ID!,
  $memberId: ID!
) {
  teamAddMember(
    teamId: $teamId,
    memberId: $memberId
  ) {
    ... on TeamAddMemberSuccess {
      ...TeamAddMemberSuccessFragment
    }
    ... on TeamDoesNotExistError {
      ...TeamDoesNotExistErrorFragment
    }
  }
}

Variables

{"teamId": 4, "memberId": 4}

Response

{"data": {"teamAddMember": TeamAddMemberSuccess}}

Mutations

`teamAssignRole`

Response

Returns a TeamAssignRolePayload!

Arguments

Name	Description
`role` - `TeamRole!`
`teamId` - `ID!`
`memberId` - `ID!`

Example

Query

mutation teamAssignRole(
  $role: TeamRole!,
  $teamId: ID!,
  $memberId: ID!
) {
  teamAssignRole(
    role: $role,
    teamId: $teamId,
    memberId: $memberId
  ) {
    ... on TeamAssignRoleSuccess {
      ...TeamAssignRoleSuccessFragment
    }
    ... on TeamDoesNotExistError {
      ...TeamDoesNotExistErrorFragment
    }
  }
}

Variables

{
  "role": "MEMBER",
  "teamId": "4",
  "memberId": 4
}

Response

{"data": {"teamAssignRole": TeamAssignRoleSuccess}}

Mutations

`teamCreate`

Response

Returns a TeamCreatePayload!

Arguments

Name	Description
`name` - `String!`
`organizationId` - `ID!`

Example

Query

mutation teamCreate(
  $name: String!,
  $organizationId: ID!
) {
  teamCreate(
    name: $name,
    organizationId: $organizationId
  ) {
    ... on OrganizationDoesNotExistError {
      ...OrganizationDoesNotExistErrorFragment
    }
    ... on Team {
      ...TeamFragment
    }
    ... on TeamNameAlreadyTakenError {
      ...TeamNameAlreadyTakenErrorFragment
    }
  }
}

Variables

{
  "name": "abc123",
  "organizationId": "4"
}

Response

{"data": {"teamCreate": OrganizationDoesNotExistError}}

Mutations

`teamDelete`

Response

Returns a TeamDeletePayload!

Arguments

Name	Description
`teamId` - `ID!`

Example

Query

mutation teamDelete($teamId: ID!) {
  teamDelete(teamId: $teamId) {
    ... on TeamDeleteSuccess {
      ...TeamDeleteSuccessFragment
    }
    ... on TeamDoesNotExistError {
      ...TeamDoesNotExistErrorFragment
    }
  }
}

Variables

{"teamId": 4}

Response

{"data": {"teamDelete": TeamDeleteSuccess}}

Mutations

`teamRemoveMember`

Response

Returns a TeamRemoveMemberPayload!

Arguments

Name	Description
`teamId` - `ID!`
`memberId` - `ID!`

Example

Query

mutation teamRemoveMember(
  $teamId: ID!,
  $memberId: ID!
) {
  teamRemoveMember(
    teamId: $teamId,
    memberId: $memberId
  ) {
    ... on TeamDoesNotExistError {
      ...TeamDoesNotExistErrorFragment
    }
    ... on TeamRemoveMemberSuccess {
      ...TeamRemoveMemberSuccessFragment
    }
  }
}

Variables

{"teamId": "4", "memberId": 4}

Response

{"data": {"teamRemoveMember": TeamDoesNotExistError}}

Mutations

`trustedDocumentsSubmit`

Response

Returns a TrustedDocumentsSubmitPayload!

Arguments

Name	Description
`accountSlug` - `String`
`graphSlug` - `String`
`branchSlug` - `String!`
`clientName` - `String!`
`documents` - `[TrustedDocumentInput!]!`

Example

Query

mutation trustedDocumentsSubmit(
  $accountSlug: String,
  $graphSlug: String,
  $branchSlug: String!,
  $clientName: String!,
  $documents: [TrustedDocumentInput!]!
) {
  trustedDocumentsSubmit(
    accountSlug: $accountSlug,
    graphSlug: $graphSlug,
    branchSlug: $branchSlug,
    clientName: $clientName,
    documents: $documents
  ) {
    ... on GraphDoesNotExistError {
      ...GraphDoesNotExistErrorFragment
    }
    ... on OldAccessTokenError {
      ...OldAccessTokenErrorFragment
    }
    ... on ReusedIds {
      ...ReusedIdsFragment
    }
    ... on TrustedDocumentsSubmitSuccess {
      ...TrustedDocumentsSubmitSuccessFragment
    }
  }
}

Variables

{
  "accountSlug": "xyz789",
  "graphSlug": "xyz789",
  "branchSlug": "xyz789",
  "clientName": "xyz789",
  "documents": [TrustedDocumentInput]
}

Response

{
  "data": {
    "trustedDocumentsSubmit": GraphDoesNotExistError
  }
}

Mutations

`userDelete`

Description

Delete the user.

Response

Returns a UserDeletePayload!

Example

Query

mutation userDelete {
  userDelete {
    ... on OrganizationOwnershipNotTransferredError {
      ...OrganizationOwnershipNotTransferredErrorFragment
    }
    ... on UserDeleteSuccess {
      ...UserDeleteSuccessFragment
    }
  }
}

Response

{
  "data": {
    "userDelete": OrganizationOwnershipNotTransferredError
  }
}

Mutations

`userUpdate`

Response

Returns a UserUpdatePayload!

Arguments

Name	Description
`input` - `UserUpdateInput!`

Example

Query

mutation userUpdate($input: UserUpdateInput!) {
  userUpdate(input: $input) {
    ... on NameSizeCheckError {
      ...NameSizeCheckErrorFragment
    }
    ... on UserUpdateSuccess {
      ...UserUpdateSuccessFragment
    }
  }
}

Variables

{"input": UserUpdateInput}

Response

{"data": {"userUpdate": NameSizeCheckError}}

Mutations

`zitadelAddRedirect`

Response

Returns a ZitadelAddRedirectPayload

Example

Query

mutation zitadelAddRedirect {
  zitadelAddRedirect {
    ... on NotEnterprisePlatformError {
      ...NotEnterprisePlatformErrorFragment
    }
    ... on ZitadelAddRedirectFailure {
      ...ZitadelAddRedirectFailureFragment
    }
    ... on ZitadelAddRedirectSuccess {
      ...ZitadelAddRedirectSuccessFragment
    }
  }
}

Response

{
  "data": {
    "zitadelAddRedirect": NotEnterprisePlatformError
  }
}

Mutations

`zitadelInit`

Response

Returns a ZitadelInitPayload

Example

Query

mutation zitadelInit {
  zitadelInit {
    ... on NotEnterprisePlatformError {
      ...NotEnterprisePlatformErrorFragment
    }
    ... on ZitadelInitFailure {
      ...ZitadelInitFailureFragment
    }
    ... on ZitadelInitSuccess {
      ...ZitadelInitSuccessFragment
    }
  }
}

Response

{"data": {"zitadelInit": NotEnterprisePlatformError}}

Subscriptions

`notificationsInboxMessages`

Description

Whenever new notifications are available for the current user, return how many.

Response

Returns an Int!

Example

Query

subscription notificationsInboxMessages {
  notificationsInboxMessages
}

Response

{"data": {"notificationsInboxMessages": 123}}

Types

AccessToken

Fields

Field Name	Description
`accountId` - `ID`
`createdAt` - `DateTime!`
`expiresAt` - `DateTime`
`graphScopes` - `[Graph!]!`
`id` - `ID!`
`name` - `String!`

Example

{
  "accountId": "4",
  "createdAt": "2007-12-03T10:15:30Z",
  "expiresAt": "2007-12-03T10:15:30Z",
  "graphScopes": [Graph],
  "id": 4,
  "name": "abc123"
}

Types

AccessTokenConnection

Fields

Field Name	Description
`edges` - `[AccessTokenEdge!]!`	A list of edges.
`nodes` - `[AccessToken!]!`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.

Example

{
  "edges": [AccessTokenEdge],
  "nodes": [AccessToken],
  "pageInfo": PageInfo
}

Types

AccessTokenCreateInput

Fields

Input Field	Description
`name` - `String!`
`accountId` - `ID`
`graphScopes` - `[ID!]`
`expiresAt` - `DateTime`
`kind` - `AccessTokenKind!`

Example

{
  "name": "xyz789",
  "accountId": 4,
  "graphScopes": [4],
  "expiresAt": "2007-12-03T10:15:30Z",
  "kind": "USER"
}

Types

AccessTokenCreatePayload

Types

Union Types
`AccessTokenCreateSuccess`
`AccountIdMissingForAccountAccessTokenError`
`CouldNotFindGraphsError`
`GraphScopeLimitExceededError`
`InvalidAccountError`
`TokenLimitExceededError`
`UserAccessTokensCannotBeScopedToAGraphError`

Example

AccessTokenCreateSuccess

Types

AccessTokenCreateSuccess

Fields

Field Name	Description
`jwt` - `String!`
`query` - `Query!`
`token` - `AccessToken!`

Example

{
  "jwt": "abc123",
  "query": Query,
  "token": AccessToken
}

Types

AccessTokenDeleteInput

Fields

Input Field	Description
`id` - `ID!`

Example

{"id": "4"}

Types

AccessTokenDeletePayload

Types

Union Types
`AccessTokenDeleteSuccess`
`TokenDoesNotExistError`

Example

AccessTokenDeleteSuccess

Types

AccessTokenDeleteSuccess

Fields

Field Name	Description
`deletedId` - `ID!`
`query` - `Query!`

Example

{
  "deletedId": "4",
  "query": Query
}

Types

AccessTokenEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination
`node` - `AccessToken!`	The item at the end of the edge

Example

{
  "cursor": "xyz789",
  "node": AccessToken
}

Types

AccessTokenKind

Values

Enum Value	Description
`USER`
`ACCOUNT`

Example

"USER"

Types

Account

Fields

Field Name	Description
`accessTokens` - `AccessTokenConnection!`
Arguments `after` - `String` `before` - `String` `first` - `Int` `last` - `Int`
`createdAt` - `DateTime!`
`graphs` - `GraphConnection!`
Arguments `after` - `String` `before` - `String` `first` - `Int` `last` - `Int`
`id` - `ID!`
`name` - `String!`
`plan` - `GrafbasePlan!`
`slug` - `String!`
`status` - `AccountStatus!`
`usage` - `AccountUsageTimeSeries`
Arguments `filters` - `UsageFilters!`

Possible Types

Account Types
`Organization`

Example

{
  "accessTokens": AccessTokenConnection,
  "createdAt": "2007-12-03T10:15:30Z",
  "graphs": GraphConnection,
  "id": 4,
  "name": "xyz789",
  "plan": "TRIAL",
  "slug": "xyz789",
  "status": AccountStatus,
  "usage": AccountUsageTimeSeries
}

Types

AccountCreationValidateInput

Fields

Input Field	Description
`slug` - `String!`

Example

{"slug": "abc123"}

Types

AccountCreationValidatePayload

Fields

Field Name	Description
`slugAvailable` - `Boolean!`

Example

{"slugAvailable": false}

Types

AccountDoesNotExistError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

AccountIdMissingForAccountAccessTokenError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

AccountStatus

Fields

Field Name	Description
`isEnabled` - `Boolean!`

Example

{"isEnabled": true}

Types

AccountUsageTimeSeries

Fields

Field Name	Description
`overall` - `UsageMetrics!`
`points` - `[UsageMetricsTimeSeriesDataPoint!]!`

Example

{
  "overall": UsageMetrics,
  "points": [UsageMetricsTimeSeriesDataPoint]
}

Types

AlreadyExistsError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

AlreadyMemberError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

AuditLogDirectDownloadSuccess

Fields

Field Name	Description
`url` - `Url!`

Example

{"url": Url}

Types

AuditLogDirectDownloadUrlPayload

Types

Union Types
`AuditLogDirectDownloadSuccess`
`NotAllowedError`
`OrganizationDoesNotExistError`

Example

AuditLogDirectDownloadSuccess

Types

BadWasmModuleError

Fields

Field Name	Description
`error` - `String!`
`query` - `Query!`

Example

{
  "error": "xyz789",
  "query": Query
}

Types

Boolean

Example

true

Types

Branch

Fields

Field Name	Description
`activeDeployment` - `Deployment`
`analytics` - `GraphAnalytics`
Arguments `filters` - `GraphAnalyticsFilters!`
`deployments` - `DeploymentConnection!`
Arguments `after` - `String` `before` - `String` `first` - `Int` `last` - `Int` `filters` - `DeploymentFilters`
`domains` - `[String!]!`
`endpointConfig` - `EndpointConfig`
`environment` - `BranchEnvironment!`
`federatedSchema` - `String`
`graph` - `Graph!`
`id` - `ID!`
`latestDeployment` - `Deployment`
`name` - `String!`
`operationChecksEnabled` - `Boolean!`
`operationChecksIgnoreUsageData` - `Boolean!`	Whether usage data should be ignored when running operation checks.
`operationChecksSchemaProposalApprovalEnabled` - `Boolean`	Allow breaking changes that are part of an approved schema proposal.
`schema` - `String`
`schemaProposals` - `SchemaProposalConnection!`
Arguments `after` - `String` `first` - `Int` `filter` - `SchemaProposalFilter!`
`schemaProposalsConfiguration` - `SchemaProposalsConfiguration!`
`subgraphs` - `[Subgraph!]!`

Example

{
  "activeDeployment": Deployment,
  "analytics": GraphAnalytics,
  "deployments": DeploymentConnection,
  "domains": ["abc123"],
  "endpointConfig": EndpointConfig,
  "environment": "PREVIEW",
  "federatedSchema": "xyz789",
  "graph": Graph,
  "id": 4,
  "latestDeployment": Deployment,
  "name": "xyz789",
  "operationChecksEnabled": true,
  "operationChecksIgnoreUsageData": true,
  "operationChecksSchemaProposalApprovalEnabled": true,
  "schema": "xyz789",
  "schemaProposals": SchemaProposalConnection,
  "schemaProposalsConfiguration": SchemaProposalsConfiguration,
  "subgraphs": [Subgraph]
}

Types

BranchAlreadyExistsError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

BranchConnection

Fields

Field Name	Description
`edges` - `[BranchEdge!]!`	A list of edges.
`nodes` - `[Branch!]!`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.

Example

{
  "edges": [BranchEdge],
  "nodes": [Branch],
  "pageInfo": PageInfo
}

Types

BranchCreateInput

Fields

Input Field	Description
`accountSlug` - `String!`
`graphSlug` - `String!`
`branchName` - `String!`

Example

{
  "accountSlug": "abc123",
  "graphSlug": "abc123",
  "branchName": "xyz789"
}

Types

BranchCreatePayload

Types

Union Types
`BranchAlreadyExistsError`
`GraphDoesNotExistError`
`GraphNotSelfHostedError`
`Query`

Example

BranchAlreadyExistsError

Types

BranchDeletePayload

Types

Union Types
`BranchDoesNotExistError`
`CannotDeleteProductionBranchError`
`Query`

Example

BranchDoesNotExistError

Types

BranchDoesNotExistError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

BranchEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination
`node` - `Branch!`	The item at the end of the edge

Example

{
  "cursor": "abc123",
  "node": Branch
}

Types

BranchEnvironment

Values

Enum Value	Description
`PREVIEW`
`PRODUCTION`

Example

"PREVIEW"

Types

BranchUpdateInput

Fields

Input Field	Description
`operationChecksEnabled` - `Boolean`	Toggle whether operation checks are run along with other schema checks.
`operationChecksIgnoreUsageData` - `Boolean`	When this is enabled, operation checks will not take usage data into account. Any change that is theoretically breaking (like making a required output field optional) will be considered breaking.
`operationChecksSchemaProposalApprovalEnabled` - `Boolean`	Allow breaking changes that are part of an approved schema proposal.
`schemaProposalsConfiguration` - `SchemaProposalsConfigurationUpdateInput`
`accountSlug` - `String!`
`graphSlug` - `String`
`branchSlug` - `String!`

Example

{
  "operationChecksEnabled": false,
  "operationChecksIgnoreUsageData": false,
  "operationChecksSchemaProposalApprovalEnabled": false,
  "schemaProposalsConfiguration": SchemaProposalsConfigurationUpdateInput,
  "accountSlug": "abc123",
  "graphSlug": "xyz789",
  "branchSlug": "abc123"
}

Types

BranchUpdatePayload

Types

Union Types
`GraphDoesNotExistError`
`Query`

Example

GraphDoesNotExistError

Types

CannotBeRenamedError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

CannotDeleteProductionBranchError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

CannotUseInvitationsWithSso

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

CompositionCheckError

Fields

Field Name	Description
`message` - `String!`
`severity` - `SchemaCheckErrorSeverity!`
`title` - `String!`

Example

{
  "message": "abc123",
  "severity": "ERROR",
  "title": "xyz789"
}

Types

CouldNotFindGraphsError

Fields

Field Name	Description
`unknownGraphIds` - `[ID!]!`

Example

{"unknownGraphIds": [4]}

Types

CurrentPlanLimitReachedError

Fields

Field Name	Description
`max` - `Int!`
`query` - `Query!`

Example

{"max": 123, "query": Query}

Types

CustomCheckWebhook

Fields

Field Name	Description
`createdAt` - `DateTime!`
`createdBy` - `User`
`headers` - `[HttpHeader!]!`	The headers sent to the webhook with custom check events.
`id` - `ID!`
`url` - `Url!`	The url called as part of custom checks.

Example

{
  "createdAt": "2007-12-03T10:15:30Z",
  "createdBy": User,
  "headers": [HttpHeader],
  "id": "4",
  "url": Url
}

Types

CustomCheckWebhookNotFoundError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

DateTime

Description

RFC3339 formatted date in the UTC time zone denoted by letter 'Z'

Example

"2007-12-03T10:15:30Z"

Types

DeleteSubgraphDeploymentFailure

Fields

Field Name	Description
`deploymentError` - `String!`
`query` - `Query!`

Example

{
  "deploymentError": "abc123",
  "query": Query
}

Types

DeleteSubgraphInput

Fields

Input Field	Description
`accountSlug` - `String!`
`graphSlug` - `String`
`message` - `String`
`branch` - `String!`
`subgraph` - `String!`
`dryRun` - `Boolean!`

Example

{
  "accountSlug": "xyz789",
  "graphSlug": "xyz789",
  "message": "xyz789",
  "branch": "xyz789",
  "subgraph": "abc123",
  "dryRun": true
}

Types

DeleteSubgraphPayload

Types

Union Types
`DeleteSubgraphDeploymentFailure`
`DeleteSubgraphSuccess`
`FederatedGraphCompositionError`
`GraphBranchDoesNotExistError`
`GraphDoesNotExistError`
`GraphNotFederatedError`
`SubgraphNotFoundError`

Example

DeleteSubgraphDeploymentFailure

Types

DeleteSubgraphSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

Deployment

Description

Deployment

Fields

Field Name	Description
`apiSchema` - `String`	The schema exposed by the gateway.
`apiSchemaDiff` - `[DiffSnippet!]`	Diff of the API SDL in this deployment with the last successful deployment. This field only makes sense for successful deployments, so it will be null on failed deployments.
`branch` - `Branch!`
`changeCounts` - `DeploymentChangeCounts`
`compositionInputs` - `[DeploymentSubgraph!]!`
`createdAt` - `DateTime!`
`duration` - `Int`	The duration of the deployment in milliseconds.
`federatedSdl` - `String`	The federated SDL used to initialize the gateway.
`finishedAt` - `DateTime`
`id` - `ID!`
`isRedeployable` - `Boolean!`
`message` - `String`
`schemaVersion` - `SchemaVersion`
`startedAt` - `DateTime`
`status` - `DeploymentStatus!`
`steps` - `[DeploymentStep!]!`
`subgraph` - `DeploymentSubgraph`	The subgraph that was published or removed, triggering the deployment. This is nullable in case we introduce back redeployments in the future.

Example

{
  "apiSchema": "abc123",
  "apiSchemaDiff": [DiffSnippet],
  "branch": Branch,
  "changeCounts": DeploymentChangeCounts,
  "compositionInputs": [DeploymentSubgraph],
  "createdAt": "2007-12-03T10:15:30Z",
  "duration": 123,
  "federatedSdl": "abc123",
  "finishedAt": "2007-12-03T10:15:30Z",
  "id": "4",
  "isRedeployable": true,
  "message": "xyz789",
  "schemaVersion": SchemaVersion,
  "startedAt": "2007-12-03T10:15:30Z",
  "status": "QUEUED",
  "steps": [DeploymentStep],
  "subgraph": DeploymentSubgraph
}

Types

DeploymentChangeCounts

Fields

Field Name	Description
`addedFields` - `Int!`
`addedTypes` - `Int!`
`changedFields` - `Int!`
`changedTypes` - `Int!`
`removedFields` - `Int!`
`removedTypes` - `Int!`

Example

{
  "addedFields": 987,
  "addedTypes": 123,
  "changedFields": 123,
  "changedTypes": 123,
  "removedFields": 123,
  "removedTypes": 987
}

Types

DeploymentConnection

Fields

Field Name	Description
`edges` - `[DeploymentEdge!]!`	A list of edges.
`nodes` - `[Deployment!]!`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.

Example

{
  "edges": [DeploymentEdge],
  "nodes": [Deployment],
  "pageInfo": PageInfo
}

Types

DeploymentEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination
`node` - `Deployment!`	The item at the end of the edge

Example

{
  "cursor": "abc123",
  "node": Deployment
}

Types

DeploymentFilters

Fields

Input Field	Description
`finishedAt` - `DeploymentFinishedAtFilters`

Example

{"finishedAt": DeploymentFinishedAtFilters}

Types

DeploymentFinishedAtFilters

Fields

Input Field	Description
`range` - `Duration`	Use this if you really care about having a specific duration like 1 hour, 7 days, etc.
`from` - `DateTime`	Use this if you at least the data between `from` and `to` to be provided. You may get more, but never less.
`to` - `DateTime!`	To be used in conjunction with with either `range` or `from`.

Example

{
  "range": "P3Y6M4DT12H30M5S",
  "from": "2007-12-03T10:15:30Z",
  "to": "2007-12-03T10:15:30Z"
}

Types

DeploymentStatus

Values

Enum Value	Description
`QUEUED`
`IN_PROGRESS`
`SUCCEEDED`
`FAILED`

Example

"QUEUED"

Types

DeploymentStep

Fields

Field Name	Description
`durationMs` - `Int!`
`errors` - `[DeploymentStepError!]!`
`startedAt` - `DateTime!`
`status` - `DeploymentStepStatus!`
`title` - `String!`

Example

{
  "durationMs": 987,
  "errors": [DeploymentStepGeneralError],
  "startedAt": "2007-12-03T10:15:30Z",
  "status": "SUCCESS",
  "title": "xyz789"
}

Types

DeploymentStepError

Types

Union Types
`DeploymentStepGeneralError`

Example

DeploymentStepGeneralError

Types

DeploymentStepGeneralError

Fields

Field Name	Description
`message` - `String!`

Example

{"message": "abc123"}

Types

DeploymentStepStatus

Values

Enum Value	Description
`SUCCESS`
`FAILURE`

Example

"SUCCESS"

Types

DeploymentSubgraph

Fields

Field Name	Description
`name` - `String!`
`url` - `String`
`versionNumber` - `Int!`

Example

{
  "name": "xyz789",
  "url": "abc123",
  "versionNumber": 987
}

Types

DiffSide

Description

One side of a two-sided diff. "Old" and "new" are to be taken in the most general sense.

Values

Enum Value	Description
`OLD`
`NEW`

Example

"OLD"

Types

DiffSnippet

Fields

Field Name	Description
`addedLines` - `[Int!]!`
`originalSchemaSnippet` - `String!`
`originalSchemaSnippetFirstLine` - `Int!`
`proposedSchemaSnippet` - `String!`
`proposedSchemaSnippetFirstLine` - `Int!`
`removedLines` - `[Int!]!`

Example

{
  "addedLines": [987],
  "originalSchemaSnippet": "abc123",
  "originalSchemaSnippetFirstLine": 123,
  "proposedSchemaSnippet": "abc123",
  "proposedSchemaSnippetFirstLine": 987,
  "removedLines": [123]
}

Types

DisabledAccountError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

Duration

Description

Implement the Duration scalar

The input/output is a string in ISO8601 format.

Example

"P3Y6M4DT12H30M5S"

Types

DurationFilter

Fields

Input Field	Description
`lt` - `Duration`
`lte` - `Duration`
`gt` - `Duration`
`gte` - `Duration`

Example

{
  "lt": "P3Y6M4DT12H30M5S",
  "lte": "P3Y6M4DT12H30M5S",
  "gt": "P3Y6M4DT12H30M5S",
  "gte": "P3Y6M4DT12H30M5S"
}

Types

EndpointConfig

Fields

Field Name	Description
`url` - `String!`

Example

{"url": "abc123"}

Types

EndpointConfigInput

Fields

Input Field	Description
`url` - `String!`

Example

{"url": "abc123"}

Types

EndpointConfigUpdateInput

Fields

Input Field	Description
`endpointConfig` - `EndpointConfigInput!`
`accountSlug` - `String!`
`graphSlug` - `String!`
`branchSlug` - `String!`

Example

{
  "endpointConfig": EndpointConfigInput,
  "accountSlug": "xyz789",
  "graphSlug": "xyz789",
  "branchSlug": "xyz789"
}

Types

EndpointConfigUpdatePayload

Types

Union Types
`GraphDoesNotExistError`
`Query`

Example

GraphDoesNotExistError

Types

ErrorCountByCode

Fields

Field Name	Description
`code` - `String!`
`count` - `Int!`

Example

{"code": "xyz789", "count": 123}

Types

Extension

Fields

Field Name	Description
`highestVersion` - `ExtensionVersion`
`id` - `ID!`
`name` - `String!`
`owners` - `[User!]`
`versions` - `[ExtensionVersion!]!`

Example

{
  "highestVersion": ExtensionVersion,
  "id": "4",
  "name": "xyz789",
  "owners": [User],
  "versions": [ExtensionVersion]
}

Types

ExtensionAddOwnerPayload

Types

Union Types
`ExtensionAddOwnerSuccess`
`ExtensionDoesNotExistError`
`ExtensionUnauthorized`

Example

ExtensionAddOwnerSuccess

Types

ExtensionAddOwnerSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

ExtensionConnection

Fields

Field Name	Description
`edges` - `[ExtensionEdge!]!`	A list of edges.
`nodes` - `[Extension!]!`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.

Example

{
  "edges": [ExtensionEdge],
  "nodes": [Extension],
  "pageInfo": PageInfo
}

Types

ExtensionDefaultPermission

Values

Enum Value	Description
`NETWORK`
`STDOUT`
`STDERR`
`ENVIRONMENT_VARIABLES`

Example

"NETWORK"

Types

ExtensionDoesNotExistError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

ExtensionEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination
`node` - `Extension!`	The item at the end of the edge

Example

{
  "cursor": "xyz789",
  "node": Extension
}

Types

ExtensionFilter

Fields

Input Field	Description
`namePrefix` - `String`

Example

{"namePrefix": "abc123"}

Types

ExtensionKind

Values

Enum Value	Description
`FIELD_RESOLVER`
`AUTHENTICATOR`	Replaced by AUTHENTICATION
`AUTHENTICATION`
`AUTHORIZATION`
`SELECTION_SET_RESOLVER`
`RESOLVER`
`HOOKS`
`CONTRACTS`

Example

"FIELD_RESOLVER"

Types

ExtensionPublishPayload

Types

Union Types
`BadWasmModuleError`
`ExtensionPublishSuccess`
`ExtensionUnauthorized`
`ExtensionValidationError`
`ExtensionVersionAlreadyExistsError`

Example

BadWasmModuleError

Types

ExtensionPublishSuccess

Fields

Field Name	Description
`extensionVersion` - `ExtensionVersion!`
`query` - `Query!`

Example

{
  "extensionVersion": ExtensionVersion,
  "query": Query
}

Types

ExtensionRemoveOwnerPayload

Types

Union Types
`ExtensionDoesNotExistError`
`ExtensionRemoveOwnerSuccess`
`ExtensionUnauthorized`

Example

ExtensionDoesNotExistError

Types

ExtensionRemoveOwnerSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

ExtensionUnauthorized

Fields

Field Name	Description
`message` - `String!`
`query` - `Query!`

Example

{
  "message": "xyz789",
  "query": Query
}

Types

ExtensionValidationError

Fields

Field Name	Description
`error` - `String!`
`query` - `Query!`

Example

{
  "error": "xyz789",
  "query": Query
}

Types

ExtensionVersion

Fields

Field Name	Description
`createdAt` - `DateTime!`
`defaultPermissions` - `[ExtensionDefaultPermission!]`
`definitionsSdl` - `String`
`description` - `String!`
`extension` - `Extension!`
`homepageUrl` - `Url`
`kind` - `ExtensionKind!`
`license` - `String`
`minimumCompatibleGatewayVersion` - `SemverVersion`
`publishedBy` - `User`
`readme` - `String`
`repositoryUrl` - `Url`
`sdkVersion` - `SemverVersion!`
`sdl` - `String`
`version` - `SemverVersion!`

Example

{
  "createdAt": "2007-12-03T10:15:30Z",
  "defaultPermissions": ["NETWORK"],
  "definitionsSdl": "abc123",
  "description": "xyz789",
  "extension": Extension,
  "homepageUrl": Url,
  "kind": "FIELD_RESOLVER",
  "license": "abc123",
  "minimumCompatibleGatewayVersion": SemverVersion,
  "publishedBy": User,
  "readme": "abc123",
  "repositoryUrl": Url,
  "sdkVersion": SemverVersion,
  "sdl": "abc123",
  "version": SemverVersion
}

Types

ExtensionVersionAlreadyExistsError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

ExtensionVersionDoesNotExistError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

ExtensionVersionMatch

Types

Union Types
`ExtensionDoesNotExistError`
`ExtensionVersion`
`ExtensionVersionDoesNotExistError`

Example

ExtensionDoesNotExistError

Types

ExtensionVersionRequirement

Fields

Input Field	Description
`version` - `SemverVersionRequirement!`
`extensionName` - `String!`

Example

{
  "version": SemverVersionRequirement,
  "extensionName": "xyz789"
}

Types

FederatedGraphCompositionError

Fields

Field Name	Description
`messages` - `[String!]!`
`query` - `Query!`

Example

{
  "messages": ["xyz789"],
  "query": Query
}

Types

FieldAnalytics

Fields

Field Name	Description
`metrics` - `FieldMetricsTimeSeries`
`topClients` - `TopClientsForField`
Arguments `limit` - `Int` Detaults to 10, Max 100 `searchQuery` - `String` Search over the client names/versions

Example

{
  "metrics": FieldMetricsTimeSeries,
  "topClients": TopClientsForField
}

Types

FieldMetrics

Fields

Field Name	Description
`count` - `Int!`

Example

{"count": 987}

Types

FieldMetricsTimeSeries

Fields

Field Name	Description
`overall` - `FieldMetrics!`
`points` - `[FieldMetricsTimeSeriesDataPoint!]!`
`previousPeriod` - `FieldMetricsTimeSeries`

Example

{
  "overall": FieldMetrics,
  "points": [FieldMetricsTimeSeriesDataPoint],
  "previousPeriod": FieldMetricsTimeSeries
}

Types

FieldMetricsTimeSeriesDataPoint

Fields

Field Name	Description
`count` - `Int!`
`dateTime` - `DateTime!`

Example

{
  "count": 987,
  "dateTime": "2007-12-03T10:15:30Z"
}

Types

Float

Example

987.65

Types

GrafbasePlan

Values

Enum Value	Description
`TRIAL`
`GROWTH`
`ENTERPRISE`

Example

"TRIAL"

Types

Graph

Fields

Field Name	Description
`account` - `Account!`
`analytics` - `GraphAnalytics`
Arguments `filters` - `GraphAnalyticsFilters!`
`branch` - `Branch`
Arguments `name` - `String`
`branches` - `BranchConnection!`
Arguments `after` - `String` `before` - `String` `first` - `Int` `last` - `Int`
`createdAt` - `DateTime!`
`customCheckWebhooks` - `[CustomCheckWebhook!]`	Webhooks for custom schema checks.
`id` - `ID!`
`operationChecksConfiguration` - `GraphOperationCheckConfiguration!`
`owners` - `[Team!]!`
`productionBranch` - `Branch!`
`request` - `Request`
Arguments `branchName` - `String` `approximateTimestamp` - `DateTime!` The approximate timestamp of the request, within a few minutes of the actual request. `traceId` - `ID!`
`requests` - `RequestConnection`
Arguments `after` - `String` `before` - `String` `first` - `Int` `last` - `Int` `filters` - `RequestFilters!`
`schemaChecks` - `SchemaCheckConnection!`
Arguments `after` - `String` `before` - `String` `first` - `Int` `last` - `Int` `branch` - `String`
`schemaProposals` - `SchemaProposalConnection!`
Arguments `after` - `String` `first` - `Int`
`slug` - `String!`

Example

{
  "account": Account,
  "analytics": GraphAnalytics,
  "branch": Branch,
  "branches": BranchConnection,
  "createdAt": "2007-12-03T10:15:30Z",
  "customCheckWebhooks": [CustomCheckWebhook],
  "id": "4",
  "operationChecksConfiguration": GraphOperationCheckConfiguration,
  "owners": [Team],
  "productionBranch": Branch,
  "request": Request,
  "requests": RequestConnection,
  "schemaChecks": SchemaCheckConnection,
  "schemaProposals": SchemaProposalConnection,
  "slug": "abc123"
}

Types

GraphAddOwnerPayload

Types

Union Types
`GraphAddOwnerSuccess`
`GraphDoesNotExistError`
`NotAllowedError`

Example

GraphAddOwnerSuccess

Types

GraphAddOwnerSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

GraphAnalytics

Fields

Field Name	Description
`forField` - `FieldAnalytics!`
Arguments `schemaPath` - `String!` Schema path defined as: '.'
`requestMetrics` - `RequestMetricsTimeSeriesV2`
Arguments `latencyPercentiles` - `[Float!]` Latency percentiles to retrieve. Ex: [50, 99, 99.9]
`topClients` - `TopClients`
Arguments `limit` - `Int` Detaults to 10, Max 100 `searchQuery` - `String` Search over the client names/versions `latencyPercentile` - `Float` If not specified, top clients by latency will be empty. Ex: 95
`topOperations` - `TopOperations`
Arguments `limit` - `Int` Detaults to 10, Max 100 `searchQuery` - `String` Search over the opeartion names `latencyPercentile` - `Float` If not specified, top operations by latency will be empty. Ex: 95

Example

{
  "forField": FieldAnalytics,
  "requestMetrics": RequestMetricsTimeSeriesV2,
  "topClients": TopClients,
  "topOperations": TopOperations
}

Types

GraphAnalyticsFilters

Fields

Input Field	Description
`branchName` - `String`	Defaults to production branch
`range` - `Duration`	Use this if you really care about having a specific duration like 1 hour, 7 days, etc.
`from` - `DateTime`	Use this if you at least the data between `from` and `to` to be provided. You may get more, but never less.
`to` - `DateTime!`	To be used in conjunction with with either `range` or `from`.
`isCustomRange` - `Boolean`	If explicitly to false, specifying both `from` and `to` will be treated as if `range: (to - from)` had been specified instead. Meaning only the duration between `from` and `to` matters, not necessarily having a data point for `from` itself.
`aggregationStep` - `Duration`	If specified, overrides approximateNumberOfPoints. Must be in whole minutes. At most 150 points can be returned.
`approximateNumberOfDataPoints` - `Int`	Defaults to 100, at most 150 points can be returned.
`alignPeriodWithAggregationStep` - `Boolean`	Defaults to true Example: for an aggregationStep of 15 min: if true, only times with 00, 15, 30 and 45 minutes will appear in the time series if false, times in the time series will be adjusted to start from the periodStart (~from). So if from = 15:32:00, times will end in 02, 17, 32 and 47. I'll always align to the aggregation step used to store the data though, which is currently in minutes. So cannot have 15:10:20, 15:11:20, etc.
`operationName` - `[String!]`
`operationNormalizedQueryHash` - `[OperationNormalizedQueryHash!]`	Only used if operation name is specified.
`clientName` - `[String!]`
`clientVersion` - `[String!]`	Only used if client name is specified.

Example

{
  "branchName": "xyz789",
  "range": "P3Y6M4DT12H30M5S",
  "from": "2007-12-03T10:15:30Z",
  "to": "2007-12-03T10:15:30Z",
  "isCustomRange": false,
  "aggregationStep": "P3Y6M4DT12H30M5S",
  "approximateNumberOfDataPoints": 987,
  "alignPeriodWithAggregationStep": true,
  "operationName": ["abc123"],
  "operationNormalizedQueryHash": [
    OperationNormalizedQueryHash
  ],
  "clientName": ["xyz789"],
  "clientVersion": ["abc123"]
}

Types

GraphBranchDoesNotExistError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

GraphConnection

Fields

Field Name	Description
`edges` - `[GraphEdge!]!`	A list of edges.
`nodes` - `[Graph!]!`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.

Example

{
  "edges": [GraphEdge],
  "nodes": [Graph],
  "pageInfo": PageInfo
}

Types

GraphCreateInput

Fields

Input Field	Description
`accountId` - `ID!`
`graphSlug` - `String!`

Example

{"accountId": 4, "graphSlug": "abc123"}

Types

GraphCreatePayload

Types

Union Types
`AccountDoesNotExistError`
`CurrentPlanLimitReachedError`
`DisabledAccountError`
`GraphCreateSuccess`
`ManagedGraphsNoLongerSupportedError`
`SlugAlreadyExistsError`
`SlugInvalidError`
`SlugTooLongError`
`StandaloneGraphsNoLongerSupportedError`

Example

AccountDoesNotExistError

Types

GraphCreateSuccess

Fields

Field Name	Description
`graph` - `Graph!`
`query` - `Query!`

Example

{"graph": Graph, "query": Query}

Types

GraphDeleteInput

Fields

Input Field	Description
`id` - `ID!`

Example

{"id": 4}

Types

GraphDeletePayload

Types

Union Types
`GraphDeleteSuccess`
`GraphDoesNotExistError`
`NotAllowedError`

Example

GraphDeleteSuccess

Types

GraphDeleteSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

GraphDoesNotExistError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

GraphEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination
`node` - `Graph!`	The item at the end of the edge

Example

{
  "cursor": "xyz789",
  "node": Graph
}

Types

GraphNotFederatedError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

GraphNotSelfHostedError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

GraphOperationCheckConfiguration

Fields

Field Name	Description
`excludedClients` - `[String!]!`	The clients to exclude from operation checks.
`excludedOperations` - `[String!]!`	The operations to exclude from operation checks.
`requestCountThreshold` - `Int!`	The request count threshold to consider for operation checks. Operations that have been registered less than the specified number of occurrences are ignored.
`timeRangeDays` - `Int!`	The time range in days to consider for operation checks. Operations older than the specificied number of days are ignored.

Example

{
  "excludedClients": ["abc123"],
  "excludedOperations": ["abc123"],
  "requestCountThreshold": 123,
  "timeRangeDays": 987
}

Types

GraphOperationCheckConfigurationInput

Fields

Input Field	Description
`timeRangeDays` - `Int`	The time range in days to consider for operation checks. Operations older than the specificied number of days are ignored.
`requestCountThreshold` - `Int`	The request count threshold to consider for operation checks. Operations that have been registered less than the specified number of occurrences are ignored.
`excludedClients` - `[String!]`	The clients to exclude from operation checks.
`excludedOperations` - `[String!]`	The operations to exclude from operation checks.
`graphId` - `ID!`	The graph to update.
`enabled` - `Boolean`	Whether operation checks are enabled for the graph. This is ignored, since operation checks are now only enabled at the branch level.

Example

{
  "timeRangeDays": 987,
  "requestCountThreshold": 123,
  "excludedClients": ["xyz789"],
  "excludedOperations": ["abc123"],
  "graphId": 4,
  "enabled": false
}

Types

GraphOperationCheckConfigurationUpdatePayload

Types

Union Types
`GraphDoesNotExistError`
`GraphOperationCheckConfiguration`
`NotAllowedError`

Example

GraphDoesNotExistError

Types

GraphRemoveOwnerPayload

Types

Union Types
`GraphDoesNotExistError`
`GraphRemoveOwnerSuccess`
`NotAllowedError`

Example

GraphDoesNotExistError

Types

GraphRemoveOwnerSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

GraphScopeLimitExceededError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

GraphUpdateInput

Fields

Input Field	Description
`id` - `ID!`
`graphSlug` - `String`
`productionBranch` - `String`

Example

{
  "id": "4",
  "graphSlug": "xyz789",
  "productionBranch": "abc123"
}

Types

GraphUpdatePayload

Types

Union Types
`CannotBeRenamedError`
`GraphDoesNotExistError`
`GraphUpdateSuccess`
`NotAllowedError`
`SlugAlreadyExistsError`
`SlugInvalidError`
`SlugTooLongError`

Example

CannotBeRenamedError

Types

GraphUpdateSuccess

Fields

Field Name	Description
`graph` - `Graph!`
`query` - `Query!`

Example

{"graph": Graph, "query": Query}

Types

HttpHeader

Fields

Field Name	Description
`name` - `String!`
`value` - `String!`

Example

{
  "name": "abc123",
  "value": "abc123"
}

Types

HttpHeaderInput

Fields

Input Field	Description
`name` - `String!`
`value` - `String!`

Example

{
  "name": "abc123",
  "value": "xyz789"
}

Types

ID

Example

Types

InboxMessage

Fields

Field Name	Description
`createdAt` - `DateTime!`
`id` - `ID!`
`readAt` - `DateTime`

Possible Types

InboxMessage Types
`SchemaProposalReviewNotification`
`SchemaProposalReviewRequestNotification`
`SchemaProposalStatusChangeNotification`

Example

{
  "createdAt": "2007-12-03T10:15:30Z",
  "id": "4",
  "readAt": "2007-12-03T10:15:30Z"
}

Types

Int

Example

Types

InvalidAccountError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

InvalidEmailAddressError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

Invite

Fields

Field Name	Description
`createdAt` - `DateTime!`
`email` - `String!`
`id` - `ID!`
`invitedBy` - `User!`
`lastRenewedAt` - `DateTime!`
`organization` - `Organization!`
`role` - `MemberRole!`
`status` - `InviteStatus!`

Example

{
  "createdAt": "2007-12-03T10:15:30Z",
  "email": "abc123",
  "id": "4",
  "invitedBy": User,
  "lastRenewedAt": "2007-12-03T10:15:30Z",
  "organization": Organization,
  "role": "OWNER",
  "status": "PENDING"
}

Types

InviteAcceptInput

Fields

Input Field	Description
`id` - `ID!`

Example

{"id": "4"}

Types

InviteAcceptPayload

Types

Union Types
`AlreadyMemberError`
`CannotUseInvitationsWithSso`
`InviteAcceptSuccess`
`InviteDoesNotExistError`

Example

AlreadyMemberError

Types

InviteAcceptSuccess

Fields

Field Name	Description
`member` - `Member!`
`query` - `Query!`

Example

{"member": Member, "query": Query}

Types

InviteCancelInput

Fields

Input Field	Description
`id` - `ID!`

Example

{"id": 4}

Types

InviteCancelPayload

Types

Union Types
`InviteCancelSuccess`
`InviteDoesNotExistError`
`NotAllowedToCancelInvitesError`

Example

InviteCancelSuccess

Types

InviteCancelSuccess

Fields

Field Name	Description
`inviteId` - `ID!`
`query` - `Query!`

Example

{
  "inviteId": "4",
  "query": Query
}

Types

InviteConnection

Fields

Field Name	Description
`edges` - `[InviteEdge!]!`	A list of edges.
`nodes` - `[Invite!]!`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.

Example

{
  "edges": [InviteEdge],
  "nodes": [Invite],
  "pageInfo": PageInfo
}

Types

InviteDeclineInput

Fields

Input Field	Description
`id` - `ID!`

Example

{"id": "4"}

Types

InviteDeclinePayload

Types

Union Types
`InviteDeclineSuccess`
`InviteDoesNotExistError`

Example

InviteDeclineSuccess

Types

InviteDeclineSuccess

Fields

Field Name	Description
`inviteId` - `ID!`
`query` - `Query!`

Example

{
  "inviteId": "4",
  "query": Query
}

Types

InviteDoesNotExistError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

InviteEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination
`node` - `Invite!`	The item at the end of the edge

Example

{
  "cursor": "abc123",
  "node": Invite
}

Types

InviteSendInput

Fields

Input Field	Description
`role` - `MemberRole!`
`email` - `String!`
`organizationId` - `ID!`

Example

{
  "role": "OWNER",
  "email": "abc123",
  "organizationId": "4"
}

Types

InviteSendPayload

Types

Union Types
`CannotUseInvitationsWithSso`
`InvalidEmailAddressError`
`InviteSendSuccess`
`NotAllowedToSendInvitesError`
`OrganizationDoesNotExistError`

Example

CannotUseInvitationsWithSso

Types

InviteSendSuccess

Fields

Field Name	Description
`invite` - `Invite!`
`query` - `Query!`

Example

{"invite": Invite, "query": Query}

Types

InviteStatus

Values

Enum Value	Description
`PENDING`
`EXPIRED`

Example

"PENDING"

Types

JSON

Description

A scalar that can represent any JSON value.

Example

{}

Types

LintCheckError

Fields

Field Name	Description
`message` - `String!`
`severity` - `SchemaCheckErrorSeverity!`
`title` - `String!`

Example

{
  "message": "xyz789",
  "severity": "ERROR",
  "title": "xyz789"
}

Types

ManagedGraphsNoLongerSupportedError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

Member

Fields

Field Name	Description
`account` - `Account!`
`createdAt` - `DateTime!`
`id` - `ID!`
`role` - `MemberRole!`
`user` - `User!`

Example

{
  "account": Account,
  "createdAt": "2007-12-03T10:15:30Z",
  "id": "4",
  "role": "OWNER",
  "user": User
}

Types

MemberConnection

Fields

Field Name	Description
`edges` - `[MemberEdge!]!`	A list of edges.
`nodes` - `[Member!]!`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.

Example

{
  "edges": [MemberEdge],
  "nodes": [Member],
  "pageInfo": PageInfo
}

Types

MemberDeleteInput

Fields

Input Field	Description
`id` - `ID!`

Example

{"id": 4}

Types

MemberDeletePayload

Fields

Field Name	Description
`deletedMemberId` - `ID!`
`query` - `Query!`

Example

{
  "deletedMemberId": "4",
  "query": Query
}

Types

MemberEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination
`node` - `Member!`	The item at the end of the edge

Example

{
  "cursor": "xyz789",
  "node": Member
}

Types

MemberRole

Values

Enum Value	Description
`OWNER`
`MEMBER`
`ADMIN`

Example

"OWNER"

Types

MemberUpdateInput

Fields

Input Field	Description
`id` - `ID!`
`role` - `MemberRole`

Example

{"id": 4, "role": "OWNER"}

Types

MemberUpdatePayload

Fields

Field Name	Description
`member` - `Member!`
`query` - `Query!`

Example

{"member": Member, "query": Query}

Types

NameSizeCheckError

Fields

Field Name	Description
`maxLength` - `Int!`
`message` - `String!`
`query` - `Query!`

Example

{
  "maxLength": 123,
  "message": "abc123",
  "query": Query
}

Types

Node

Fields

Field Name	Description
`id` - `ID!`

Possible Types

Node Types
`AccessToken`
`Branch`
`Deployment`
`Extension`
`Graph`
`Invite`
`Member`
`Operation`
`Organization`
`Request`
`Team`
`User`

Example

{"id": "4"}

Types

NotAllowedError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

NotAllowedToCancelInvitesError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

NotAllowedToDeleteOrganizationError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

NotAllowedToSendInvitesError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

NotAllowedToSlugUpdateError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

NotAllowedToUpdateOrganizationError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

NotEnterprisePlatformError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

NotificationsInbox

Fields

Field Name	Description
`messages` - `[InboxMessage!]!`

Example

{"messages": [InboxMessage]}

Types

NotificationsMarkAsReadPayload

Types

Union Types
`NotificationsMarkAsReadSuccess`

Example

NotificationsMarkAsReadSuccess

Types

NotificationsMarkAsReadSuccess

Fields

Field Name	Description
`query` - `Query!`
`updated` - `Int!`	How many notifications were marked as read.

Example

{"query": Query, "updated": 987}

Types

OldAccessTokenError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

Operation

Fields

Field Name	Description
`id` - `ID!`
`name` - `String`
`normalizedQuery` - `String!`
`type` - `OperationType!`

Example

{
  "id": "4",
  "name": "abc123",
  "normalizedQuery": "xyz789",
  "type": "QUERY"
}

Types

OperationCheckError

Fields

Field Name	Description
`message` - `String!`
`severity` - `SchemaCheckErrorSeverity!`
`title` - `String!`

Example

{
  "message": "xyz789",
  "severity": "ERROR",
  "title": "abc123"
}

Types

OperationNormalizedQueryHash

Example

OperationNormalizedQueryHash

Types

OperationType

Values

Enum Value	Description
`QUERY`
`MUTATION`
`SUBSCRIPTION`

Example

"QUERY"

Types

Organization

Fields

Field Name	Description
`accessTokens` - `AccessTokenConnection!`
Arguments `after` - `String` `before` - `String` `first` - `Int` `last` - `Int`
`addToSlackLink` - `String!`	The url for the UI button to install the Grafbase slack app. It is important to use this link and keep it private, since it contains the signed account id of the authenticated user.
`createdAt` - `DateTime!`
`graphs` - `GraphConnection!`
Arguments `after` - `String` `before` - `String` `first` - `Int` `last` - `Int`
`id` - `ID!`
`invites` - `InviteConnection!`
Arguments `after` - `String` `before` - `String` `first` - `Int` `last` - `Int`
`members` - `MemberConnection!`
Arguments `after` - `String` `before` - `String` `first` - `Int` `last` - `Int`
`name` - `String!`
`oidcGroupName` - `String`	The group name that maps to this organization in the configured OIDC identity provider.
`oidcIssuer` - `String`	The OIDC identity provider (`iss` / issuer) to take into account when automatically provisioning organization memberships based on the `groups` claim.
`plan` - `GrafbasePlan!`
`samlDomain` - `String`
`slackIntegration` - `SlackIntegration`
`slug` - `String!`
`status` - `AccountStatus!`
`teams` - `TeamConnection!`
Arguments `after` - `String` `first` - `Int`
`trialExpiresAt` - `DateTime`
`usage` - `AccountUsageTimeSeries`
Arguments `filters` - `UsageFilters!`

Example

{
  "accessTokens": AccessTokenConnection,
  "addToSlackLink": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "graphs": GraphConnection,
  "id": 4,
  "invites": InviteConnection,
  "members": MemberConnection,
  "name": "abc123",
  "oidcGroupName": "xyz789",
  "oidcIssuer": "xyz789",
  "plan": "TRIAL",
  "samlDomain": "xyz789",
  "slackIntegration": SlackIntegration,
  "slug": "abc123",
  "status": AccountStatus,
  "teams": TeamConnection,
  "trialExpiresAt": "2007-12-03T10:15:30Z",
  "usage": AccountUsageTimeSeries
}

Types

OrganizationConnection

Fields

Field Name	Description
`edges` - `[OrganizationEdge!]!`	A list of edges.
`nodes` - `[Organization!]!`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.

Example

{
  "edges": [OrganizationEdge],
  "nodes": [Organization],
  "pageInfo": PageInfo
}

Types

OrganizationCreateInput

Fields

Input Field	Description
`name` - `String!`
`slug` - `String!`
`email` - `String`

Example

{
  "name": "xyz789",
  "slug": "abc123",
  "email": "abc123"
}

Types

OrganizationCreatePayload

Types

Union Types
`NameSizeCheckError`
`OrganizationCreateSuccess`
`ReservedSlugsCheckError`
`SlugAlreadyExistsError`
`SlugError`
`SlugSizeCheckError`
`TrialPlanUnavailableError`

Example

NameSizeCheckError

Types

OrganizationCreateSuccess

Fields

Field Name	Description
`member` - `Member!`
`organization` - `Organization!`
`query` - `Query!`

Example

{
  "member": Member,
  "organization": Organization,
  "query": Query
}

Types

OrganizationDeleteInput

Fields

Input Field	Description
`id` - `ID!`

Example

{"id": 4}

Types

OrganizationDeletePayload

Types

Union Types
`NotAllowedToDeleteOrganizationError`
`OrganizationDeleteSuccess`
`OrganizationDoesNotExistError`

Example

NotAllowedToDeleteOrganizationError

Types

OrganizationDeleteSuccess

Fields

Field Name	Description
`deletedId` - `ID!`
`query` - `Query!`

Example

{"deletedId": 4, "query": Query}

Types

OrganizationDoesNotExistError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

OrganizationEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination
`node` - `Organization!`	The item at the end of the edge

Example

{
  "cursor": "abc123",
  "node": Organization
}

Types

OrganizationOwnershipNotTransferredError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

OrganizationSlugUpdateInput

Fields

Input Field	Description
`id` - `ID!`
`slug` - `String!`

Example

{
  "id": "4",
  "slug": "xyz789"
}

Types

OrganizationSlugUpdatePayload

Types

Union Types
`NotAllowedToSlugUpdateError`
`OrganizationDoesNotExistError`
`OrganizationSlugUpdateSuccess`
`ReservedSlugsCheckError`
`SlugAlreadyExistsError`
`SlugError`
`SlugSizeCheckError`

Example

NotAllowedToSlugUpdateError

Types

OrganizationSlugUpdateSuccess

Fields

Field Name	Description
`organization` - `Organization!`
`query` - `Query!`

Example

{
  "organization": Organization,
  "query": Query
}

Types

OrganizationUpdateInput

Fields

Input Field	Description
`id` - `ID!`
`name` - `String`
`oidcIssuer` - `String`	The OIDC identity provider (`iss` / issuer) to take into account when automatically provisioning organization memberships based on the `groups` claim.
`oidcGroupName` - `String`	The group name that maps to this organization in the configured OIDC identity provider.

Example

{
  "id": 4,
  "name": "abc123",
  "oidcIssuer": "xyz789",
  "oidcGroupName": "xyz789"
}

Types

OrganizationUpdatePayload

Types

Union Types
`NameSizeCheckError`
`NotAllowedToUpdateOrganizationError`
`OrganizationDoesNotExistError`
`OrganizationUpdateSuccess`

Example

NameSizeCheckError

Types

OrganizationUpdateSuccess

Fields

Field Name	Description
`organization` - `Organization!`
`query` - `Query!`

Example

{
  "organization": Organization,
  "query": Query
}

Types

PageInfo

Description

Information about pagination in a connection

Fields

Field Name	Description
`endCursor` - `String`	When paginating forwards, the cursor to continue.
`hasNextPage` - `Boolean!`	When paginating forwards, are there more items?
`hasPreviousPage` - `Boolean!`	When paginating backwards, are there more items?
`startCursor` - `String`	When paginating backwards, the cursor to continue.

Example

{
  "endCursor": "abc123",
  "hasNextPage": false,
  "hasPreviousPage": false,
  "startCursor": "xyz789"
}

Types

PersonalAccountUpdateInput

Fields

Input Field	Description
`name` - `String!`

Example

{"name": "xyz789"}

Types

PersonalAccountUpdatePayload

Types

Union Types
`NameSizeCheckError`
`PersonalAccountUpdateSuccess`

Example

NameSizeCheckError

Types

PersonalAccountUpdateSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

ProposalCheckError

Fields

Field Name	Description
`message` - `String!`
`title` - `String!`

Example

{
  "message": "abc123",
  "title": "xyz789"
}

Types

PublishDeploymentFailure

Fields

Field Name	Description
`deploymentError` - `String!`
`query` - `Query!`

Example

{
  "deploymentError": "xyz789",
  "query": Query
}

Types

PublishForbidden

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

PublishInput

Fields

Input Field	Description
`url` - `String`	The URL of the subgraph. Can be left blank if the subgraph already exist or when creating a virtual subgraph.
`schema` - `String!`	The SDL of the subgraph
`accountSlug` - `String!`
`graphSlug` - `String`
`message` - `String`	Associated message (for humans)
`branch` - `String`
`subgraph` - `String!`	The name of the subgraph
`virtual` - `Boolean`	Whether this is a virtual subgraph (no URL)

Example

{
  "url": "xyz789",
  "schema": "abc123",
  "accountSlug": "xyz789",
  "graphSlug": "abc123",
  "message": "abc123",
  "branch": "abc123",
  "subgraph": "xyz789",
  "virtual": false
}

Types

PublishNoChange

Description

Returned when the client tries to publish the same subgraph schema with the same url as already published. Such a publish does not result in a deployment.

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

PublishPayload

Types

Union Types
`FederatedGraphCompositionError`
`GraphDoesNotExistError`
`PublishDeploymentFailure`
`PublishForbidden`
`PublishNoChange`
`PublishSuccess`
`SchemaRegistryBranchDoesNotExistError`

Example

FederatedGraphCompositionError

Types

PublishSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

Request

Fields

Field Name	Description
`clientName` - `String!`
`clientVersion` - `String!`
`endedAt` - `DateTime!`
`errorCount` - `Int!`
`errorCountByCode` - `[ErrorCountByCode!]!`
`httpRequestMethod` - `String!`
`httpStatusCode` - `Int!`
`id` - `ID!`
`operations` - `[RequestOperation!]!`
`rootSpanId` - `ID!`
`startedAt` - `DateTime!`
`trace` - `Trace!`
`urlPath` - `String!`
`userAgent` - `String!`

Example

{
  "clientName": "abc123",
  "clientVersion": "abc123",
  "endedAt": "2007-12-03T10:15:30Z",
  "errorCount": 987,
  "errorCountByCode": [ErrorCountByCode],
  "httpRequestMethod": "abc123",
  "httpStatusCode": 987,
  "id": 4,
  "operations": [RequestOperation],
  "rootSpanId": 4,
  "startedAt": "2007-12-03T10:15:30Z",
  "trace": Trace,
  "urlPath": "abc123",
  "userAgent": "abc123"
}

Types

RequestConnection

Fields

Field Name	Description
`edges` - `[RequestEdge!]!`	A list of edges.
`nodes` - `[Request!]!`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.

Example

{
  "edges": [RequestEdge],
  "nodes": [Request],
  "pageInfo": PageInfo
}

Types

RequestEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination
`node` - `Request!`	The item at the end of the edge

Example

{
  "cursor": "xyz789",
  "node": Request
}

Types

RequestFilters

Fields

Input Field	Description
`branchName` - `String`	Defaults to production branch
`duration` - `DurationFilter`
`range` - `Duration`	Use this if you really care about having a specific duration like 1 hour, 7 days, etc.
`from` - `DateTime`	Use this if you at least the data between `from` and `to` to be provided. You may get more, but never less.
`to` - `DateTime!`	To be used in conjunction with with either `range` or `from`.
`traceId` - `[String!]`
`operationName` - `[String!]`
`clientName` - `[String!]`
`clientVersion` - `[String!]`	Only used if client name is specified.
`httpStatusCode` - `[Int!]`
`operationType` - `[OperationType!]`
`errorCode` - `[String!]`

Example

{
  "branchName": "abc123",
  "duration": DurationFilter,
  "range": "P3Y6M4DT12H30M5S",
  "from": "2007-12-03T10:15:30Z",
  "to": "2007-12-03T10:15:30Z",
  "traceId": ["xyz789"],
  "operationName": ["xyz789"],
  "clientName": ["abc123"],
  "clientVersion": ["abc123"],
  "httpStatusCode": [123],
  "operationType": ["QUERY"],
  "errorCode": ["abc123"]
}

Types

RequestMetricsTimeSeriesDataPointV2

Fields

Field Name	Description
`cacheHitCount` - `Int!`
`cacheMissCount` - `Int!`
`cachePassCount` - `Int!`
`count` - `Int!`
`dateTime` - `DateTime!`
`error4XxCount` - `Int!`
`error5XxCount` - `Int!`
`errorGraphqlCount` - `Int!`
`latencyMsPercentiles` - `[Int!]!`

Example

{
  "cacheHitCount": 987,
  "cacheMissCount": 123,
  "cachePassCount": 987,
  "count": 987,
  "dateTime": "2007-12-03T10:15:30Z",
  "error4XxCount": 987,
  "error5XxCount": 123,
  "errorGraphqlCount": 987,
  "latencyMsPercentiles": [123]
}

Types

RequestMetricsTimeSeriesV2

Fields

Field Name	Description
`overall` - `RequestMetricsV2!`
`points` - `[RequestMetricsTimeSeriesDataPointV2!]!`
`previousPeriod` - `RequestMetricsTimeSeriesV2`

Example

{
  "overall": RequestMetricsV2,
  "points": [RequestMetricsTimeSeriesDataPointV2],
  "previousPeriod": RequestMetricsTimeSeriesV2
}

Types

RequestMetricsV2

Fields

Field Name	Description
`cacheHitCount` - `Int!`
`cacheMissCount` - `Int!`
`cachePassCount` - `Int!`
`count` - `Int!`
`error4XxCount` - `Int!`
`error5XxCount` - `Int!`
`errorGraphqlCount` - `Int!`
`latencyMsPercentiles` - `[Int!]!`

Example

{
  "cacheHitCount": 123,
  "cacheMissCount": 987,
  "cachePassCount": 123,
  "count": 987,
  "error4XxCount": 123,
  "error5XxCount": 123,
  "errorGraphqlCount": 123,
  "latencyMsPercentiles": [123]
}

Types

RequestOperation

Fields

Field Name	Description
`name` - `String!`
`type` - `OperationType!`

Example

{"name": "abc123", "type": "QUERY"}

Types

ReservedSlugsCheckError

Fields

Field Name	Description
`message` - `String!`
`query` - `Query!`

Example

{
  "message": "abc123",
  "query": Query
}

Types

ReusedId

Description

An occurrence of a trusted document that was submitted again (same id), but with a different document text. This is an error.

Fields

Field Name	Description
`documentId` - `String!`	The document id
`existingDocumentText` - `String!`	The existing document body
`newDocumentText` - `String!`	The different, newly submitted document body

Example

{
  "documentId": "abc123",
  "existingDocumentText": "xyz789",
  "newDocumentText": "abc123"
}

Types

ReusedIds

Description

Trusted documents that were uploaded again (same id), but with a different document body. This is an error.

Fields

Field Name	Description
`reused` - `[ReusedId!]!`

Example

{"reused": [ReusedId]}

Types

ReviewerDoesNotExistError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SchemaChangeType

Values

Enum Value	Description
`SCHEMA_DEFINITION_ADDED`
`SCHEMA_DEFINITION_REMOVED`
`SCHEMA_EXTENSION_ADDED`
`SCHEMA_EXTENSION_REMOVED`
`FIELD_ARGUMENT_DEFAULT_ADDED`
`FIELD_ARGUMENT_DEFAULT_REMOVED`
`FIELD_ARGUMENT_DESCRIPTION_CHANGED`
`FIELD_ARGUMENT_DEFAULT_CHANGED`
`FIELD_ARGUMENT_TYPE_CHANGED`
`DIRECTIVE_REMOVED`
`DIRECTIVE_ADDED`
`DIRECTIVE_DESCRIPTION_CHANGED`
`DIRECTIVE_LOCATION_ADDED`
`DIRECTIVE_LOCATION_REMOVED`
`DIRECTIVE_ARGUMENT_ADDED`
`DIRECTIVE_ARGUMENT_REMOVED`
`DIRECTIVE_ARGUMENT_DESCRIPTION_CHANGED`
`DIRECTIVE_ARGUMENT_DEFAULT_VALUE_CHANGED`
`DIRECTIVE_ARGUMENT_TYPE_CHANGED`
`ENUM_ADDED`
`ENUM_REMOVED`
`ENUM_VALUE_REMOVED`
`ENUM_VALUE_ADDED`
`ENUM_VALUE_DESCRIPTION_CHANGED`
`ENUM_VALUE_DEPRECATION_REASON_CHANGED`
`ENUM_VALUE_DEPRECATION_REASON_ADDED`
`ENUM_VALUE_DEPRECATION_REASON_REMOVED`
`FIELD_REMOVED`
`FIELD_ADDED`
`FIELD_DESCRIPTION_CHANGED`
`FIELD_DESCRIPTION_ADDED`
`FIELD_DESCRIPTION_REMOVED`
`FIELD_DEPRECATION_ADDED`
`FIELD_DEPRECATION_REMOVED`
`FIELD_DEPRECATION_REASON_CHANGED`
`FIELD_DEPRECATION_REASON_ADDED`
`FIELD_DEPRECATION_REASON_REMOVED`
`FIELD_TYPE_CHANGED`
`FIELD_ARGUMENT_ADDED`
`FIELD_ARGUMENT_REMOVED`
`INPUT_OBJECT_REMOVED`
`INPUT_OBJECT_ADDED`
`INPUT_FIELD_REMOVED`
`INPUT_FIELD_ADDED`
`INPUT_FIELD_DESCRIPTION_ADDED`
`INPUT_FIELD_DESCRIPTION_REMOVED`
`INPUT_FIELD_DESCRIPTION_CHANGED`
`INPUT_FIELD_DEFAULT_VALUE_CHANGED`
`INPUT_FIELD_TYPE_CHANGED`
`OBJECT_TYPE_INTERFACE_ADDED`
`OBJECT_TYPE_INTERFACE_REMOVED`
`SCHEMA_QUERY_TYPE_CHANGED`
`SCHEMA_MUTATION_TYPE_CHANGED`
`SCHEMA_SUBSCRIPTION_TYPE_CHANGED`
`TYPE_REMOVED`
`TYPE_ADDED`
`TYPE_KIND_CHANGED`
`TYPE_DESCRIPTION_CHANGED`
`TYPE_DESCRIPTION_REMOVED`
`TYPE_DESCRIPTION_ADDED`
`UNION_ADDED`
`UNION_REMOVED`
`UNION_MEMBER_REMOVED`
`UNION_MEMBER_ADDED`
`INTERFACE_ADDED`
`INTERFACE_REMOVED`
`INTERFACE_IMPLEMENTATION_ADDED`
`INTERFACE_IMPLEMENTATION_REMOVED`
`SCALAR_ADDED`
`SCALAR_REMOVED`

Example

"SCHEMA_DEFINITION_ADDED"

Types

SchemaCheck

Fields

Field Name	Description
`compositionCheckErrors` - `[CompositionCheckError!]!`	Replaced by SchemaCheck.diagnostics
`createdAt` - `DateTime!`
`diagnostics` - `[SchemaCheckDiagnostic!]!`
`errorCount` - `Int!`
`gitCommit` - `SchemaCheckGitCommit`
`id` - `ID!`
`lintCheckErrors` - `[LintCheckError!]!`	Replaced by SchemaCheck.diagnostics
`operationCheckErrors` - `[OperationCheckError!]!`	Replaced by SchemaCheck.diagnostics
`proposalCheckErrors` - `[ProposalCheckError!]!`	Replaced by SchemaCheck.diagnostics
`schema` - `String!`
`subgraphName` - `String`
`validationCheckErrors` - `[ValidationCheckError!]!`	Replaced by SchemaCheck.diagnostics

Example

{
  "compositionCheckErrors": [CompositionCheckError],
  "createdAt": "2007-12-03T10:15:30Z",
  "diagnostics": [SchemaCheckDiagnostic],
  "errorCount": 987,
  "gitCommit": SchemaCheckGitCommit,
  "id": "4",
  "lintCheckErrors": [LintCheckError],
  "operationCheckErrors": [OperationCheckError],
  "proposalCheckErrors": [ProposalCheckError],
  "schema": "xyz789",
  "subgraphName": "abc123",
  "validationCheckErrors": [ValidationCheckError]
}

Types

SchemaCheckConnection

Fields

Field Name	Description
`edges` - `[SchemaCheckEdge!]!`	A list of edges.
`nodes` - `[SchemaCheck!]!`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.

Example

{
  "edges": [SchemaCheckEdge],
  "nodes": [SchemaCheck],
  "pageInfo": PageInfo
}

Types

SchemaCheckCreateInput

Fields

Input Field	Description
`schema` - `String!`
`accountSlug` - `String!`
`graphSlug` - `String!`
`branch` - `String`
`subgraphName` - `String!`
`gitCommit` - `SchemaCheckGitCommitInput`

Example

{
  "schema": "abc123",
  "accountSlug": "abc123",
  "graphSlug": "abc123",
  "branch": "xyz789",
  "subgraphName": "xyz789",
  "gitCommit": SchemaCheckGitCommitInput
}

Types

SchemaCheckCustomWebhookCreateInput

Fields

Input Field	Description
`url` - `Url!`	The webhook URL that will be called when a schema check is created.
`headers` - `[HttpHeaderInput!]`	The headers to be sent with the webhook request.
`graphId` - `ID!`	The graph the schema checks apply to.

Example

{
  "url": Url,
  "headers": [HttpHeaderInput],
  "graphId": "4"
}

Types

SchemaCheckCustomWebhookCreatePayload

Types

Union Types
`SchemaCheckCustomWebhookCreateSuccess`

Example

SchemaCheckCustomWebhookCreateSuccess

Types

SchemaCheckCustomWebhookCreateSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SchemaCheckCustomWebhookDeletePayload

Types

Union Types
`CustomCheckWebhookNotFoundError`
`SchemaCheckCustomWebhookDeleteSuccess`

Example

CustomCheckWebhookNotFoundError

Types

SchemaCheckCustomWebhookDeleteSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SchemaCheckCustomWebhookUpdateInput

Fields

Input Field	Description
`headers` - `[HttpHeaderInput!]`
`webhookId` - `ID!`

Example

{"headers": [HttpHeaderInput], "webhookId": 4}

Types

SchemaCheckCustomWebhookUpdatePayload

Types

Union Types
`SchemaCheckCustomWebhookUpdateSuccess`

Example

SchemaCheckCustomWebhookUpdateSuccess

Types

SchemaCheckCustomWebhookUpdateSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SchemaCheckDiagnostic

Fields

Field Name	Description
`message` - `String!`
`severity` - `SchemaCheckErrorSeverity!`
`step` - `SchemaCheckStep!`

Example

{
  "message": "xyz789",
  "severity": "ERROR",
  "step": "VALIDATION"
}

Types

SchemaCheckEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination
`node` - `SchemaCheck!`	The item at the end of the edge

Example

{
  "cursor": "abc123",
  "node": SchemaCheck
}

Types

SchemaCheckErrorSeverity

Values

Enum Value	Description
`ERROR`
`WARNING`

Example

"ERROR"

Types

SchemaCheckGitCommit

Fields

Field Name	Description
`authorAvatarUrl` - `String`
`authorName` - `String!`
`branch` - `String!`
`commitSha` - `String!`
`commitUrl` - `String`
`message` - `String!`

Example

{
  "authorAvatarUrl": "xyz789",
  "authorName": "abc123",
  "branch": "xyz789",
  "commitSha": "xyz789",
  "commitUrl": "xyz789",
  "message": "abc123"
}

Types

SchemaCheckGitCommitInput

Fields

Input Field	Description
`message` - `String!`
`branch` - `String!`
`commitSha` - `String!`
`commitUrl` - `String`
`authorName` - `String!`
`authorAvatarUrl` - `String`

Example

{
  "message": "abc123",
  "branch": "abc123",
  "commitSha": "abc123",
  "commitUrl": "xyz789",
  "authorName": "xyz789",
  "authorAvatarUrl": "xyz789"
}

Types

SchemaCheckPayload

Types

Union Types
`GraphBranchDoesNotExistError`
`GraphDoesNotExistError`
`SchemaCheck`
`SubgraphNameMissingOnFederatedGraphError`

Example

GraphBranchDoesNotExistError

Types

SchemaCheckStep

Values

Enum Value	Description
`VALIDATION`
`COMPOSITION`
`OPERATION`
`LINT`
`PROPOSAL`
`CUSTOM`

Example

"VALIDATION"

Types

SchemaProposal

Fields

Field Name	Description
`activityFeed` - `[SchemaProposalActivityFeedItem!]!`	The whole activity feed.
`author` - `User`
`branch` - `Branch`
`comments` - `[SchemaProposalComment!]!`
`createdAt` - `DateTime!`
`description` - `String`
`id` - `ID!`
`reviewers` - `[SchemaProposalReviewer!]!`	All the reviewers and their status. It will return all users that: Have been configured as reviewers for the branch of the proposal. Have been requested to review the proposal. Have reviewed the proposal. And all the teams that have been configured or requested, but where the review is pending. This does not return teams that have already have a review status, because are returned in SchemaProposalReviewerUser.onBehalfOf.
`revision` - `Int!`	The revision number of the proposal, i.e. how many times edits were applied to the proposal's subgraphs.
`status` - `SchemaProposalStatus!`
`subgraph` - `SchemaProposalSubgraph`
Arguments `subgraphName` - `String!`
`subgraphs` - `[SchemaProposalSubgraph!]!`
`title` - `String!`
`viewerIsReviewer` - `Boolean!`	Is the currently logged in user a reviewer of this proposal? That is to say, eitheir they are configured as a reviewer, or

Example

{
  "activityFeed": [SchemaProposalActivityFeedItem],
  "author": User,
  "branch": Branch,
  "comments": [SchemaProposalComment],
  "createdAt": "2007-12-03T10:15:30Z",
  "description": "abc123",
  "id": "4",
  "reviewers": [SchemaProposalReviewerTeam],
  "revision": 123,
  "status": "APPROVED",
  "subgraph": SchemaProposalSubgraph,
  "subgraphs": [SchemaProposalSubgraph],
  "title": "xyz789",
  "viewerIsReviewer": true
}

Types

SchemaProposalActivityFeedItem

Fields

Field Name	Description
`createdAt` - `DateTime!`

Possible Types

SchemaProposalActivityFeedItem Types
`SchemaProposalApproval`
`SchemaProposalCommentOnLine`
`SchemaProposalCommentOnProposal`
`SchemaProposalCommentOnSdl`
`SchemaProposalRejection`
`SchemaProposalReviewRequest`
`SchemaProposalRevision`
`SchemaProposalStatusChange`

Example

{"createdAt": "2007-12-03T10:15:30Z"}

Types

SchemaProposalApproval

Fields

Field Name	Description
`author` - `User`
`createdAt` - `DateTime!`
`id` - `ID!`
`message` - `String`
`schemaProposal` - `SchemaProposal!`

Example

{
  "author": User,
  "createdAt": "2007-12-03T10:15:30Z",
  "id": "4",
  "message": "xyz789",
  "schemaProposal": SchemaProposal
}

Types

SchemaProposalApproveInput

Fields

Input Field	Description
`id` - `ID!`
`message` - `String`

Example

{
  "id": "4",
  "message": "xyz789"
}

Types

SchemaProposalApprovePayload

Types

Union Types
`SchemaProposalApproveSuccess`
`SchemaProposalDoesNotExistError`

Example

SchemaProposalApproveSuccess

Types

SchemaProposalApproveSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SchemaProposalComment

Fields

Field Name	Description
`author` - `User`
`createdAt` - `DateTime!`
`id` - `ID!`
`text` - `String!`

Possible Types

SchemaProposalComment Types
`SchemaProposalCommentOnLine`
`SchemaProposalCommentOnProposal`
`SchemaProposalCommentOnSdl`
`SchemaProposalReply`

Example

{
  "author": User,
  "createdAt": "2007-12-03T10:15:30Z",
  "id": "4",
  "text": "xyz789"
}

Types

SchemaProposalCommentOnLine

Fields

Field Name	Description
`author` - `User`	Who wrote the comment. Will be null in case the user was deleted.
`context` - `String`	The section of the subgraph SDL where the comment is located.
Arguments `contextLines` - `Int!` How many lines around the commented line to include. Fewer lines can be returned if the context reaches the start or the end of the schema.
`createdAt` - `DateTime!`
`diffSide` - `DiffSide!`
`id` - `ID!`
`line` - `Int`	Which line the comment applies to in the subgraph SDL. This may be `null` if the comment was on an item that is no longer part of the current subgraph schema. The line is 1-indexes
`path` - `String!`	The logical path in the schema where the comment is located. This is only exposed for debugging, prefer using the `line` field.
`replies` - `[SchemaProposalReply!]!`	All the replies in chronological order, from oldest to newest.
`resolved` - `Boolean!`	Is this comment thread resolved?
`resolvedBy` - `User`	The user who marked the thread as resolved.
`subgraphName` - `String!`	Which subgraph the comment applies to.
`text` - `String!`	The content of the comment.

Example

{
  "author": User,
  "context": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "diffSide": "OLD",
  "id": 4,
  "line": 123,
  "path": "abc123",
  "replies": [SchemaProposalReply],
  "resolved": true,
  "resolvedBy": User,
  "subgraphName": "abc123",
  "text": "abc123"
}

Types

SchemaProposalCommentOnProposal

Fields

Field Name	Description
`author` - `User`	Who wrote the comment. Will be null in case the user was deleted.
`createdAt` - `DateTime!`
`id` - `ID!`
`replies` - `[SchemaProposalReply!]!`
`text` - `String!`

Example

{
  "author": User,
  "createdAt": "2007-12-03T10:15:30Z",
  "id": 4,
  "replies": [SchemaProposalReply],
  "text": "abc123"
}

Types

SchemaProposalCommentOnSdl

Fields

Field Name	Description
`author` - `User`
`createdAt` - `DateTime!`
`id` - `ID!`
`replies` - `[SchemaProposalReply!]!`
`resolved` - `Boolean!`	Is this comment thread resolved?
`resolvedBy` - `User`	The user who marked the thread as resolved.
`text` - `String!`

Example

{
  "author": User,
  "createdAt": "2007-12-03T10:15:30Z",
  "id": "4",
  "replies": [SchemaProposalReply],
  "resolved": true,
  "resolvedBy": User,
  "text": "abc123"
}

Types

SchemaProposalCommentReplyPayload

Types

Union Types
`SchemaProposalCommentReplySuccess`

Example

SchemaProposalCommentReplySuccess

Types

SchemaProposalCommentReplySuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SchemaProposalCommentThreadCreateInput

Fields

Input Field	Description
`schemaProposalId` - `ID!`	The parent schema proposal.
`text` - `String!`	The content of the comment.
`subgraphName` - `String`	Must be provided if and only if location is Line.
`line` - `Int`	Must be provided if and only if location is Line.
`diffSide` - `DiffSide`	Whether the comment applies to the existing or the proposed schema. Must be provided if and only if location is Line.
`location` - `SchemaProposalCommentThreadLocation!`	Where the comment is located.
`proposalRevision` - `Int`	The revision / version number of the proposal, obtained from SchemaProposal.revision. Must be provided if and only if location is Line. This argument is necessary to avoid cases where the schema has been updated between the time it was retried and the time the comment is posted. In these cases, if we use the latest subgraph schema, the line numbers may have changed and the comment would end up in the wrong place.

Example

{
  "schemaProposalId": 4,
  "text": "abc123",
  "subgraphName": "xyz789",
  "line": 123,
  "diffSide": "OLD",
  "location": "PROPOSAL",
  "proposalRevision": 123
}

Types

SchemaProposalCommentThreadCreatePayload

Types

Union Types
`SchemaProposalCommentThreadCreateSuccess`
`SchemaProposalDoesNotExistError`

Example

SchemaProposalCommentThreadCreateSuccess

Types

SchemaProposalCommentThreadCreateSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SchemaProposalCommentThreadLocation

Values

Enum Value	Description
`PROPOSAL`
`LINE`
`SDL`

Example

"PROPOSAL"

Types

SchemaProposalCommentThreadResolvePayload

Types

Union Types
`SchemaProposalCommentThreadResolveSuccess`

Example

SchemaProposalCommentThreadResolveSuccess

Types

SchemaProposalCommentThreadResolveSuccess

Fields

Field Name	Description
`affectedRows` - `Int!`
`query` - `Query!`

Example

{"affectedRows": 123, "query": Query}

Types

SchemaProposalCommentThreadUnresolvePayload

Types

Union Types
`SchemaProposalCommentThreadUnresolveSuccess`

Example

SchemaProposalCommentThreadUnresolveSuccess

Types

SchemaProposalCommentThreadUnresolveSuccess

Fields

Field Name	Description
`affectedRows` - `Int!`
`query` - `Query!`

Example

{"affectedRows": 987, "query": Query}

Types

SchemaProposalConnection

Fields

Field Name	Description
`edges` - `[SchemaProposalEdge!]!`	A list of edges.
`nodes` - `[SchemaProposal!]!`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.

Example

{
  "edges": [SchemaProposalEdge],
  "nodes": [SchemaProposal],
  "pageInfo": PageInfo
}

Types

SchemaProposalCreateInput

Fields

Input Field	Description
`title` - `String!`
`description` - `String`
`branchId` - `ID!`

Example

{
  "title": "xyz789",
  "description": "abc123",
  "branchId": 4
}

Types

SchemaProposalCreatePayload

Types

Union Types
`SchemaProposalCreateSuccess`

Example

SchemaProposalCreateSuccess

Types

SchemaProposalCreateSuccess

Fields

Field Name	Description
`query` - `Query!`
`schemaProposal` - `SchemaProposal!`

Example

{
  "query": Query,
  "schemaProposal": SchemaProposal
}

Types

SchemaProposalDeletePayload

Types

Union Types
`SchemaProposalDeleteSuccess`
`SchemaProposalDoesNotExistError`

Example

SchemaProposalDeleteSuccess

Types

SchemaProposalDeleteSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SchemaProposalDoesNotExistError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SchemaProposalEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination
`node` - `SchemaProposal!`	The item at the end of the edge

Example

{
  "cursor": "xyz789",
  "node": SchemaProposal
}

Types

SchemaProposalEditInput

Fields

Input Field	Description
`subgraphs` - `[SchemaProposalEditSubgraph!]!`
`description` - `String`
`schemaProposalId` - `ID!`

Example

{
  "subgraphs": [SchemaProposalEditSubgraph],
  "description": "abc123",
  "schemaProposalId": "4"
}

Types

SchemaProposalEditParserError

Fields

Field Name	Description
`error` - `String!`
`spanEnd` - `Int!`
`spanStart` - `Int!`
`subgraphName` - `String!`

Example

{
  "error": "abc123",
  "spanEnd": 123,
  "spanStart": 123,
  "subgraphName": "xyz789"
}

Types

SchemaProposalEditParserErrors

Fields

Field Name	Description
`errors` - `[SchemaProposalEditParserError!]!`

Example

{"errors": [SchemaProposalEditParserError]}

Types

SchemaProposalEditPayload

Types

Union Types
`SchemaProposalDoesNotExistError`
`SchemaProposalEditParserErrors`
`SchemaProposalEditSuccess`

Example

SchemaProposalDoesNotExistError

Types

SchemaProposalEditSubgraph

Fields

Input Field	Description
`name` - `String!`
`schema` - `String`

Example

{
  "name": "xyz789",
  "schema": "xyz789"
}

Types

SchemaProposalEditSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SchemaProposalFilter

Fields

Input Field	Description
`status` - `SchemaProposalStatus`

Example

{"status": "APPROVED"}

Types

SchemaProposalRejectInput

Fields

Input Field	Description
`id` - `ID!`
`message` - `String`

Example

{
  "id": "4",
  "message": "xyz789"
}

Types

SchemaProposalRejectPayload

Types

Union Types
`SchemaProposalDoesNotExistError`
`SchemaProposalRejectSuccess`

Example

SchemaProposalDoesNotExistError

Types

SchemaProposalRejectSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SchemaProposalRejection

Fields

Field Name	Description
`author` - `User`
`createdAt` - `DateTime!`
`id` - `ID!`
`message` - `String`
`schemaProposal` - `SchemaProposal!`

Example

{
  "author": User,
  "createdAt": "2007-12-03T10:15:30Z",
  "id": "4",
  "message": "abc123",
  "schemaProposal": SchemaProposal
}

Types

SchemaProposalReply

Fields

Field Name	Description
`author` - `User`	Who wrote the comment. Will be null in case the user was deleted.
`createdAt` - `DateTime!`
`id` - `ID!`
`text` - `String!`

Example

{
  "author": User,
  "createdAt": "2007-12-03T10:15:30Z",
  "id": "4",
  "text": "xyz789"
}

Types

SchemaProposalRequestReviewInput

Fields

Input Field	Description
`id` - `ID!`

Example

{"id": 4}

Types

SchemaProposalRequestReviewPayload

Types

Union Types
`SchemaProposalDoesNotExistError`
`SchemaProposalRequestReviewSuccess`

Example

SchemaProposalDoesNotExistError

Types

SchemaProposalRequestReviewSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SchemaProposalRevertToDraftPayload

Types

Union Types
`SchemaProposalDoesNotExistError`
`SchemaProposalRevertToDraftSuccess`

Example

SchemaProposalDoesNotExistError

Types

SchemaProposalRevertToDraftSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SchemaProposalReview

Fields

Field Name	Description
`author` - `User`
`createdAt` - `DateTime!`
`id` - `ID!`
`schemaProposal` - `SchemaProposal!`

Possible Types

SchemaProposalReview Types
`SchemaProposalApproval`
`SchemaProposalRejection`

Example

{
  "author": User,
  "createdAt": "2007-12-03T10:15:30Z",
  "id": 4,
  "schemaProposal": SchemaProposal
}

Types

SchemaProposalReviewNotification

Fields

Field Name	Description
`createdAt` - `DateTime!`
`id` - `ID!`
`readAt` - `DateTime`
`review` - `SchemaProposalReview!`

Example

{
  "createdAt": "2007-12-03T10:15:30Z",
  "id": 4,
  "readAt": "2007-12-03T10:15:30Z",
  "review": SchemaProposalReview
}

Types

SchemaProposalReviewRequest

Fields

Field Name	Description
`createdAt` - `DateTime!`
`id` - `ID!`
`requestFor` - `UserOrTeam!`
`requestedBy` - `ID!`
`schemaProposal` - `SchemaProposal!`

Example

{
  "createdAt": "2007-12-03T10:15:30Z",
  "id": "4",
  "requestFor": Team,
  "requestedBy": 4,
  "schemaProposal": SchemaProposal
}

Types

SchemaProposalReviewRequestCreateInput

Fields

Input Field	Description
`schemaProposalId` - `ID!`
`reviewerId` - `ID!`	Must be either a team id or a user id.

Example

{"schemaProposalId": 4, "reviewerId": "4"}

Types

SchemaProposalReviewRequestCreatePayload

Types

Union Types
`SchemaProposalDoesNotExistError`
`SchemaProposalReviewRequestCreateSuccess`

Example

SchemaProposalDoesNotExistError

Types

SchemaProposalReviewRequestCreateSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SchemaProposalReviewRequestNotification

Fields

Field Name	Description
`createdAt` - `DateTime!`
`id` - `ID!`
`readAt` - `DateTime`
`reviewRequest` - `SchemaProposalReviewRequest!`

Example

{
  "createdAt": "2007-12-03T10:15:30Z",
  "id": 4,
  "readAt": "2007-12-03T10:15:30Z",
  "reviewRequest": SchemaProposalReviewRequest
}

Types

SchemaProposalReviewer

Types

Union Types
`SchemaProposalReviewerTeam`
`SchemaProposalReviewerUser`

Example

SchemaProposalReviewerTeam

Types

SchemaProposalReviewerStatus

Values

Enum Value	Description
`PENDING`
`APPROVED`
`REJECTED`

Example

"PENDING"

Types

SchemaProposalReviewerTeam

Fields

Field Name	Description
`team` - `Team!`

Example

{"team": Team}

Types

SchemaProposalReviewerUser

Fields

Field Name	Description
`onBehalfOf` - `[Team!]!`	The teams that were requested or configured for review that the user reviewed on behalf of.
`status` - `SchemaProposalReviewerStatus!`
`user` - `User!`

Example

{
  "onBehalfOf": [Team],
  "status": "PENDING",
  "user": User
}

Types

SchemaProposalRevision

Fields

Field Name	Description
`author` - `User`	The author of the revision.
`createdAt` - `DateTime!`
`description` - `String`	The message entered when the author saved changes.

Example

{
  "author": User,
  "createdAt": "2007-12-03T10:15:30Z",
  "description": "abc123"
}

Types

SchemaProposalStatus

Values

Enum Value	Description
`APPROVED`
`REJECTED`
`DRAFT`
`IMPLEMENTED`
`IN_REVIEW`

Example

"APPROVED"

Types

SchemaProposalStatusChange

Fields

Field Name	Description
`createdAt` - `DateTime!`
`fromStatus` - `SchemaProposalStatus!`
`schemaProposal` - `SchemaProposal!`
`toStatus` - `SchemaProposalStatus!`

Example

{
  "createdAt": "2007-12-03T10:15:30Z",
  "fromStatus": "APPROVED",
  "schemaProposal": SchemaProposal,
  "toStatus": "APPROVED"
}

Types

SchemaProposalStatusChangeNotification

Fields

Field Name	Description
`createdAt` - `DateTime!`
`id` - `ID!`
`readAt` - `DateTime`

Example

{
  "createdAt": "2007-12-03T10:15:30Z",
  "id": "4",
  "readAt": "2007-12-03T10:15:30Z"
}

Types

SchemaProposalSubgraph

Fields

Field Name	Description
`comments` - `[SchemaProposalComment!]!`
`diffSnippets` - `[DiffSnippet!]!`
`name` - `String!`
`sdl` - `String`
`status` - `SchemaProposalSubgraphStatus!`

Example

{
  "comments": [SchemaProposalComment],
  "diffSnippets": [DiffSnippet],
  "name": "xyz789",
  "sdl": "abc123",
  "status": "CREATED"
}

Types

SchemaProposalSubgraphStatus

Values

Enum Value	Description
`CREATED`
`EDITED`
`DELETED`
`UNCHANGED`

Example

"CREATED"

Types

SchemaProposalUpdateInput

Fields

Input Field	Description
`title` - `String`
`description` - `String`
`schemaProposalId` - `ID!`

Example

{
  "title": "abc123",
  "description": "abc123",
  "schemaProposalId": 4
}

Types

SchemaProposalUpdatePayload

Types

Union Types
`SchemaProposalDoesNotExistError`
`SchemaProposalUpdateSuccess`

Example

SchemaProposalDoesNotExistError

Types

SchemaProposalUpdateSuccess

Fields

Field Name	Description
`query` - `Query!`
`schemaProposal` - `SchemaProposal!`

Example

{
  "query": Query,
  "schemaProposal": SchemaProposal
}

Types

SchemaProposalsConfiguration

Fields

Field Name	Description
`configuredReviewers` - `[SchemaProposalsConfiguredReviewers!]!`
`enforceChecks` - `Boolean!`
`keepApprovalsOnEdit` - `Boolean!`
`requireApprovalFromSubgraphOwners` - `Boolean!`

Example

{
  "configuredReviewers": [
    SchemaProposalsConfiguredReviewerTeam
  ],
  "enforceChecks": true,
  "keepApprovalsOnEdit": true,
  "requireApprovalFromSubgraphOwners": true
}

Types

SchemaProposalsConfigurationUpdateInput

Fields

Input Field	Description
`enforceChecks` - `Boolean`
`requireApprovalFromSubgraphOwners` - `Boolean`
`keepApprovalsOnEdit` - `Boolean`

Example

{
  "enforceChecks": false,
  "requireApprovalFromSubgraphOwners": true,
  "keepApprovalsOnEdit": false
}

Types

SchemaProposalsConfiguredReviewerAddInput

Fields

Input Field	Description
`branchId` - `ID!`
`reviewerId` - `ID!`	Either a UserId or a TeamId

Example

{"branchId": 4, "reviewerId": "4"}

Types

SchemaProposalsConfiguredReviewerAddPayload

Types

Union Types
`AlreadyExistsError`
`BranchDoesNotExistError`
`SchemaProposalsConfiguredReviewerAddSuccess`
`TeamDoesNotExistError`
`UserDoesNotExistError`

Example

AlreadyExistsError

Types

SchemaProposalsConfiguredReviewerAddSuccess

Fields

Field Name	Description
`query` - `Query!`
`reviewer` - `SchemaProposalsConfiguredReviewers!`

Example

{
  "query": Query,
  "reviewer": SchemaProposalsConfiguredReviewerTeam
}

Types

SchemaProposalsConfiguredReviewerRemoveInput

Fields

Input Field	Description
`branchId` - `ID!`
`reviewerId` - `ID!`	Either a SchemaProposalUserReviewerId or a SchemaProposalTeamReviewerId

Example

{"branchId": 4, "reviewerId": "4"}

Types

SchemaProposalsConfiguredReviewerRemovePayload

Types

Union Types
`BranchDoesNotExistError`
`ReviewerDoesNotExistError`
`SchemaProposalsConfiguredReviewerRemoveSuccess`

Example

BranchDoesNotExistError

Types

SchemaProposalsConfiguredReviewerRemoveSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SchemaProposalsConfiguredReviewerTeam

Fields

Field Name	Description
`id` - `ID!`
`team` - `Team!`

Example

{
  "id": "4",
  "team": Team
}

Types

SchemaProposalsConfiguredReviewerUser

Fields

Field Name	Description
`id` - `ID!`
`user` - `User!`

Example

{
  "id": "4",
  "user": User
}

Types

SchemaProposalsConfiguredReviewers

Description

A (required) schema proposal reviewer in the branch configuration.

Types

Union Types
`SchemaProposalsConfiguredReviewerTeam`
`SchemaProposalsConfiguredReviewerUser`

Example

SchemaProposalsConfiguredReviewerTeam

Types

SchemaRegistryBranchDoesNotExistError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SchemaVersion

Fields

Field Name	Description
`changes` - `SchemaVersionChangeConnection!`
Arguments `after` - `String` `before` - `String` `first` - `Int` `last` - `Int`
`createdAt` - `DateTime!`
`delta` - `SchemaVersionDelta!`
`id` - `ID!`
`message` - `String`
`schema` - `String!`
`subgraph` - `Subgraph`

Example

{
  "changes": SchemaVersionChangeConnection,
  "createdAt": "2007-12-03T10:15:30Z",
  "delta": SchemaVersionDelta,
  "id": "4",
  "message": "xyz789",
  "schema": "xyz789",
  "subgraph": Subgraph
}

Types

SchemaVersionChange

Fields

Field Name	Description
`message` - `String!`
`path` - `String`
`type` - `SchemaChangeType!`

Example

{
  "message": "abc123",
  "path": "abc123",
  "type": "SCHEMA_DEFINITION_ADDED"
}

Types

SchemaVersionChangeConnection

Fields

Field Name	Description
`edges` - `[SchemaVersionChangeEdge!]!`	A list of edges.
`nodes` - `[SchemaVersionChange!]!`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.

Example

{
  "edges": [SchemaVersionChangeEdge],
  "nodes": [SchemaVersionChange],
  "pageInfo": PageInfo
}

Types

SchemaVersionChangeEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination
`node` - `SchemaVersionChange!`	The item at the end of the edge

Example

{
  "cursor": "abc123",
  "node": SchemaVersionChange
}

Types

SchemaVersionConnection

Fields

Field Name	Description
`edges` - `[SchemaVersionEdge!]!`	A list of edges.
`nodes` - `[SchemaVersion!]!`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.

Example

{
  "edges": [SchemaVersionEdge],
  "nodes": [SchemaVersion],
  "pageInfo": PageInfo
}

Types

SchemaVersionDelta

Fields

Field Name	Description
`added` - `Int!`	Additions.
`modified` - `Int!`	Modifications.
`removed` - `Int!`	Removals.

Example

{"added": 987, "modified": 123, "removed": 987}

Types

SchemaVersionEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination
`node` - `SchemaVersion!`	The item at the end of the edge

Example

{
  "cursor": "xyz789",
  "node": SchemaVersion
}

Types

SemverVersion

Example

SemverVersion

Types

SemverVersionRequirement

Example

SemverVersionRequirement

Types

SlackChannel

Description

A Slack channel returned from the Slack API.

Fields

Field Name	Description
`id` - `String!`
`name` - `String!`

Example

{
  "id": "xyz789",
  "name": "abc123"
}

Types

SlackIntegration

Fields

Field Name	Description
`availableChannels` - `[SlackChannel!]!`
`notifications` - `[SlackNotification!]!`

Example

{
  "availableChannels": [SlackChannel],
  "notifications": [SlackNotification]
}

Types

SlackIntegrationCreateInput

Fields

Input Field	Description
`graphId` - `String`	The graph_id field is deprecated. Pass branch_id instead.
`branchId` - `ID`
`tokenId` - `String!`
`channelId` - `String!`
`channelName` - `String!`

Example

{
  "graphId": "xyz789",
  "branchId": 4,
  "tokenId": "xyz789",
  "channelId": "xyz789",
  "channelName": "xyz789"
}

Types

SlackNotification

Fields

Field Name	Description
`branchId` - `String!`
`channelName` - `String!`
`graphId` - `String!`	Graphs are being removed. Please use SlackNotification.branch_id instead
`id` - `String!`

Example

{
  "branchId": "abc123",
  "channelName": "abc123",
  "graphId": "xyz789",
  "id": "abc123"
}

Types

SlackNotificationCreatePayload

Types

Union Types
`GraphDoesNotExistError`
`SlackNotification`

Example

GraphDoesNotExistError

Types

SlackNotificationDeletePayload

Types

Union Types
`Query`

Example

Query

Types

SlugAlreadyExistsError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SlugError

Fields

Field Name	Description
`actual` - `String!`
`expected` - `String!`
`message` - `String!`
`query` - `Query!`

Example

{
  "actual": "abc123",
  "expected": "abc123",
  "message": "abc123",
  "query": Query
}

Types

SlugInvalidError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SlugSizeCheckError

Fields

Field Name	Description
`maxLength` - `Int!`
`message` - `String!`
`query` - `Query!`

Example

{
  "maxLength": 987,
  "message": "abc123",
  "query": Query
}

Types

SlugTooLongError

Fields

Field Name	Description
`maxLength` - `Int!`
`query` - `Query!`

Example

{"maxLength": 123, "query": Query}

Types

StandaloneGraphsNoLongerSupportedError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

String

Example

"abc123"

Types

Subgraph

Fields

Field Name	Description
`createdAt` - `DateTime!`
`name` - `String!`
`owners` - `[Team!]!`
`schema` - `String!`
`updatedAt` - `DateTime!`
`url` - `String`

Example

{
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "xyz789",
  "owners": [Team],
  "schema": "abc123",
  "updatedAt": "2007-12-03T10:15:30Z",
  "url": "abc123"
}

Types

SubgraphAddOwnerPayload

Types

Union Types
`SubgraphAddOwnerSuccess`

Example

SubgraphAddOwnerSuccess

Types

SubgraphAddOwnerSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SubgraphNameMissingOnFederatedGraphError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SubgraphNotFoundError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

SubgraphRemoveOwnerPayload

Types

Union Types
`SubgraphRemoveOwnerSuccess`

Example

SubgraphRemoveOwnerSuccess

Types

SubgraphRemoveOwnerSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

Team

Fields

Field Name	Description
`id` - `ID!`
`members` - `UserConnection!`	The users that are part of the team
Arguments `after` - `String` `first` - `Int`
`name` - `String!`
`parent` - `Team`	The team this team is member of, if any.
`parentTeamId` - `ID`
`query` - `Query!`
`slug` - `String!`
`subteams` - `TeamConnection!`	The teams that are part of the team
Arguments `after` - `String` `first` - `Int`

Example

{
  "id": 4,
  "members": UserConnection,
  "name": "xyz789",
  "parent": Team,
  "parentTeamId": 4,
  "query": Query,
  "slug": "xyz789",
  "subteams": TeamConnection
}

Types

TeamAddMemberPayload

Types

Union Types
`TeamAddMemberSuccess`
`TeamDoesNotExistError`

Example

TeamAddMemberSuccess

Types

TeamAddMemberSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

TeamAssignRolePayload

Types

Union Types
`TeamAssignRoleSuccess`
`TeamDoesNotExistError`

Example

TeamAssignRoleSuccess

Types

TeamAssignRoleSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

TeamConnection

Fields

Field Name	Description
`edges` - `[TeamEdge!]!`	A list of edges.
`nodes` - `[Team!]!`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.

Example

{
  "edges": [TeamEdge],
  "nodes": [Team],
  "pageInfo": PageInfo
}

Types

TeamCreatePayload

Types

Union Types
`OrganizationDoesNotExistError`
`Team`
`TeamNameAlreadyTakenError`

Example

OrganizationDoesNotExistError

Types

TeamDeletePayload

Types

Union Types
`TeamDeleteSuccess`
`TeamDoesNotExistError`

Example

TeamDeleteSuccess

Types

TeamDeleteSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

TeamDoesNotExistError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

TeamEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination
`node` - `Team!`	The item at the end of the edge

Example

{
  "cursor": "abc123",
  "node": Team
}

Types

TeamNameAlreadyTakenError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

TeamRemoveMemberPayload

Types

Union Types
`TeamDoesNotExistError`
`TeamRemoveMemberSuccess`

Example

TeamDoesNotExistError

Types

TeamRemoveMemberSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

TeamRole

Values

Enum Value	Description
`MEMBER`
`ADMIN`

Example

"MEMBER"

Types

TokenDoesNotExistError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

TokenLimitExceededError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

TopClientByNameAndVersionOrderedByHighestCount

Fields

Field Name	Description
`count` - `Int!`
`name` - `String!`
`version` - `String!`

Example

{
  "count": 123,
  "name": "abc123",
  "version": "xyz789"
}

Types

TopClientByNameAndVersionOrderedByHighestErrorRatio

Fields

Field Name	Description
`count` - `Int!`
`errorCount` - `Int!`
`name` - `String!`
`version` - `String!`

Example

{
  "count": 987,
  "errorCount": 123,
  "name": "abc123",
  "version": "xyz789"
}

Types

TopClientByNameAndVersionOrderedByHighestLatency

Fields

Field Name	Description
`latencyMs` - `Int!`
`name` - `String!`
`version` - `String!`

Example

{
  "latencyMs": 987,
  "name": "abc123",
  "version": "xyz789"
}

Types

TopClientByNameOrderedByHighestCount

Fields

Field Name	Description
`count` - `Int!`
`name` - `String!`

Example

{"count": 987, "name": "abc123"}

Types

TopClientByNameOrderedByHighestErrorRatio

Fields

Field Name	Description
`count` - `Int!`
`errorCount` - `Int!`
`name` - `String!`

Example

{
  "count": 123,
  "errorCount": 123,
  "name": "abc123"
}

Types

TopClientByNameOrderedByHighestLatency

Fields

Field Name	Description
`latencyMs` - `Int!`
`name` - `String!`

Example

{"latencyMs": 123, "name": "xyz789"}

Types

TopClients

Fields

Field Name	Description
`byName` - `TopClientsByName!`
`byNameAndVersion` - `TopClientsByNameAndVersion!`

Example

{
  "byName": TopClientsByName,
  "byNameAndVersion": TopClientsByNameAndVersion
}

Types

TopClientsByName

Fields

Field Name	Description
`orderedByHighestCount` - `[TopClientByNameOrderedByHighestCount!]!`
`orderedByHighestErrorRatio` - `[TopClientByNameOrderedByHighestErrorRatio!]!`
`orderedByHighestLatency` - `[TopClientByNameOrderedByHighestLatency!]!`

Example

{
  "orderedByHighestCount": [
    TopClientByNameOrderedByHighestCount
  ],
  "orderedByHighestErrorRatio": [
    TopClientByNameOrderedByHighestErrorRatio
  ],
  "orderedByHighestLatency": [
    TopClientByNameOrderedByHighestLatency
  ]
}

Types

TopClientsByNameAndVersion

Fields

Field Name	Description
`orderedByHighestCount` - `[TopClientByNameAndVersionOrderedByHighestCount!]!`
`orderedByHighestErrorRatio` - `[TopClientByNameAndVersionOrderedByHighestErrorRatio!]!`
`orderedByHighestLatency` - `[TopClientByNameAndVersionOrderedByHighestLatency!]!`

Example

{
  "orderedByHighestCount": [
    TopClientByNameAndVersionOrderedByHighestCount
  ],
  "orderedByHighestErrorRatio": [
    TopClientByNameAndVersionOrderedByHighestErrorRatio
  ],
  "orderedByHighestLatency": [
    TopClientByNameAndVersionOrderedByHighestLatency
  ]
}

Types

TopClientsForField

Fields

Field Name	Description
`byName` - `TopClientsForFieldByName!`
`byNameAndVersion` - `TopClientsForFieldByNameAndVersion!`

Example

{
  "byName": TopClientsForFieldByName,
  "byNameAndVersion": TopClientsForFieldByNameAndVersion
}

Types

TopClientsForFieldByName

Fields

Field Name	Description
`orderedByHighestCount` - `[TopClientByNameOrderedByHighestCount!]!`

Example

{
  "orderedByHighestCount": [
    TopClientByNameOrderedByHighestCount
  ]
}

Types

TopClientsForFieldByNameAndVersion

Fields

Field Name	Description
`orderedByHighestCount` - `[TopClientByNameAndVersionOrderedByHighestCount!]!`

Example

{
  "orderedByHighestCount": [
    TopClientByNameAndVersionOrderedByHighestCount
  ]
}

Types

TopOperationByNameAndHashOrderedByHighestCount

Fields

Field Name	Description
`count` - `Int!`
`name` - `String!`
`normalizedQueryHash` - `OperationNormalizedQueryHash!`

Example

{
  "count": 987,
  "name": "xyz789",
  "normalizedQueryHash": OperationNormalizedQueryHash
}

Types

TopOperationByNameAndHashOrderedByHighestErrorRatio

Fields

Field Name	Description
`count` - `Int!`
`errorCount` - `Int!`
`name` - `String!`
`normalizedQueryHash` - `OperationNormalizedQueryHash!`

Example

{
  "count": 987,
  "errorCount": 987,
  "name": "xyz789",
  "normalizedQueryHash": OperationNormalizedQueryHash
}

Types

TopOperationByNameAndHashOrderedByHighestLatency

Fields

Field Name	Description
`latencyMs` - `Int!`
`name` - `String!`
`normalizedQueryHash` - `OperationNormalizedQueryHash!`

Example

{
  "latencyMs": 987,
  "name": "xyz789",
  "normalizedQueryHash": OperationNormalizedQueryHash
}

Types

TopOperationByNameOrderedByHighestCount

Fields

Field Name	Description
`count` - `Int!`
`name` - `String!`

Example

{"count": 987, "name": "abc123"}

Types

TopOperationByNameOrderedByHighestErrorRatio

Fields

Field Name	Description
`count` - `Int!`
`errorCount` - `Int!`
`name` - `String!`

Example

{
  "count": 987,
  "errorCount": 123,
  "name": "abc123"
}

Types

TopOperationByNameOrderedByHighestLatency

Fields

Field Name	Description
`latencyMs` - `Int!`
`name` - `String!`

Example

{"latencyMs": 123, "name": "xyz789"}

Types

TopOperations

Fields

Field Name	Description
`byName` - `TopOperationsByName!`
`byNameAndHash` - `TopOperationsByNameAndHash!`

Example

{
  "byName": TopOperationsByName,
  "byNameAndHash": TopOperationsByNameAndHash
}

Types

TopOperationsByName

Fields

Field Name	Description
`orderedByHighestCount` - `[TopOperationByNameOrderedByHighestCount!]!`
`orderedByHighestErrorRatio` - `[TopOperationByNameOrderedByHighestErrorRatio!]!`
`orderedByHighestLatency` - `[TopOperationByNameOrderedByHighestLatency!]!`

Example

{
  "orderedByHighestCount": [
    TopOperationByNameOrderedByHighestCount
  ],
  "orderedByHighestErrorRatio": [
    TopOperationByNameOrderedByHighestErrorRatio
  ],
  "orderedByHighestLatency": [
    TopOperationByNameOrderedByHighestLatency
  ]
}

Types

TopOperationsByNameAndHash

Fields

Field Name	Description
`orderedByHighestCount` - `[TopOperationByNameAndHashOrderedByHighestCount!]!`
`orderedByHighestErrorRatio` - `[TopOperationByNameAndHashOrderedByHighestErrorRatio!]!`
`orderedByHighestLatency` - `[TopOperationByNameAndHashOrderedByHighestLatency!]!`

Example

{
  "orderedByHighestCount": [
    TopOperationByNameAndHashOrderedByHighestCount
  ],
  "orderedByHighestErrorRatio": [
    TopOperationByNameAndHashOrderedByHighestErrorRatio
  ],
  "orderedByHighestLatency": [
    TopOperationByNameAndHashOrderedByHighestLatency
  ]
}

Types

Trace

Fields

Field Name	Description
`id` - `ID!`
`rootSpanId` - `ID!`
`spans` - `[TraceSpan!]!`

Example

{
  "id": "4",
  "rootSpanId": 4,
  "spans": [TraceSpan]
}

Types

TraceSpan

Fields

Field Name	Description
`attributes` - `JSON!`	Attributes are key-value pairs that represent additional information about the span. It's always a map of strings to strings.
`endedAt` - `DateTime!`
`id` - `ID!`
`name` - `String!`
`parentId` - `ID`
`startedAt` - `DateTime!`
`statusCode` - `TraceSpanStatusCode`

Example

{
  "attributes": {},
  "endedAt": "2007-12-03T10:15:30Z",
  "id": "4",
  "name": "abc123",
  "parentId": 4,
  "startedAt": "2007-12-03T10:15:30Z",
  "statusCode": "ERROR"
}

Types

TraceSpanStatusCode

Values

Enum Value	Description
`ERROR`
`OK`

Example

"ERROR"

Types

TrialPlanUnavailableError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

TrustedDocument

Fields

Field Name	Description
`documentId` - `String!`
`documentText` - `String!`

Example

{
  "documentId": "xyz789",
  "documentText": "xyz789"
}

Types

TrustedDocumentInput

Fields

Input Field	Description
`documentId` - `String!`
`documentText` - `String!`

Example

{
  "documentId": "xyz789",
  "documentText": "xyz789"
}

Types

TrustedDocumentsSubmitPayload

Types

Union Types
`GraphDoesNotExistError`
`OldAccessTokenError`
`ReusedIds`
`TrustedDocumentsSubmitSuccess`

Example

GraphDoesNotExistError

Types

TrustedDocumentsSubmitSuccess

Fields

Field Name	Description
`count` - `Int!`
`documents` - `[TrustedDocument!]!`

Example

{"count": 987, "documents": [TrustedDocument]}

Types

Upload

Example

Upload

Types

Url

Description

URL is a String implementing the URL Standard

Example

Url

Types

UsageFilters

Fields

Input Field	Description
`graphSlug` - `String`
`range` - `Duration`	Use this if you really care about having a specific duration like 1 hour, 7 days, etc.
`from` - `DateTime`	Use this if you at least the data between `from` and `to` to be provided. You may get more, but never less.
`to` - `DateTime!`	To be used in conjunction with with either `range` or `from`.
`isCustomRange` - `Boolean`	If explicitly to false, specifying both `from` and `to` will be treated as if `range: (to - from)` had been specified instead. Meaning only the duration between `from` and `to` matters, not necessarily having a data point for `from` itself.
`aggregationStep` - `Duration`	If specified, overrides approximateNumberOfPoints. Must be in whole minutes. At most 150 points can be returned.
`approximateNumberOfDataPoints` - `Int`	Defaults to 100, at most 150 points can be returned.
`alignPeriodWithAggregationStep` - `Boolean`	Defaults to true Example: for an aggregationStep of 15 min: if true, only times with 00, 15, 30 and 45 minutes will appear in the time series if false, times in the time series will be adjusted to start from the periodStart (~from). So if from = 15:32:00, times will end in 02, 17, 32 and 47. I'll always align to the aggregation step used to store the data though, which is currently in minutes. So cannot have 15:10:20, 15:11:20, etc.

Example

{
  "graphSlug": "xyz789",
  "range": "P3Y6M4DT12H30M5S",
  "from": "2007-12-03T10:15:30Z",
  "to": "2007-12-03T10:15:30Z",
  "isCustomRange": false,
  "aggregationStep": "P3Y6M4DT12H30M5S",
  "approximateNumberOfDataPoints": 987,
  "alignPeriodWithAggregationStep": false
}

Types

UsageMetrics

Fields

Field Name	Description
`requestsCount` - `Int!`
`spansCount` - `Int!`

Example

{"requestsCount": 987, "spansCount": 123}

Types

UsageMetricsTimeSeriesDataPoint

Fields

Field Name	Description
`dateTime` - `DateTime!`
`requestsCount` - `Int!`
`spansCount` - `Int!`

Example

{
  "dateTime": "2007-12-03T10:15:30Z",
  "requestsCount": 987,
  "spansCount": 987
}

Types

User

Fields

Field Name	Description
`avatarUrl` - `String`
`canStartNewTrial` - `Boolean!`
`createdAt` - `DateTime!`
`email` - `String!`
`id` - `ID!`
`name` - `String!`
`organizationMemberships` - `[Member!]!`
`organizations` - `OrganizationConnection!`
Arguments `after` - `String` `before` - `String` `first` - `Int` `last` - `Int`

Example

{
  "avatarUrl": "xyz789",
  "canStartNewTrial": true,
  "createdAt": "2007-12-03T10:15:30Z",
  "email": "abc123",
  "id": "4",
  "name": "xyz789",
  "organizationMemberships": [Member],
  "organizations": OrganizationConnection
}

Types

UserAccessTokensCannotBeScopedToAGraphError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

UserConnection

Fields

Field Name	Description
`edges` - `[UserEdge!]!`	A list of edges.
`nodes` - `[User!]!`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`

Example

{
  "edges": [UserEdge],
  "nodes": [User],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

UserDeletePayload

Types

Union Types
`OrganizationOwnershipNotTransferredError`
`UserDeleteSuccess`

Example

OrganizationOwnershipNotTransferredError

Types

UserDeleteSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

UserDoesNotExistError

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

UserEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination
`node` - `User!`	The item at the end of the edge
`role` - `TeamRole!`

Example

{
  "cursor": "abc123",
  "node": User,
  "role": "MEMBER"
}

Types

UserOrTeam

Types

Union Types
`Team`
`User`

Example

Team

Types

UserUpdateInput

Fields

Input Field	Description
`name` - `String!`

Example

{"name": "xyz789"}

Types

UserUpdatePayload

Types

Union Types
`NameSizeCheckError`
`UserUpdateSuccess`

Example

NameSizeCheckError

Types

UserUpdateSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

ValidationCheckError

Fields

Field Name	Description
`message` - `String!`
`title` - `String!`

Example

{
  "message": "xyz789",
  "title": "abc123"
}

Types

VersionedExtensionManifest

Example

VersionedExtensionManifest

Types

ZitadelAddRedirectFailure

Fields

Field Name	Description
`error` - `String`
`query` - `Query!`

Example

{
  "error": "xyz789",
  "query": Query
}

Types

ZitadelAddRedirectPayload

Types

Union Types
`NotEnterprisePlatformError`
`ZitadelAddRedirectFailure`
`ZitadelAddRedirectSuccess`

Example

NotEnterprisePlatformError

Types

ZitadelAddRedirectSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

ZitadelInitFailure

Fields

Field Name	Description
`error` - `String`
`query` - `Query!`

Example

{
  "error": "xyz789",
  "query": Query
}

Types

ZitadelInitPayload

Types

Union Types
`NotEnterprisePlatformError`
`ZitadelInitFailure`
`ZitadelInitSuccess`

Example

NotEnterprisePlatformError

Types

ZitadelInitSuccess

Fields

Field Name	Description
`query` - `Query!`

Example

{"query": Query}

Types

ZitadelStatus

Fields

Field Name	Description
`clientId` - `String`
`idp` - `Boolean!`
`organizationId` - `String`
`redirect` - `Boolean!`
`resources` - `Boolean!`

Example

{
  "clientId": "xyz789",
  "idp": true,
  "organizationId": "xyz789",
  "redirect": false,
  "resources": false
}

Documentation by Anvil SpectaQL