Interface: LinkSchema¶

A schema representing a return value or object property that is a hyperlink.

The link can be displayed in the UI in multiple ways, as per the above enumeration.

Extends¶

codaType: Url

Instructs Superhuman Docs to render this value as a hyperlink.

BaseStringSchema.codaType

optional description: string

A explanation of this object schema property shown to the user in the UI.

If your pack has an object schema with many properties, it may be useful to explain the purpose or contents of any property that is not self-evident.

BaseStringSchema.description

optional display: LinkDisplayType

How the URL should be displayed in the UI.

optional force: boolean

Whether to force client embedding (only for LinkDisplayType.Embed) - for example, if user login required.

type: String

Identifies this schema as a string.

BaseStringSchema.type