yaschema-api-openapi
    Preparing search index...

    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;
    }
    Index

    Properties

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

    Properties

    contactEmail?: string
    contactName?: string
    contactUrl?: string
    description?: string
    externalDocs?: UrlInfo
    licenseIdentifier?: string

    An SPDX license expression for the API

    licenseName: string
    licenseUrl?: string
    serverInfo?: ParameterizedUrlInfo[]
    skipApis?: Api[]

    OpenApi schemas won't be generated for these APIs

    skipApisForRouteTypes?: string[]

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

    summary?: string
    termsOfServiceUrl?: string
    title: string
    version: string

    Settings

    Member Visibility

    On This Page

    Properties