Interface IServer

The remote server that provides the API.

interface IServer {
    description?: string;
    url: string;
    variables?: Record<string, OpenApi.IServer.IVariable>;
}

Index

Properties

description? url variables?

Properties

`Optional`description

description?: string

An optional string describing the target server.

url

url: string

A URL to the target host.

`Optional`variables

variables?: Record<string, OpenApi.IServer.IVariable>

A map between a variable name and its value.

When the server url is a type of template, this property would be utilized to fill the template with actual values.