@tsed/openspec/src/openspec3/OS3Server.ts

OpenSpec2 and OpenSpec3 interfaces declarations for TypeScript application

import {OpenSpecHash} from "../common/OpenSpecHash.js";

export interface OpenSpecServerVariable {
  /**
   * An enumeration of string values to be used if the substitution options are from a limited set.
   */
  enum?: string;
  /**
   * The default value to use for substitution, and to send, if an alternate value is not supplied. Unlike the Schema Object's default, this value MUST be provided by the consumer.
   */
  default: string;
  /**
   * An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.
   */
  description?: string;
}

export interface OS3Server {
  /**
   * 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}`.
   */
  url: string;
  /**
   * An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.
   */
  description: string;
  /**
   * A map between a variable name and its value. The value is used for substitution in the server's URL template.
   */
  variables?: OpenSpecHash<OpenSpecServerVariable>;
}