YQueue DocsDevelopers

Schema

OCI Configuration

Represents the order collection identifier (OCI) configuration for a given service type.

  • Services

Overview

object · 5 properties · 0 required

Properties

enabled

boolean

Indicates if OCIs are enabled.

required

boolean

Indicates if OCIs are required.

display_name

string

The display name that should be used when referencing OCIs within the ordering workflow.

Example Table Number
Min length 1
Max length 255

icon

enum

The icon that should be displayed when referencing the OCI within the ordering workflow.

Allowed values

tablebuzzertent_card

force_numeric

boolean

Indicates if only numberic inputs are permitted.

Used by

Raw YAML
Download source
title: OCI Configuration
x-tags:
  - Services
type: object
description: Represents the order collection identifier (OCI) configuration for a given service type.
properties:
  enabled:
    type: boolean
    description: Indicates if OCIs are enabled.
  required:
    type: boolean
    description: Indicates if OCIs are required.
  display_name:
    type: string
    minLength: 1
    maxLength: 255
    description: The display name that should be used when referencing OCIs within the ordering workflow.
    example: Table Number
  icon:
    enum:
      - table
      - buzzer
      - tent_card
    description: The icon that should be displayed when referencing the OCI within the ordering workflow.
  force_numeric:
    type: boolean
    description: Indicates if only numberic inputs are permitted.

Search documentation

Search across this documentation site.