Interface OS3Server

# Interface OS3Server

Interface
Module
import { OS3Server } from "@tsed/openspec"
Source/packages/specs/openspec/src/types/openspec3/OS3Server.ts

# Overview

interface OS3Server {

url<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>

description<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>

variables?<span class="token punctuation">:</span> <a href="/api/specs/openspec/types/common/OpenSpecHash.html"><span class="token">OpenSpecHash</span></a>&lt;<a href="/api/specs/openspec/types/openspec3/OpenSpecServerVariable.html"><span class="token">OpenSpecServerVariable</span></a>&gt;<span class="token punctuation">;</span>

}

# Members

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: string;

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

variables?: OpenSpecHash<OpenSpecServerVariable>;

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