diff --git a/data/graphql/schema.graphql b/data/graphql/schema.graphql index 0af286259c..6451558546 100644 --- a/data/graphql/schema.graphql +++ b/data/graphql/schema.graphql @@ -4085,16 +4085,6 @@ type Mutation { input: OrganizationAPIIPAllowlistUpdateMutationInput! ): OrganizationAPIIPAllowlistUpdateMutationPayload - """ - Create a System banner within an organization - """ - organizationBannerCreate( - """ - Parameters for OrganizationBannerCreate - """ - input: OrganizationBannerCreateInput! - ): OrganizationBannerCreatePayload - """ Delete a System banner """ @@ -4106,14 +4096,16 @@ type Mutation { ): OrganizationBannerDeletePayload """ - Update System banner within an organization + Retrieves the active system banner for provided organization, then updates it + with input data. If active banner is not found, a new banner is created with + the provided input. """ - organizationBannerUpdate( + organizationBannerUpsert( """ - Parameters for OrganizationBannerUpdate + Parameters for OrganizationBannerUpsert """ - input: OrganizationBannerUpdateInput! - ): OrganizationBannerUpdatePayload + input: OrganizationBannerUpsertInput! + ): OrganizationBannerUpsertPayload """ Sets whether the organization requires two-factor authentication for all members. @@ -5380,30 +5372,6 @@ type OrganizationBannerConnection { pageInfo: PageInfo! } -""" -Autogenerated input type of OrganizationBannerCreate -""" -input OrganizationBannerCreateInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - message: String! - organizationId: ID! -} - -""" -Autogenerated return type of OrganizationBannerCreate. -""" -type OrganizationBannerCreatePayload { - banner: OrganizationBanner! - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - """ Autogenerated input type of OrganizationBannerDelete """ @@ -5442,21 +5410,21 @@ type OrganizationBannerEdge { } """ -Autogenerated input type of OrganizationBannerUpdate +Autogenerated input type of OrganizationBannerUpsert """ -input OrganizationBannerUpdateInput { +input OrganizationBannerUpsertInput { """ A unique identifier for the client performing the mutation. """ clientMutationId: String - id: ID! message: String! + organizationId: ID! } """ -Autogenerated return type of OrganizationBannerUpdate. +Autogenerated return type of OrganizationBannerUpsert. """ -type OrganizationBannerUpdatePayload { +type OrganizationBannerUpsertPayload { banner: OrganizationBanner! """ diff --git a/data/nav_graphql.yml b/data/nav_graphql.yml index aeb06207dc..4d6fca45d5 100644 --- a/data/nav_graphql.yml +++ b/data/nav_graphql.yml @@ -119,12 +119,10 @@ path: apis/graphql/schemas/mutation/organizationapiaccesstokenrevoke - name: organizationApiIpAllowlistUpdate path: apis/graphql/schemas/mutation/organizationapiipallowlistupdate - - name: organizationBannerCreate - path: apis/graphql/schemas/mutation/organizationbannercreate - name: organizationBannerDelete path: apis/graphql/schemas/mutation/organizationbannerdelete - - name: organizationBannerUpdate - path: apis/graphql/schemas/mutation/organizationbannerupdate + - name: organizationBannerUpsert + path: apis/graphql/schemas/mutation/organizationbannerupsert - name: organizationEnforceTwoFactorAuthenticationForMembersUpdate path: apis/graphql/schemas/mutation/organizationenforcetwofactorauthenticationformembersupdate - name: organizationInvitationCreate @@ -463,14 +461,12 @@ path: apis/graphql/schemas/object/organizationbanner - name: OrganizationBannerConnection path: apis/graphql/schemas/object/organizationbannerconnection - - name: OrganizationBannerCreatePayload - path: apis/graphql/schemas/object/organizationbannercreatepayload - name: OrganizationBannerDeletePayload path: apis/graphql/schemas/object/organizationbannerdeletepayload - name: OrganizationBannerEdge path: apis/graphql/schemas/object/organizationbanneredge - - name: OrganizationBannerUpdatePayload - path: apis/graphql/schemas/object/organizationbannerupdatepayload + - name: OrganizationBannerUpsertPayload + path: apis/graphql/schemas/object/organizationbannerupsertpayload - name: OrganizationConnection path: apis/graphql/schemas/object/organizationconnection - name: OrganizationEdge @@ -973,12 +969,10 @@ path: apis/graphql/schemas/input-object/organizationapiaccesstokenrevokemutationinput - name: OrganizationAPIIPAllowlistUpdateMutationInput path: apis/graphql/schemas/input-object/organizationapiipallowlistupdatemutationinput - - name: OrganizationBannerCreateInput - path: apis/graphql/schemas/input-object/organizationbannercreateinput - name: OrganizationBannerDeleteInput path: apis/graphql/schemas/input-object/organizationbannerdeleteinput - - name: OrganizationBannerUpdateInput - path: apis/graphql/schemas/input-object/organizationbannerupdateinput + - name: OrganizationBannerUpsertInput + path: apis/graphql/schemas/input-object/organizationbannerupsertinput - name: OrganizationEnforceTwoFactorAuthenticationForMembersUpdateMutationInput path: apis/graphql/schemas/input-object/organizationenforcetwofactorauthenticationformembersupdatemutationinput - name: OrganizationInvitationCreateInput diff --git a/pages/apis/graphql/schemas/input_object/organizationbannerupdateinput.md b/pages/apis/graphql/schemas/input_object/organizationbannerupdateinput.md deleted file mode 100644 index f973c055df..0000000000 --- a/pages/apis/graphql/schemas/input_object/organizationbannerupdateinput.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -# _____ ____ _ _ ____ _______ ______ _____ _____ _______ -# | __ / __ | | |/ __ __ __| | ____| __ _ _|__ __| -# | | | | | | | | | | | | | | | | |__ | | | || | | | -# | | | | | | | | . ` | | | | | | | __| | | | || | | | -# | |__| | |__| | | | | |__| | | | | |____| |__| || |_ | | -# |_____/ ____/ |_| _|____/ |_| |______|_____/_____| |_| -# This file is auto-generated by script/generate_graphql_api_content.sh, -# please build the schema.json by running `rails api:graph:export` -# with https://github.com/buildkite/buildkite/, -# replace the content in data/graphql_data_schema.json -# and run the generation script `./scripts/generate-graphql-api-content.sh`. - -title: OrganizationBannerUpdateInput – Input_objects – GraphQL API -toc: false ---- - -
INPUT_OBJECT
-
- Input Fields- |
-
-
-
---|
A unique identifier for the client performing the mutation. |
|
|
INPUT_OBJECT
OrganizationBannerCreatePayload
-
-
-
- Arguments- |
-
-
-
---|
|
OrganizationBannerUpdatePayload
+ organizationBannerUpsert
+
+ OrganizationBannerUpsertPayload
|
|
agentStop
AgentStopPayload
Instruct an agent to stop accepting new build jobs and shut itself down.
|
agentTokenCreate
AgentTokenCreatePayload
Create a new agent registration token.
|
agentTokenRevoke
AgentTokenRevokePayload
Revoke an agent registration token.
|
apiAccessTokenCodeAuthorize
APIAccessTokenCodeAuthorizeMutationPayload
Authorize an API Access Token Code generated by an API Application. Please note this mutation is private and cannot be executed externally.
|
buildAnnotate
BuildAnnotatePayload
Annotate a build with information to appear on the build page.
|
buildCancel
BuildCancelPayload
Cancel a build.
|
buildCreate
BuildCreatePayload
Create a build.
|
buildRebuild
BuildRebuildPayload
Rebuild a build.
|
clusterAgentTokenCreate
ClusterAgentTokenCreatePayload
Create a new cluster agent token
|
clusterAgentTokenRevoke
ClusterAgentTokenRevokePayload
Revokes a cluster agent token
|
clusterAgentTokenUpdate
ClusterAgentTokenUpdatePayload
Updates a cluster agent token
|
clusterCreate
ClusterCreatePayload
Create a cluster.
|
clusterDelete
ClusterDeletePayload
Delete a cluster.
|
clusterQueueCreate
ClusterQueueCreatePayload
Create a cluster queue.
|
clusterQueueDelete
ClusterQueueDeletePayload
Delete a cluster queue.
|
clusterQueuePauseDispatch
ClusterQueuePauseDispatchPayload
This will prevent dispatch of jobs to agents on this queue. You can add an optional note describing the reason for pausing.
|
clusterQueueResumeDispatch
ClusterQueueResumeDispatchPayload
This will resume dispatch of jobs on this queue.
|
clusterQueueUpdate
ClusterQueueUpdatePayload
Updates a cluster queue.
|
clusterUpdate
ClusterUpdatePayload
Updates a cluster.
|
emailCreate
EmailCreatePayload
Add a new email address for the current user
|
emailResendVerification
EmailResendVerificationPayload
Resend a verification email.
|
graphQLSnippetCreate
GraphQLSnippetCreatePayload
Create a GraphQL snippet.
|
jobTypeBlockUnblock
JobTypeBlockUnblockPayload
Unblocks a build's "Block pipeline" job.
|
jobTypeCommandCancel
JobTypeCommandCancelPayload
Cancel a job.
|
jobTypeCommandRetry
JobTypeCommandRetryPayload
Retry a job.
|
noticeDismiss
NoticeDismissPayload
Dismisses a notice from the Buildkite UI. This mutation is idempotent so if you dismiss the same notice multiple times, it will return the original dismissedAt
time
|
organizationApiAccessTokenRevoke
OrganizationAPIAccessTokenRevokeMutationPayload
Revokes access to an organization for a user's API access token. The organization can not be re-added to the same token, however the user can create a new token and add the organization to that token.
|
organizationApiIpAllowlistUpdate
OrganizationAPIIPAllowlistUpdateMutationPayload
Sets an allowlist of IP addresses for API access to an organization. Please note that this is a beta feature and is not yet available to all organizations.
|
organizationBannerCreate
OrganizationBannerCreatePayload
Create a System banner within an organization
|
organizationBannerDelete
OrganizationBannerDeletePayload
Delete a System banner
|
organizationBannerUpdate
OrganizationBannerUpdatePayload
Update System banner within an organization
|
organizationEnforceTwoFactorAuthenticationForMembersUpdate
OrganizationEnforceTwoFactorAuthenticationForMembersUpdateMutationPayload
Sets whether the organization requires two-factor authentication for all members.
|
organizationInvitationCreate
OrganizationInvitationCreatePayload
Send email invitations to this organization.
|
organizationInvitationResend
OrganizationInvitationResendPayload
Resend an organization invitation email.
|
organizationInvitationRevoke
OrganizationInvitationRevokePayload
Revoke an invitation to an organization so that it can no longer be accepted.
|
organizationMemberDelete
OrganizationMemberDeletePayload
Remove a user from an organization.
|
organizationMemberUpdate
OrganizationMemberUpdatePayload
Change a user's role within an organization.
|
organizationRevokeInactiveTokensAfterUpdate
OrganizationRevokeInactiveTokensAfterUpdateMutationPayload
Specify the maximum timeframe to revoke organization access from inactive API tokens.
|
pipelineArchive
PipelineArchivePayload
Archive a pipeline.
|
pipelineCreate
PipelineCreatePayload
Create a pipeline.
|
pipelineCreateWebhook
PipelineCreateWebhookPayload
Create SCM webhooks for a pipeline.
|
pipelineDelete
PipelineDeletePayload
Delete a pipeline.
|
pipelineFavorite
PipelineFavoritePayload
Favorite a pipeline.
|
pipelineRotateWebhookURL
PipelineRotateWebhookURLPayload
Rotate a pipeline's webhook URL. Note that the old webhook URL will stop working immediately and so must be updated quickly to avoid interruption.
|
pipelineScheduleCreate
PipelineScheduleCreatePayload
Create a scheduled build on pipeline.
|
pipelineScheduleDelete
PipelineScheduleDeletePayload
Delete a scheduled build on pipeline.
|
pipelineScheduleUpdate
PipelineScheduleUpdatePayload
Update a scheduled build on pipeline.
|
pipelineUnarchive
PipelineUnarchivePayload
Unarchive a pipeline.
|
pipelineUpdate
PipelineUpdatePayload
Change the settings for a pipeline.
|
ssoProviderCreate
SSOProviderCreatePayload
Create a SSO provider.
|
ssoProviderDelete
SSOProviderDeletePayload
Delete a SSO provider.
|
ssoProviderDisable
SSOProviderDisablePayload
Disable a SSO provider.
|
ssoProviderEnable
SSOProviderEnablePayload
Enable a SSO provider.
|
ssoProviderUpdate
SSOProviderUpdatePayload
Change the settings for a SSO provider.
|
teamCreate
TeamCreatePayload
Create a team.
|
teamDelete
TeamDeletePayload
Delete a team.
|
teamMemberCreate
TeamMemberCreatePayload
Add a user to a team.
|
teamMemberDelete
TeamMemberDeletePayload
Remove a user from a team.
|
teamMemberUpdate
TeamMemberUpdatePayload
Update a user's role in a team.
|
teamPipelineCreate
TeamPipelineCreatePayload
Add a pipeline to a team.
|
teamPipelineDelete
TeamPipelineDeletePayload
Remove a pipeline from a team.
|
teamPipelineUpdate
TeamPipelineUpdatePayload
Update a pipeline's access level within a team.
|
teamSuiteCreate
TeamSuiteCreatePayload
Add a suite to a team.
|
teamSuiteDelete
TeamSuiteDeletePayload
Remove a suite from a team.
|
teamSuiteUpdate
TeamSuiteUpdatePayload
Update a suite's access level within a team.
|
teamUpdate
TeamUpdatePayload
Change the settings for a team.
|
totpActivate
TOTPActivatePayload
Activate a previously-generated TOTP configuration, and its Recovery Codes. Once activated, both this TOTP configuration, and the associated Recovery Codes will become active for the user. Any previous TOTP configuration or Recovery Codes will no longer be usable. This mutation is private, requires an escalated session, and cannot be accessed via the public GraphQL API.
|
totpCreate
TOTPCreatePayload
Create a new TOTP configuration for the current user. This will produce a TOTP configuration with an associated set of Recovery Codes. The Recovery Codes must be presented to the user prior to the TOTP's activation with totpActivate
. Neither TOTP configuration nor Recovery Codes will be usable until they have been activated. This mutation is private, requires an escalated session, and cannot be accessed via the public GraphQL API.
|
totpDelete
TOTPDeletePayload
Delete a TOTP configuration. If a TOTP configuration was active, it will no longer be used for logging on to the user's account. Any Recovery Codes associated with the TOTP configuration will also no longer be usable. This mutation is private, requires an escalated session, and cannot be accessed via the public GraphQL API.
|
totpRecoveryCodesRegenerate
TOTPRecoveryCodesRegeneratePayload
Generate a new set of Recovery Codes for a given TOTP. The new Recovery Codes will immediately replace any existing recovery codes. This mutation is private, requires an escalated session, and cannot be accessed via the public GraphQL API.
|
agentStop
AgentStopPayload
Instruct an agent to stop accepting new build jobs and shut itself down.
|
agentTokenCreate
AgentTokenCreatePayload
Create a new agent registration token.
|
agentTokenRevoke
AgentTokenRevokePayload
Revoke an agent registration token.
|
apiAccessTokenCodeAuthorize
APIAccessTokenCodeAuthorizeMutationPayload
Authorize an API Access Token Code generated by an API Application. Please note this mutation is private and cannot be executed externally.
|
buildAnnotate
BuildAnnotatePayload
Annotate a build with information to appear on the build page.
|
buildCancel
BuildCancelPayload
Cancel a build.
|
buildCreate
BuildCreatePayload
Create a build.
|
buildRebuild
BuildRebuildPayload
Rebuild a build.
|
clusterAgentTokenCreate
ClusterAgentTokenCreatePayload
Create a new cluster agent token
|
clusterAgentTokenRevoke
ClusterAgentTokenRevokePayload
Revokes a cluster agent token
|
clusterAgentTokenUpdate
ClusterAgentTokenUpdatePayload
Updates a cluster agent token
|
clusterCreate
ClusterCreatePayload
Create a cluster.
|
clusterDelete
ClusterDeletePayload
Delete a cluster.
|
clusterQueueCreate
ClusterQueueCreatePayload
Create a cluster queue.
|
clusterQueueDelete
ClusterQueueDeletePayload
Delete a cluster queue.
|
clusterQueuePauseDispatch
ClusterQueuePauseDispatchPayload
This will prevent dispatch of jobs to agents on this queue. You can add an optional note describing the reason for pausing.
|
clusterQueueResumeDispatch
ClusterQueueResumeDispatchPayload
This will resume dispatch of jobs on this queue.
|
clusterQueueUpdate
ClusterQueueUpdatePayload
Updates a cluster queue.
|
clusterUpdate
ClusterUpdatePayload
Updates a cluster.
|
emailCreate
EmailCreatePayload
Add a new email address for the current user
|
emailResendVerification
EmailResendVerificationPayload
Resend a verification email.
|
graphQLSnippetCreate
GraphQLSnippetCreatePayload
Create a GraphQL snippet.
|
jobTypeBlockUnblock
JobTypeBlockUnblockPayload
Unblocks a build's "Block pipeline" job.
|
jobTypeCommandCancel
JobTypeCommandCancelPayload
Cancel a job.
|
jobTypeCommandRetry
JobTypeCommandRetryPayload
Retry a job.
|
noticeDismiss
NoticeDismissPayload
Dismisses a notice from the Buildkite UI. This mutation is idempotent so if you dismiss the same notice multiple times, it will return the original dismissedAt
time
|
organizationApiAccessTokenRevoke
OrganizationAPIAccessTokenRevokeMutationPayload
Revokes access to an organization for a user's API access token. The organization can not be re-added to the same token, however the user can create a new token and add the organization to that token.
|
organizationApiIpAllowlistUpdate
OrganizationAPIIPAllowlistUpdateMutationPayload
Sets an allowlist of IP addresses for API access to an organization. Please note that this is a beta feature and is not yet available to all organizations.
|
organizationBannerDelete
OrganizationBannerDeletePayload
Delete a System banner
|
organizationBannerUpsert
OrganizationBannerUpsertPayload
Retrieves the active system banner for provided organization, then updates it with input data. If active banner is not found, a new banner is created with the provided input.
|
organizationEnforceTwoFactorAuthenticationForMembersUpdate
OrganizationEnforceTwoFactorAuthenticationForMembersUpdateMutationPayload
Sets whether the organization requires two-factor authentication for all members.
|
organizationInvitationCreate
OrganizationInvitationCreatePayload
Send email invitations to this organization.
|
organizationInvitationResend
OrganizationInvitationResendPayload
Resend an organization invitation email.
|
organizationInvitationRevoke
OrganizationInvitationRevokePayload
Revoke an invitation to an organization so that it can no longer be accepted.
|
organizationMemberDelete
OrganizationMemberDeletePayload
Remove a user from an organization.
|
organizationMemberUpdate
OrganizationMemberUpdatePayload
Change a user's role within an organization.
|
organizationRevokeInactiveTokensAfterUpdate
OrganizationRevokeInactiveTokensAfterUpdateMutationPayload
Specify the maximum timeframe to revoke organization access from inactive API tokens.
|
pipelineArchive
PipelineArchivePayload
Archive a pipeline.
|
pipelineCreate
PipelineCreatePayload
Create a pipeline.
|
pipelineCreateWebhook
PipelineCreateWebhookPayload
Create SCM webhooks for a pipeline.
|
pipelineDelete
PipelineDeletePayload
Delete a pipeline.
|
pipelineFavorite
PipelineFavoritePayload
Favorite a pipeline.
|
pipelineRotateWebhookURL
PipelineRotateWebhookURLPayload
Rotate a pipeline's webhook URL. Note that the old webhook URL will stop working immediately and so must be updated quickly to avoid interruption.
|
pipelineScheduleCreate
PipelineScheduleCreatePayload
Create a scheduled build on pipeline.
|
pipelineScheduleDelete
PipelineScheduleDeletePayload
Delete a scheduled build on pipeline.
|
pipelineScheduleUpdate
PipelineScheduleUpdatePayload
Update a scheduled build on pipeline.
|
pipelineUnarchive
PipelineUnarchivePayload
Unarchive a pipeline.
|
pipelineUpdate
PipelineUpdatePayload
Change the settings for a pipeline.
|
ssoProviderCreate
SSOProviderCreatePayload
Create a SSO provider.
|
ssoProviderDelete
SSOProviderDeletePayload
Delete a SSO provider.
|
ssoProviderDisable
SSOProviderDisablePayload
Disable a SSO provider.
|
ssoProviderEnable
SSOProviderEnablePayload
Enable a SSO provider.
|
ssoProviderUpdate
SSOProviderUpdatePayload
Change the settings for a SSO provider.
|
teamCreate
TeamCreatePayload
Create a team.
|
teamDelete
TeamDeletePayload
Delete a team.
|
teamMemberCreate
TeamMemberCreatePayload
Add a user to a team.
|
teamMemberDelete
TeamMemberDeletePayload
Remove a user from a team.
|
teamMemberUpdate
TeamMemberUpdatePayload
Update a user's role in a team.
|
teamPipelineCreate
TeamPipelineCreatePayload
Add a pipeline to a team.
|
teamPipelineDelete
TeamPipelineDeletePayload
Remove a pipeline from a team.
|
teamPipelineUpdate
TeamPipelineUpdatePayload
Update a pipeline's access level within a team.
|
teamSuiteCreate
TeamSuiteCreatePayload
Add a suite to a team.
|
teamSuiteDelete
TeamSuiteDeletePayload
Remove a suite from a team.
|
teamSuiteUpdate
TeamSuiteUpdatePayload
Update a suite's access level within a team.
|
teamUpdate
TeamUpdatePayload
Change the settings for a team.
|
totpActivate
TOTPActivatePayload
Activate a previously-generated TOTP configuration, and its Recovery Codes. Once activated, both this TOTP configuration, and the associated Recovery Codes will become active for the user. Any previous TOTP configuration or Recovery Codes will no longer be usable. This mutation is private, requires an escalated session, and cannot be accessed via the public GraphQL API.
|
totpCreate
TOTPCreatePayload
Create a new TOTP configuration for the current user. This will produce a TOTP configuration with an associated set of Recovery Codes. The Recovery Codes must be presented to the user prior to the TOTP's activation with totpActivate
. Neither TOTP configuration nor Recovery Codes will be usable until they have been activated. This mutation is private, requires an escalated session, and cannot be accessed via the public GraphQL API.
|
totpDelete
TOTPDeletePayload
Delete a TOTP configuration. If a TOTP configuration was active, it will no longer be used for logging on to the user's account. Any Recovery Codes associated with the TOTP configuration will also no longer be usable. This mutation is private, requires an escalated session, and cannot be accessed via the public GraphQL API.
|
totpRecoveryCodesRegenerate
TOTPRecoveryCodesRegeneratePayload
Generate a new set of Recovery Codes for a given TOTP. The new Recovery Codes will immediately replace any existing recovery codes. This mutation is private, requires an escalated session, and cannot be accessed via the public GraphQL API.
|
OBJECT
-
- Fields- |
-
-
-
---|
|
|
OBJECT