Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ES|QL: make use of FunctionInfo.preview on the documentation side #112755

Closed
astefan opened this issue Sep 11, 2024 · 4 comments
Closed

ES|QL: make use of FunctionInfo.preview on the documentation side #112755

astefan opened this issue Sep 11, 2024 · 4 comments
Assignees
Labels
:Analytics/ES|QL AKA ESQL >enhancement Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo)

Comments

@astefan
Copy link
Contributor

astefan commented Sep 11, 2024

Description

Functions' FunctionInfo annotation has a preview component for functions that are still in preview/snapshot. But, this is not reflected in how the documentation is generated (if a function is in preview/snapshot-only mode it should be in the docs) nor is how this part is exposed to Kibana. We should look into:

  • do we need a snapshot-only component to FunctionInfo or preview() is enough?
  • integrate either preview() or a snapshot-only component in the above mentioned places in code.
@elasticsearchmachine elasticsearchmachine added the Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) label Sep 11, 2024
@elasticsearchmachine
Copy link
Collaborator

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

@luigidellaquila
Copy link
Contributor

Snapshot functions are not in the docs (neither in Kibana JSON docs), so I guess the only information we need is the "preview".

Separately, if we also want Kibana to receive Snapshot functions, we can add another information, but they are two distinct things.

@luigidellaquila
Copy link
Contributor

@astefan @drewdaemon #113544 is merged, so now we have both "preview" and "snapshot_only" info exposed.
Is there anything still missing? Should we close this issue?

@drewdaemon
Copy link
Contributor

Things are good from our side.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Analytics/ES|QL AKA ESQL >enhancement Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo)
Projects
None yet
Development

No branches or pull requests

4 participants