Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Swagger

Hierarchy

Index

Constructors

constructor

Properties

blockedConnectionTypes

blockedConnectionTypes: Array<string>

Are there connections from any servers which cannot use this Action (default: [])?

description

description: string

The description of the Action (default this.name)

inputs

inputs: Inputs

The inputs of the Action (default: {})

logLevel

logLevel: string

Under what level should connections to this Action be logged (default 'info')?

matchExtensionMimeType

matchExtensionMimeType: boolean

If this Action is responding to a web request, and that request has a file extension like *.jpg, should Actionhero set the response headers to match that extension (default: true)?

middleware

middleware: Array<string>

The Middleware specific to this Action (default: []). Middleware is described by the string names of the middleware.

name

name: string

The name of the Action

outputExample

outputExample: object

toDocument

toDocument: boolean

Should this Action appear in api.documentation.documentation? (default: true)?

version

version: number | string

The version of this Action (default: 1)

Methods

buildSwaggerPaths

  • buildSwaggerPaths(): { swaggerPaths: {}; tags: any[] }
  • Returns { swaggerPaths: {}; tags: any[] }

    • swaggerPaths: {}
    • tags: any[]

getLatestAction

  • getLatestAction(route: any): any
  • Parameters

    • route: any

    Returns any

run

  • run(data: any): Promise<void>
  • Parameters

    • data: any

    Returns Promise<void>

validate

  • validate(): void
  • Returns void

Generated using TypeDoc