search

elastic / elasticsearch

Free and Open, Distributed, RESTful Search Engine
https://www.elastic.co/products/elasticsearch
Other
69.41k stars 24.56k forks source link

Documentation missing for Painless CIDR class #92921

Open danielharada opened 1 year ago

danielharada commented 1 year ago

Description

CIDR helper class was added to Painless API in https://github.com/elastic/elasticsearch/pull/69630, and then whitelisted in https://github.com/elastic/elasticsearch/pull/71258 (8.X) and https://github.com/elastic/elasticsearch/pull/71306 (7.X). Our 7.13 release highlights mention this class, and gives examples of its use: https://www.elastic.co/guide/en/elasticsearch/reference/7.13/release-highlights.html#match-ipv4-ipv6-addresses-against-cidr-ranges-painless

However, searching our Painless API docs, I can find no mention of it: https://www.elastic.co/guide/en/elasticsearch/painless/8.6/painless-api-reference-shared.html. The release highlights mentions that this class should be available in all contexts, so I assume it should exist in the Shared API section. I have been unsuccessful locating it in other locations as well.

Can we please add the CIDR class to our documentation beyond just the release highlights for an old version?

elasticsearchmachine commented 1 year ago

Pinging @elastic/es-core-infra (Team:Core/Infra)