Flipdish · JSON Structure

Apps Field Structure

Field schema from Flipdish API - Apps.

Type: object Properties: 10 Required: 5

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Field is a JSON Structure definition published by Flipdish, describing 10 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Name Description Key Tooltip Position DefaultValue ValidValues ValidationRegex FieldType IsFlipdishRestricted

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-structure/apps-field-structure.json",
  "name": "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": {
      "maximum": 1000,
      "minimum": 1,
      "type": "int32",
      "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"
  ]
}