Skip to content

Annotation for index setting type #2172

Closed
@jrodewig

Description

@jrodewig

🚀 Feature Proposal

An annotation to indicate the index setting type (dynamic or static).

Motivation

Lets us indicate the setting type during docs generation

Example

In IndexSettings.ts:

/**
 *  Mode for the index. Valid values are `time_series` and `null` (no mode).
 * @setting_type static
 * @server_default 30s
 */
mode?: string

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions