functional-models
    Preparing search index...

    Interface ApiInfoPartialRest

    An ApiInfo that has only part of RestInfo completed. (useful for overriding defaults)

    interface ApiInfoPartialRest {
        createOnlyOne: boolean;
        noPublish: boolean;
        onlyPublish: readonly ApiMethod[];
        rest: Partial<Record<ApiMethod, RestInfoMinimum>>;
    }
    Index

    Properties

    createOnlyOne noPublish onlyPublish rest

    Properties

    createOnlyOne: boolean

    Create normally can support bulk inserts (more than one). If this property is true, create will only handle "one" model at a time.

    noPublish: boolean

    If true, no api information should be published. This means, that no code-generation tool should produce any api code/documentation as it relates to this model. If you want partial publishing, look at "onlyPublish"

    onlyPublish: readonly ApiMethod[]

    Similar to noPublish, but granular. This will only publish the methods shown. If noPublish is provided, this will be empty. If onlyPublish is empty, and noPublish is false, then all methods will be published.

    rest: Partial<Record<ApiMethod, RestInfoMinimum>>

    Settings

    Member Visibility

    On This Page

    Properties