Skip to content

[ES|QL] Publish command status as JSON #122057

@drewdaemon

Description

@drewdaemon
Contributor

Description

The ES|QL editor needs to know whether commands have been released (snapshot-only) and whether they are in tech preview or not. Right now this relies on cross-team communication which is not foolproof.

Our proposal is to give control to Elasticsearch much like we do with the function definitions. Each command can have a corresponding JSON file which could look something like the following:

{
  "name": "LOOKUP JOIN",
  "preview" : true,
  "snapshot_only" : false,
  "docs_markdown": "..."
}

We can scrape this metadata in our weekly CI job and update the editor behavior for each command.

Including the docs would be nice because that would allow them to be automatically added to the editor's inline documentation, just as the functions are today.

cc @nik9000 for a feasibility check.

Activity

added
Team:AnalyticsMeta label for analytical engine team (ESQL/Aggs/Geo)
and removed
needs:triageRequires assignment of a team area label
on Feb 7, 2025
elasticsearchmachine

elasticsearchmachine commented on Feb 7, 2025

@elasticsearchmachine
Collaborator

Pinging @elastic/es-analytical-engine (Team:Analytics)

elasticsearchmachine

elasticsearchmachine commented on Feb 7, 2025

@elasticsearchmachine
Collaborator

Pinging @elastic/kibana-esql (ES|QL-ui)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @drewdaemon@elasticsearchmachine

        Issue actions

          [ES|QL] Publish command status as JSON · Issue #122057 · elastic/elasticsearch