🚀 Feature Proposal

Add "internal" to the stability tag or add a new tag to indicate APIs or properties that should not be externalized.

Motivation

There are some APIs for which we have specifications, but which we intentionally do not document. I think the intention is that those APIs are used internally (e.g. for Kibana) but might never be externalized. I think it might be something that should affect client code generation too.

Example

Here are some ML APIs that are currently intentionally undocumented:

• https://github.com/elastic/elasticsearch-specification/blob/main/specification/ml/validate/MlValidateJobRequest.ts
• https://github.com/elastic/elasticsearch-specification/blob/main/specification/ml/validate_detector/MlValidateDetectorRequest.ts

Per @jrodewig Elasticsearch has some intentionally undocumented REST APIs too (elastic/elasticsearch#76201). However, we currently don’t produce specs for them. It’d be great if we could provide consistent advice on how to handle this type of situation.