Hive Api
ReferenceGuide
Root
Query
Mutation
OutputObject
AssignMemberRoleResult
AssignMemberRoleResultError
AssignMemberRoleResultOk
CdnAccessToken
CdnAccessTokenCreateResult
CdnAccessTokenCreateResultError
CdnAccessTokenCreateResultOk
ClientStats
ClientStatsValues
ClientStatsValuesConnection
ClientStatsValuesEdge
CompositeSchema
ConditionalBreakingChangeConfiguration
Contract
ContractCheck
ContractCheckConnection
ContractCheckEdge
ContractConnection
ContractEdge
ContractVersion
ContractVersionConnection
ContractVersionEdge
CreateContractInputErrors
CreateContractResult
CreateContractResultError
CreateContractResultOk
CreateMemberRoleInputErrors
CreateMemberRoleResult
CreateMemberRoleResultError
CreateMemberRoleResultOk
CreateOrganizationAccessTokenResult
CreateOrganizationAccessTokenResultError
CreateOrganizationAccessTokenResultErrorDetails
CreateOrganizationAccessTokenResultOk
CreateProjectInputErrors
CreateProjectResult
CreateProjectResultError
CreateProjectResultOk
CreateTargetResult
CreateTargetResultError
CreateTargetResultOk
DateRange
DeleteCdnAccessTokenResult
DeleteCdnAccessTokenResultError
DeleteCdnAccessTokenResultOk
DeleteMemberRoleResult
DeleteMemberRoleResultError
DeleteMemberRoleResultOk
DeleteOrganizationAccessTokenResult
DeleteOrganizationAccessTokenResultError
DeleteOrganizationAccessTokenResultOk
DeleteOrganizationInvitationResult
DeleteOrganizationInvitationResultError
DeleteOrganizationInvitationResultOk
DeleteProjectResult
DeleteProjectResultError
DeleteProjectResultOk
DeleteTargetResult
DeleteTargetResultError
DeleteTargetResultOk
DeletedSchemaLog
DisableContractResult
DisableContractResultError
DisableContractResultOk
DurationValues
FailedSchemaCheck
InviteToOrganizationByEmailInputErrors
InviteToOrganizationByEmailResult
InviteToOrganizationByEmailResultError
InviteToOrganizationByEmailResultOk
Member
MemberConnection
MemberEdge
MemberRole
MemberRoleConnection
MemberRoleEdge
Operation
OperationStatsValues
OperationStatsValuesConnection
OperationStatsValuesEdge
OperationsStats
Organization
OrganizationAccessToken
OrganizationAccessTokenConnection
OrganizationAccessTokenEdge
OrganizationInvitation
OrganizationInvitationConnection
OrganizationInvitationEdge
PageInfo
Permission
PermissionGroup
Project
ProjectConnection
ProjectEdge
ProjectResourceAssignment
ProjectTargetsResourceAssignment
PushedSchemaLog
ResourceAssignment
SchemaChange
SchemaChangeConnection
SchemaChangeEdge
SchemaChangeUsageStatistics
SchemaChangeUsageStatisticsAffectedClient
SchemaChangeUsageStatisticsAffectedOperation
SchemaCheckConditionalBreakingChangeMetadata
SchemaCheckConditionalBreakingChangeMetadataUsage
SchemaCheckConnection
SchemaCheckEdge
SchemaCheckMeta
SchemaConnection
SchemaCoordinateStats
SchemaEdge
SchemaError
SchemaErrorConnection
SchemaErrorEdge
SchemaVersion
SchemaVersionConnection
SchemaVersionEdge
SingleSchema
SuccessfulSchemaCheck
Target
TargetAppDeploymentsResourceAssignment
TargetCdnAccessTokenConnection
TargetCdnAccessTokenEdge
TargetConnection
TargetEdge
TargetResouceAssignment
TargetServicesResourceAssignment
UpdateMemberRoleInputErrors
UpdateMemberRoleResult
UpdateMemberRoleResultError
UpdateMemberRoleResultOk
UpdateProjectSlugError
UpdateProjectSlugOk
UpdateProjectSlugResult
UpdateTargetConditionalBreakingChangeConfigurationResult
UpdateTargetConditionalBreakingChangeConfigurationResultError
UpdateTargetConditionalBreakingChangeConfigurationResultOk
UpdateTargetDangerousChangeClassificationResult
UpdateTargetDangerousChangeClassificationResultError
UpdateTargetDangerousChangeClassificationResultOk
UpdateTargetGraphQLEndpointUrlResult
UpdateTargetGraphQLEndpointUrlResultError
UpdateTargetGraphQLEndpointUrlResultOk
User
InputObject
AppDeploymentResourceAssignmentInput
AssignMemberRoleInput
ConditionalBreakingChangeConfigurationInput
ContractReferenceInput
CreateCdnAccessTokenInput
CreateContractInput
CreateMemberRoleInput
CreateOrganizationAccessTokenInput
CreateProjectInput
CreateTargetInput
DateRangeInput
DeleteCdnAccessTokenInput
DeleteMemberRoleInput
DeleteOrganizationAccessTokenInput
DeleteOrganizationInvitationInput
DeleteProjectInput
DeleteTargetInput
DisableContractInput
InviteToOrganizationByEmailInput
MemberReferenceInput
MemberRoleReferenceInput
OperationStatsFilterInput
OrganizationAccessTokenReference
OrganizationReferenceInput
OrganizationSelectorInput
ProjectReferenceInput
ProjectResourceAssignmentInput
ProjectSelectorInput
ProjectTargetsResourceAssignmentInput
ResourceAssignmentInput
ServiceResourceAssignmentInput
TargetAppDeploymentsResourceAssignmentInput
TargetReferenceInput
TargetResourceAssignmentInput
TargetSelectorInput
TargetServicesResourceAssignmentInput
UpdateMemberRoleInput
UpdateProjectSlugInput
UpdateTargetConditionalBreakingChangeConfigurationInput
UpdateTargetDangerousChangeClassificationInput
UpdateTargetGraphQLEndpointUrlInput
Interface
SchemaCheck
Union
RegistryLog
Schema
Enum
AuthProviderType
BreakingChangeFormulaType
ProjectType
GraphQLOperationType
PermissionLevelType
ResourceAssignmentModeType
SeverityLevelType
ScalarCustom
DateTime
SafeInt
ScalarStandard
String
ID
Float
Boolean
Int

Mutation

Fields

Create a CDN access token for a target.

createCdnAccessToken(
input: CreateCdnAccessTokenInput!

Alias describing the purpose of the access token.

alias: String!

The target for which the access token should be created for.

target: TargetReferenceInput!
): CdnAccessTokenCreateResult!

Create a contract for a given target.

createContract(
input: CreateContractInput!
contractName: String!
excludeTags: [String!]
includeTags: [String!]
removeUnreachableTypesFromPublicApiSchema: Boolean!
): CreateContractResult!
createMemberRole(
input: CreateMemberRoleInput!
description: String!
name: String!
selectedPermissions: [String!]!
): CreateMemberRoleResult!
createOrganizationAccessToken(
input: CreateOrganizationAccessTokenInput!
description: String
permissions: [String!]!
title: String!
): CreateOrganizationAccessTokenResult!
createProject(
input: CreateProjectInput!
slug: String!
): CreateProjectResult!

Create a new target within an existing project.

createTarget(
input: CreateTargetInput!

Reference to the project in which the target should be created in.

project: ProjectReferenceInput!

Slug of the target, must be unique per project.

slug: String!
): CreateTargetResult!

Delete a CDN access token.

deleteCdnAccessToken(
input: DeleteCdnAccessTokenInput!
cdnAccessTokenId: ID!
): DeleteCdnAccessTokenResult!
deleteMemberRole(
input: DeleteMemberRoleInput!
): DeleteMemberRoleResult!
deleteOrganizationAccessToken(
input: DeleteOrganizationAccessTokenInput!
organizationAccessToken: OrganizationAccessTokenReference!
): DeleteOrganizationAccessTokenResult!
deleteOrganizationInvitation(
input: DeleteOrganizationInvitationInput!
email: String!
): DeleteOrganizationInvitationResult!
deleteProject(
input: DeleteProjectInput!
): DeleteProjectResult!

Delete a target.

deleteTarget(
input: DeleteTargetInput!

Reference to the target that should be deleted.

target: TargetReferenceInput!
): DeleteTargetResult!

Disable a contract.

disableContract(
input: DisableContractInput!
): DisableContractResult!
inviteToOrganizationByEmail(
input: InviteToOrganizationByEmailInput!
email: String!
memberRoleId: ID
): InviteToOrganizationByEmailResult!
updateMemberRole(
input: UpdateMemberRoleInput!
description: String!

The member role that should be udpated.

memberRole: MemberRoleReferenceInput!
name: String!
selectedPermissions: [String!]!
): UpdateMemberRoleResult!
updateProjectSlug(
input: UpdateProjectSlugInput!
slug: String!
): UpdateProjectSlugResult!

Update the conditional breaking change configuration of a target.

updateTargetConditionalBreakingChangeConfiguration(
input: UpdateTargetConditionalBreakingChangeConfigurationInput!

Updates to the conditional breaking change configuration.

conditionalBreakingChangeConfiguration: ConditionalBreakingChangeConfigurationInput!

The target on which the settings are adjusted.

target: TargetReferenceInput!
): UpdateTargetConditionalBreakingChangeConfigurationResult!

Update the targets dangerous change classification settings. This allows dangerous changes fail schema checks.

updateTargetDangerousChangeClassification(
input: UpdateTargetDangerousChangeClassificationInput!
failDiffOnDangerousChange: Boolean!
): UpdateTargetDangerousChangeClassificationResult!

Updates the target's explorer endpoint url.

updateTargetGraphQLEndpointUrl(
input: UpdateTargetGraphQLEndpointUrlInput!
graphqlEndpointUrl: String
): UpdateTargetGraphQLEndpointUrlResult!