Class: Response

protoc_gen_openapiv2.options.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

Implements

• IResponse

Constructors

constructor

• new Response(properties?): Response

Constructs a new Response.

Parameters

Name	Type	Description
properties?	IResponse	Properties to set

Returns

Response

Properties

description

• description: string

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

Implementation of

IResponse.description

---

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

Implementation of

IResponse.examples

---

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]: IValue

Implementation of

IResponse.extensions

---

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]: IHeader

Implementation of

IResponse.headers

---

schema

• Optional schema: null | ISchema

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

Implementation of

IResponse.schema

Methods

toJSON

▸ toJSON(): Object

Converts this Response to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): Response

Creates a new Response instance using the specified properties.

Parameters

Name	Type	Description
properties?	IResponse	Properties to set

Returns

Response

Response instance

---

decode

▸ decode(reader, length?): Response

Decodes a Response message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

Response

Response

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): Response

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

Response

Response

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IResponse	Response message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ 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

Name	Type	Description
message	IResponse	Response message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): Response

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

Response

Response

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Response

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	Response	Response
options?	IConversionOptions	Conversion options

Returns

Object

Plain object