Catalyst Squad hello world example api 1.0.1

API definition for the Hello World end-to-end example from Catalyst Squad

Resources

hello

Operations

Method and Path Description
GET /helloes
POST /helloes

Headers

No headers

Imports

No imports

Enums

No enums

Interfaces

No interfaces

Models

hello

Example Json: Minimal | Full

Interfaces: None

A Hello with a name and id

Field Type Required? Default Description
id uuid Yes -

The ID of the hello.

name string Yes -

The name to hello

Example: Jane

newhello

Example Json: Minimal | Full

Interfaces: None

A Hello that has not yet been created

Field Type Required? Default Description
name string Yes -

The name to hello

Example: Jane

Unions

No unions

Annotations

No annotations