Interface OpenSpecInfo

Interface

Module	import { OpenSpecInfo } from "@tsed/openspec"
Source	/packages/specs/openspec/src/types/common/OpenSpecInfo.ts

Overview

interface OpenSpecInfo {
title<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>

version<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>

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

contact?<span class="token punctuation">:</span> <a href="/api/specs/openspec/types/common/OpenSpecContact.html"><span class="token">OpenSpecContact</span></a><span class="token punctuation">;</span>

license?<span class="token punctuation">:</span> <a href="/api/specs/openspec/types/common/OpenSpecLicense.html"><span class="token">OpenSpecLicense</span></a><span class="token punctuation">;</span>
}

Members

title: string;

The title of the application.

---

version: string;

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

---

description?: string;

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

---

termsOfService?: string;

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

---

contact?: OpenSpecContact;

The contact information for the exposed API.

---

license?: OpenSpecLicense;

The license information for the exposed API.