Skip to contents

Configure JSON Schema validation for an endpoint

Usage

payload_schema_config(path, schema)

Arguments

path

The URL path to configure schema validation for

schema

JSON Schema as a character string, list, or path to a schema file. Pass NULL to remove schema validation.

Value

Invisibly returns TRUE, called for side effects

Examples

if (interactive()) {
  # Set JSON Schema for validation
  payload_schema_config("/api/data", '{
    "type": "object",
    "required": ["name", "value"],
    "properties": {
      "name": {"type": "string"},
      "value": {"type": "number"}
    }
  }')

  # Remove schema validation
  payload_schema_config("/api/data", NULL)
}