ColdBox Relax
  • Introduction
  • Overview
  • Changelog
  • Installation
  • Getting Started
  • Relax Documentation Formats
    • OpenAPI (AKA Swagger)
    • Relax Programmatic DSL (Deprecated)
      • Resources
        • Parameters
        • Placeholders
        • Headers
      • Schemas & Samples
    • Import and Export Formats
  • cbSwagger Companion Module
  • Swagger SDK
Powered by GitBook
On this page
  • Placeholders
  • Arguments
  • Set All Placeholders
  • Arguments
Edit on GitHub
  1. Relax Documentation Formats
  2. Relax Programmatic DSL (Deprecated)
  3. Resources

Placeholders

Placeholders

Add a placeholder to a resource

Arguments

Argument

Type

Required

Default

Description

name

any

Yes

---

The name of the placeholder

description

any

No

The description of the placeholder

required

any

No

false

Is the placeholder required

default

any

No

The default value of the placeholder

type

any

No

string

The type of the placeholder

Set All Placeholders

Set all the required placeholders of a resource

Arguments

Argument

Type

Required

Default

Description

placeholders

array

Yes

---

Set the placeholders of a resource

PreviousParametersNextHeaders

Last updated 7 years ago