schema.web

Schema file

type

object

properties

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

  • isTemplateGeneratedByOspComposer

If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.

type

boolean

  • moduleId

The id of the web module

type

string

  • name

The name of the schema for web

type

string

  • displayedProperty

The property used to display and identify an entry in some front-end widgets

type

string

  • views

The views that defines column that can show one of the schema properties

type

array

items

SchemaView

additionalProperties

False

SchemaView

type

object

properties

  • id

ID for this view

type

string

  • name

Name for this view

type

string

  • isDefault

Is this view the default view for this schema

type

boolean

default

False

  • reorderable

Whether or not columns are reorderable

type

boolean

default

True

  • columns

The column that can show one of the schema properties

type

array

items

WebColumn

  • sort

The column sort settings

type

array

default

items

WebColumnSort

additionalProperties

False

WebColumn

type

object

properties

  • name

The column name

type

string

  • field

The field to display on this column

type

string

  • position

The column position

type

integer

  • display

Whether or not column is displayed by default

type

boolean

default

True

  • sortable

Whether or not column is sortable

type

boolean

default

True

  • filterable

Whether or not column is filterable

type

boolean

default

True

  • width

Column width

type

string

pattern

^(auto|(\d+)\s(px)|((100|\d{1,2})\s(\%))|\d+|)$

default

auto

  • minWidth

Column minimum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is lower than that an error will be generated.

type

integer

minimum

0

  • maxWidth

Column maximum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is greater than that an error will be generated.

type

integer

minimum

0

  • aggregate

Column summary aggregate function

type

string

enum

min, max, count, sum, avg

  • render

Column render function

type

string

enum

STRING, NUMBER, BOOLEAN, COLLECTION, SEVERITY, TAGS, ARRAY_COUNT, JOURNAL, TIMESTAMP, ELAPSED, FORM, URL, ICON, MARKDOWN

default

STRING

  • editor

Column editor component. Only available for CollectionTable widget.

type

string

enum

COLLECTION, SEVERITY, TIMESTAMP

  • options

Column options

additionalProperties

False

WebColumnSort

type

object

properties

  • field

The column field name

type

string

  • direction

The column name

type

string

enum

asc, desc

additionalProperties

False