Q3
  • Introduction
  • Related Projects
  • Roadmap
  • API
    • Core
      • Rest
      • Session
      • Schema plugins
    • Schemas
      • Rates
      • Rebates
      • Permissions
    • Utils
      • Subdocuments
      • Soft deleting
  • Client
    • gatsby-theme-q3
    • q3-components
      • Quantity
    • q3-ui-cart
      • Drawer
    • Admin
      • Builders
      • Containers
        • Contexts
    • Datatables
      • TableBadge
    • Forms
      • Field
      • Presets
        • <PasswordChange />
    • Repeater
    • UI
      • CallToAction
      • Avatar
      • CollapsiblePanel
      • SubMenu
Powered by GitBook
On this page
  • Schema Path Options
  • Schema Settings Options

Was this helpful?

  1. API
  2. Core

Schema plugins

Custom attributes and types for powering up your schema

PreviousSessionNextSchemas

Last updated 5 years ago

Was this helpful?

Q3 auto-installs a few important plugins on all its models. These help you to solve common tasks quickly, such as locking property values and auto-populating references. For more information on how each plugin works, view the "Related Projects" page.

Schema Path Options

Property

Value

Description

lock

Boolean

Once set, a locked property cannot be changed.

searchable

Boolean

It will consider the field's value in all search queries (via q3-core-rest). Internally, the REST controller simply calls the "searchBuilder" static appended to all registered models.

systemOnly

Boolean

Controls the value's mutability over the API.

Schema Settings Options

Option

Value

Description

restify

String

See the "" section for more information

collectionPluralName

String

Same as above

collectionSingularName

String

Same as above

Rest