CompassApi
CompassRequests
api
compass-api
compound-types
graphql-types

Rate this page:

@atlassian/forge-graphql / compound-types / UpdateComponentInput

Interface: UpdateComponentInput

compound-types.UpdateComponentInput

Hierarchy

Properties

currentComponent

Optional currentComponent: Component

The existing component to be updated. This saves one call to getComponent.

Defined in

compound-types.ts:189


dataManager

Optional dataManager: DataManagerInput

The external integration that manages data for this component.

Inherited from

BaseComponentInput.dataManager

Defined in

compound-types.ts:104


description

Optional description: string

The description of the component.

Inherited from

BaseComponentInput.description

Defined in

compound-types.ts:90


eventSources

Optional eventSources: (CreateEventSourceInput | EventSource)[]

The updated collection of eventSources to assign to the component.

Overrides

BaseComponentInput.eventSources

Defined in

compound-types.ts:193


externalAlias

Optional externalAlias: CompassExternalAliasInput

The event sources associated to the component.

Inherited from

BaseComponentInput.externalAlias

Defined in

compound-types.ts:106


fields

Optional fields: Record<string, string[]>

A collection of fields for storing data about the component. Where the key is the name in the field definition and the value is the CompassFieldValueInput.

Inherited from

BaseComponentInput.fields

Defined in

compound-types.ts:94


id

id: string

The ID of the component being updated.

Defined in

compound-types.ts:187


labels

Optional labels: string[]

A collection of labels that provide additional contextual information about the component.

Inherited from

BaseComponentInput.labels

Defined in

compound-types.ts:102


Optional links: (CreateLinkInput | Link)[]

The updated collection of links to assign to the component.

Overrides

BaseComponentInput.links

Defined in

compound-types.ts:191


name

Optional name: string

The name of the component.

Inherited from

BaseComponentInput.name

Defined in

compound-types.ts:88


ownerId

Optional ownerId: string

The unique identifier (ID) of the team that owns the component.

Inherited from

BaseComponentInput.ownerId

Defined in

compound-types.ts:96


relationships

Optional relationships: Relationship[]

A collection of relationships between the component and other entities in Compass.

Inherited from

BaseComponentInput.relationships

Defined in

compound-types.ts:100

Rate this page: