Interface ApiSchemaOptions

interface ApiSchemaOptions {
    contactEmail?: string;
    contactName?: string;
    contactUrl?: string;
    description?: string;
    externalDocs?: UrlInfo;
    licenseIdentifier?: string;
    licenseName: string;
    licenseUrl?: string;
    serverInfo?: ParameterizedUrlInfo[];
    skipApis?: Api[];
    skipApisForRouteTypes?: string[];
    summary?: string;
    termsOfServiceUrl?: string;
    title: string;
    version: string;
}

Properties

contactEmail? contactName? contactUrl? description? externalDocs? licenseIdentifier? licenseName licenseUrl? serverInfo? skipApis? skipApisForRouteTypes? summary? termsOfServiceUrl? title version

Properties

OptionalcontactEmail

contactEmail?: string

OptionalcontactName

contactName?: string

OptionalcontactUrl

contactUrl?: string

Optionaldescription

description?: string

OptionalexternalDocs

externalDocs?: UrlInfo

OptionallicenseIdentifier

licenseIdentifier?: string

An SPDX license expression for the API

licenseName

licenseName: string

OptionallicenseUrl

licenseUrl?: string

OptionalserverInfo

serverInfo?: ParameterizedUrlInfo[]

OptionalskipApis

skipApis?: Api[]

OpenApi schemas won't be generated for these APIs

OptionalskipApisForRouteTypes

skipApisForRouteTypes?: string[]

OpenApi schemas won't be generated for APIs matching any of these route types

Optionalsummary

summary?: string

OptionaltermsOfServiceUrl

termsOfServiceUrl?: string

title

title: string

version

version: string

Settings

Member Visibility

On This Page

Properties