Flipdish · Schema

Field

Field schema from Flipdish API - Apps.

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name	Type	Description
Name	string
Description	string
Key	string
Tooltip	string
Position	integer
DefaultValue	string
ValidValues	array
ValidationRegex	string
FieldType	string
IsFlipdishRestricted	boolean

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/apps-field-schema.json",
  "title": "Field",
  "description": "Field schema from Flipdish API - Apps.",
  "type": "object",
  "properties": {
    "Name": {
      "type": "string",
      "example": "Example Name"
    },
    "Description": {
      "type": "string",
      "example": "string"
    },
    "Key": {
      "type": "string",
      "example": "string"
    },
    "Tooltip": {
      "type": "string",
      "example": "string"
    },
    "Position": {
      "format": "int32",
      "maximum": 1000,
      "minimum": 1,
      "type": "integer",
      "example": 1
    },
    "DefaultValue": {
      "type": "string",
      "example": "string"
    },
    "ValidValues": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ValidValue"
      },
      "example": []
    },
    "ValidationRegex": {
      "type": "string",
      "example": "string"
    },
    "FieldType": {
      "enum": [
        "Text",
        "TextArea",
        "Integer",
        "Decimal",
        "Date",
        "DateTime",
        "Time",
        "Select",
        "Boolean",
        "ActionButton"
      ],
      "type": "string",
      "example": "Text"
    },
    "IsFlipdishRestricted": {
      "type": "boolean",
      "nullable": true,
      "example": true
    }
  },
  "required": [
    "Name",
    "Description",
    "Key",
    "Position",
    "FieldType"
  ]
}