Meet npm Pro: unlimited public & private packages + package-based permissions.Learn more »

outboard

2.13.0 • Public • Published

outboard

Build Status npm version

Simple API definitions for UI.

Data Structures

Here is the structures of outboard's API definitions:

Root

  • title (string, required)
  • description (string)
  • servers (array[Server], fixed)
  • tags (array[Tag], fixed)
  • structures (array[Structure], fixed)
  • actions (array[Action], fixed, required)

Server

  • url (string, required)

Tag

  • title (string, required)
  • description(string)
  • children (array[Tag], fixed)

Structure

  • id (string)
  • schema (Schema)
  • members (array[Structure Member], fixed)

Structure Member

  • key (string, required)
  • value (string)
  • description (string)
  • required (boolean, required)
  • members (array[Structure 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 (array[Parameter], fixed)
  • transactions (array[Transaction], fixed)
  • tags (array[string])

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 (array[Header], fixed)
  • example (string)
  • schema (Schema)

Response

  • statusCode (number, required)
  • title (string, required)
  • description(string)
  • contentType (string, required)
  • headers (array[Header], fixed)
  • example (string)
  • schema (Schema)

Install

npm i outboard

DownloadsWeekly Downloads

354

Version

2.13.0

License

MIT

Unpacked Size

39.9 kB

Total Files

15

Last publish

Collaborators

  • avatar