Skip to main content

RestParameters

@webda/core


Interface: RestParameters

Defined in: packages/core/src/core/icore.ts:27

REST transport parameters for use with @Operation<RestParameters>()

Properties​

rest?​

optional rest?: false | { body?: string; method: "get" | "post" | "put" | "delete" | "patch"; path: string; responses?: {[statusCode: string]: object; }; }

Defined in: packages/core/src/core/icore.ts:31

REST

Union Members​

false


Type Literal​

{ body?: string; method: "get" | "post" | "put" | "delete" | "patch"; path: string; responses?: {[statusCode: string]: object; }; }

body?​

optional body?: string

Method parameter receiving the whole JSON body.

method​

method: "get" | "post" | "put" | "delete" | "patch"

path​

path: string

responses?​

optional responses?: object

Index Signature​

[statusCode: string]: object