yaschema-api
    Preparing search index...

    Interface Api

    A generic API description. See HttpApi

    interface Api {
        deprecated?: string | boolean;
        description?: string;
        example?: string;
        isYaschemaApi: true;
        name: string;
        routeType: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    deprecated? description? example? isYaschemaApi name routeType

    Properties

    deprecated?: string | boolean

    If true or a string, use of this Api is deprecated and usage should be discontinued as soon as possible. A string value may be used to document why the deprecation occurred and/or preferred upgrade strategies and APIs.

    description?: string

    A description, which can be used by code generation tools to generate documentation

    example?: string

    An example, which can be used by code generation tools to generate documentation

    isYaschemaApi: true
    name: string

    A name that can be used to describe this API, when logging for example

    routeType: string

    The type of route, which will be used to select a URL base and is configurable using setUrlBaseForRouteType

    Settings

    Member Visibility

    On This Page

    Properties