OpenSpecInfo

@tsed/openspec

Usage

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

See /packages/specs/openspec/src/common/OpenSpecInfo.ts.

Overview

interface OpenSpecInfo {
    title: string;
    version: string;
    description?: string;
    termsOfService?: string;
    contact?: OpenSpecContact;
    license?: OpenSpecLicense;
}

title

title: string;

The title of the application.

version

version: string;

The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).

description

description?: string;

A short description of the application. CommonMark syntax MAY be used for rich text representation.

termsOfService

termsOfService?: string;

A URL to the Terms of Service for the API. MUST be in the format of a URL.

contact

contact?: OpenSpecContact;

The contact information for the exposed API.

license

license?: OpenSpecLicense;

The license information for the exposed API.