ComponentDefinition

@prismatic-io/spectral"types"ComponentDefinition

Defines attributes of a Component.

Hierarchy#

  • ComponentDefinition

Index#

Properties#

Properties#

actions#

actions: Record‹string, ActionDefinition

Specifies the supported Actions of this Component.


Optional authorization#

authorization? : AuthorizationDefinition

Specifies Authorization settings, if applicable


display#

display: ComponentDisplayDefinition

Defines how the Component is displayed in the Prismatic interface.


Optional documentationUrl#

documentationUrl? : undefined | string

Specified the URL for the Component Documentation.


key#

key: string

Specifies unique key for this Component.


Optional public#

public? : undefined | false | true

Specifies if this Component is available for all Organizations or only your own @default false


version#

version: string

Version of the Component.