Class: ExternalDocumentation
protoc_gen_openapiv2.options.ExternalDocumentation
ExternalDocumentation is a representation of OpenAPI v2 specification's
ExternalDocumentation object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#externalDocumentationObject
Example:
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { ... external_docs: { description: "More about gRPC-Gateway"; url: "https://github.com/grpc-ecosystem/grpc-gateway"; } ... };
Properties
description
• description: string
A short description of the target documentation. GFM syntax can be used for rich text representation.
url
• url: string
The URL for the target documentation. Value MUST be in the format of a URL.
Methods
toJSON
▸ toJSON(): Object
Converts this ExternalDocumentation to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ExternalDocumentation & $Properties
Creates a new ExternalDocumentation instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
ExternalDocumentation & $Properties
ExternalDocumentation instance
▸ create(properties?): ExternalDocumentation
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): ExternalDocumentation & $Properties
Decodes an ExternalDocumentation 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
ExternalDocumentation & $Properties
ExternalDocumentation
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ExternalDocumentation & $Properties
Decodes an ExternalDocumentation message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ExternalDocumentation & $Properties
ExternalDocumentation
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 ExternalDocumentation message. Does not implicitly grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ExternalDocumentation message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ExternalDocumentation message, length delimited. Does not implicitly grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ExternalDocumentation message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ExternalDocumentation
Creates an ExternalDocumentation message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ExternalDocumentation
toObject
▸ toObject(message, options?): Object
Creates a plain object from an ExternalDocumentation message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ExternalDocumentation | ExternalDocumentation |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object