outboard v2.13.0

outboard

Simple API definitions for UI.

Data Structures

Here is the structures of outboard's API definitions:

Root

• title (string, required)
• description (string)
• servers (arrayServer, fixed)
• tags (arrayTag, fixed)
• structures (arrayStructure, fixed)

• actions (arrayAction, fixed, required)

Server

• url (string, required)

Tag

• title (string, required)
• description(string)
• children (arrayTag, fixed)

Structure

• id (string)
• schema (Schema)
• members (arrayStructure Member, fixed)

Structure Member

• key (string, required)
• value (string)
• description (string)
• required (boolean, required)
• members (arrayStructure Member Ref)
• schema (Schema)

Structure Member Ref

• ref (string)

Action

• title (string, required)
• description(string)
• path (string, required)
• pathTemplate (string, required)
• slug (string, required)
• method (string, required)
• parameters (arrayParameter, fixed)
• transactions (arrayTransaction, fixed)
• tags (arraystring)

Parameter

• location (string, required)
• name (string, required)
• description (string)
• required (boolean, required)
• example (string)
• schema (Parameter Schema, fixed)

Parameter Schema

• type (string, required)
• enum (string)

Transaction

• request (Request)
• response (Response)

Schema

• type (string, required)

Header

• name (string, required)
• example (string)
• required (boolean, required)
• schema (Schema)

Request

• title (string, required)
• description(string)
• contentType (string, required)
• headers (arrayHeader, fixed)
• example (string)
• schema (Schema)

Response

• statusCode (number, required)
• title (string, required)
• description(string)
• contentType (string, required)
• headers (arrayHeader, fixed)
• example (string)
• schema (Schema)