Skip to main content

Class: Response

Response is a representation of OpenAPI v2 specification's Response object.

See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#responseObject

Properties​

description​

description: string

Description is a short description of the response. GFM syntax can be used for rich text representation.

examples​

examples: object

Examples gives per-mimetype response examples. See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object

Index Signature​

[k: string]: string

extensions​

extensions: object

Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification. See: https://swagger.io/docs/specification/2-0/swagger-extensions/

Index Signature​

[k: string]: $Properties

headers​

headers: object

Headers A list of headers that are sent with the response. Header name is expected to be a string in the canonical format of the MIME header key See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey

Index Signature​

[k: string]: $Properties

schema?​

optional schema?: $Properties | null

Schema optionally defines the structure of the response. If Schema is not provided, it means there is no content to the response.

Methods​

toJSON()​

toJSON(): object

Converts this Response to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Response & $Shape

Creates a new Response instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

Response & $Shape

Response instance

Call Signature​

static create(properties?): Response

Creates a new Response instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Response

Response instance

decode()​

static decode(reader, length?): Response & $Shape

Decodes a Response message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

Response & $Shape

Response

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Response & $Shape

Decodes a Response message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Response & $Shape

Response

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified Response message. Does not implicitly grpc.gateway.protoc_gen_openapiv2.options.Response.verify|verify messages.

Parameters​

message​

$Properties

Response message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified Response message, length delimited. Does not implicitly grpc.gateway.protoc_gen_openapiv2.options.Response.verify|verify messages.

Parameters​

message​

$Properties

Response message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Response

Creates a Response message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

Response

Response

toObject()​

static toObject(message, options?): object

Creates a plain object from a Response message. Also converts values to other types if specified.

Parameters​

message​

Response

Response

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object