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
  • Schemas
  • Arguments
  • Samples
  • Arguments
Edit on GitHub
  1. Relax Documentation Formats
  2. Relax Programmatic DSL (Deprecated)

Schemas & Samples

Schemas

Append a schema to a resource

Arguments

Argument

Type

Required

Default

Description

format

any

Yes

---

The format of the schema

description

any

No

The description of the schema

body

any

No

The body contents of the schema

Samples

Append a sample to a resource

Arguments

Argument

Type

Required

Default

Description

format

any

Yes

---

The format of the sample

description

any

No

The description of the sample

body

any

No

The body contents of the sample

PreviousHeadersNextImport and Export Formats

Last updated 7 years ago