OS3Server

@tsed/openspec

Usage

import { OS3Server } from "@tsed/openspec";

See /packages/specs/openspec/src/types/openspec3/OS3Server.ts.

Overview

interface OS3Server {
    url: string;
    description: string;
    variables?: OpenSpecHash<OpenSpecServerVariable>;
}

url

url: string;

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 OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.

description

description: string;

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

variables

variables?: OpenSpecHash<OpenSpecServerVariable>;

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