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
  • Param
  • Set All Params
  • Arguments
Edit on GitHub
  1. Relax Documentation Formats
  2. Relax Programmatic DSL (Deprecated)
  3. Resources

Parameters

Param

Add a param to a resource

Arguments

Argument

Type

Required

Default

Description

name

any

Yes

---

The name of the param

description

any

No

The description of the param

required

any

No

false

Is the param required

default

any

No

The default value of the param

type

any

No

string

The type of the param

Set All Params

Set all the required parameters of a resource

Arguments

Argument

Type

Required

Default

Description

params

array

Yes

---

Set the parameters of a resource

PreviousResourcesNextPlaceholders

Last updated 7 years ago