Feature request: Conditionally Required Fields

[er1c]

Consider this as a trite example:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "LoanOffer",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": ["none", "active"]
    },
    "rate": { "type": "number" },
    "termYears": { "type": "integer", "enum": [15, 30] },
    "rateType": {
      "type": "string",
      "enum": ["fixed", "adjustable"]
    },
    "introYears": { "type": "integer", "enum": [3, 5] },
    "creditScore": { "type": "integer", "minimum": 300 },
    "downPayment": { "type": "number", "minimum": 0 }
  },
  "required": ["status"],
  "allOf": [
    {
      "if": {
        "properties": { "status": { "const": "none" } }
      },
      "then": {
        "required": ["creditScore", "downPayment"]
      }
    },
    {
      "if": {
        "properties": { "status": { "const": "active" } }
      },
      "then": {
        "required": ["rate", "termYears", "rateType"]
      }
    },
    {
      "if": {
        "properties": { "rateType": { "const": "adjustable" } }
      },
      "then": {
        "required": ["introYears"],
        "properties": {
          "termYears": { "const": 30 }
        }
      },
      "else": {
        "not": { "required": ["introYears"] }
      }
    }
  ]
}

[lovasoa]

That would be very cool to have ! Pull request welcome, @er1c !

[chrisnovak]

+1

[er1c]

Some slightly hallucinated ChatGPT description

JSON Schema Editor - Conditional Logic Feature Mockups

Mockup 1: Adding Conditional Logic

Button:

• Add a clearly labeled button near the existing "Add Field" button:
  • "Add Conditional Logic" or "Add If-Then-Else"

Modal Window:

• Clicking the button opens a modal titled "Create Conditional Rule", structured into three sections:
  1. IF Condition
  2. THEN Requirements
  3. ELSE Requirements (optional)

Example UI Elements in Modal:

• IF Condition:

  • Dropdown to select a property (e.g., status).
  • Operator selection (e.g., equals, not equals, contains).
  • Input box for constant value (e.g., "active").

• THEN Requirements:

  • Checkboxes or multi-select dropdown to specify required fields.
  • Additional options to define property constraints (e.g., setting a property to a constant).

• ELSE Requirements:

  • Optional and collapsible.
  • Similar UI to the "THEN Requirements".

---

Mockup 2: Conditional Logic Summary View

• Below the main JSON schema editor, introduce a clearly defined section:
  • Label: "Conditional Rules"
• Each conditional rule provides a concise summary, for example:
  • "IF status equals 'active', THEN require fields: [rate, termYears, rateType]"
• Each rule includes quick actions:
  • Edit | Delete

---

Mockup 3: Editing Conditional Rules

• Selecting "Edit" on a conditional rule opens the same modal from Mockup 1, pre-filled with the rule's current values.
• Users can easily:
  • Modify conditions.
  • Adjust required properties.
  • Save or cancel changes.

---

Mockup 4: Enhanced JSON Schema Source View

• Visually highlight or indent the JSON Schema source to emphasize conditional logic structures (allOf, if, then, else).
• Include quick navigation icons or helpful tooltips to provide clarity on conditional rules directly within the JSON text editor.

---

These mockups outline a clear and intuitive user interface to effectively handle complex conditional logic within your JSON Schema editor.

Add Conditional Rule

[ Property ▼ ] [ Operator ▼ ] [ Value ▭▭▭▭▭▭ ] (e.g., country = "USA")

Then:
[ + Add Field Constraint ]
┌───────────────┬────────────┬────────────────────────┐
│ Property │ Constraint │ Value │
├───────────────┼────────────┼────────────────────────┤
│ postal_code │ pattern │ [0-9]{5}(-[0-9]{4})? │
└───────────────┴────────────┴────────────────────────┘

[+ Add Else Logic ▼]

Else:
[ + Add Field Constraint ]
┌───────────────┬────────────┬────────────────────────┐
│ Property │ Constraint │ Value │
├───────────────┼────────────┼────────────────────────┤
│ postal_code │ pattern │ [A-Z][0-9][A-Z] [0-9]...│
└───────────────┴────────────┴────────────────────────┘

[Cancel] [Add Rule]