api-morph / ServerObject

Interface: ServerObject

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

An object representing a Server.

See

https://spec.openapis.org/oas/v3.1.1#server-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:199

An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.

---

url

url: string

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

REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the document containing the Server Object is being served. Variable substitutions will be made when a variable is named in {braces}.

---

variables?

optional variables: Record<string, ServerVariableObject>

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

A map between a variable name and its value. The value is used for substitution in the server's URL template.