Skip to main content

Component

@prismatic-io/spectral"types/server-types"Component

Defines attributes of a Component.

Hierarchy#

  • Component

Index#

Properties#

Properties#

actions#

actions: Record‹string, Action

Defined in types/server-types.ts:34

Specifies the supported Actions of this Component.


Optional authorization#

authorization? : AuthorizationDefinition

Defined in types/server-types.ts:32

Specifies Authorization settings, if applicable


display#

display: ComponentDisplayDefinition

Defined in types/server-types.ts:28

Defines how the Component is displayed in the Prismatic interface.


Optional documentationUrl#

documentationUrl? : undefined | string

Defined in types/server-types.ts:36

Specified the URL for the Component Documentation.


key#

key: string

Defined in types/server-types.ts:24

Specifies unique key for this Component.


Optional public#

public? : undefined | false | true

Defined in types/server-types.ts:26

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


Optional version#

version? : undefined | string

Defined in types/server-types.ts:30

deprecated Version of the Component.