api-morph / LinkObject

Interface: LinkObject

Defined in: src/types/openapi.ts:872

The Link Object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.

See

https://spec.openapis.org/oas/v3.1.1#link-object

Indexable

[key: `x-${string}`]: any

This object MAY be extended with Specification Extensions.

Properties

description?

optional description: string

Defined in: src/types/openapi.ts:902

A description of the link. CommonMark syntax MAY be used for rich text representation.

---

operationId?

optional operationId: string

Defined in: src/types/openapi.ts:884

The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.

---

operationRef?

optional operationRef: string

Defined in: src/types/openapi.ts:878

A URI reference to an OAS operation. This field is mutually exclusive of the operationId field, and MUST point to an Operation Object. Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI Description.

---

parameters?

optional parameters: Record<string, any>

Defined in: src/types/openapi.ts:892

A map representing parameters to pass to an operation as specified with operationId or identified via operationRef. The key is the parameter name to be used (optionally qualified with the parameter location, e.g. path.id for an id parameter in the path), whereas the value can be a constant or an expression to be evaluated and passed to the linked operation.

---

requestBody?

optional requestBody: any

Defined in: src/types/openapi.ts:897

A literal value or expression to use as a request body when calling the target operation.

---

server?

optional server: ServerObject

Defined in: src/types/openapi.ts:907

A server object to be used by the target operation.