Define a schema field

Usage

field(
  name,
  description = name,
  type = c("string", "number", "integer", "boolean", "array", "object"),
  required = TRUE
)

Arguments

name: Optional Character: The name of the field.
description: Optional Character: A brief description of the field.
type: Character {"string", "number", "integer", "boolean", "array", "object"}: The field type.
required: Logical: Whether the field is required.

Value

Field object

Author

EDG

Examples

# `type` defaults to "string", `required` defaults to TRUE
field("lab_name", "Name of the lab test")
#> lab_name: 
#>                  type: string
#>           description: Name of the lab test
#>              required: TRUE
#>  
field("normal_range_low", "Lower bound of normal range", type = "number")
#> normal_range_low: 
#>                          type: number
#>                   description: Lower bound of normal range
#>                      required: TRUE
#>