Add sampling config specifications

[seanzatzdev]

This adds the specification for the endpoints for PUT {index}/_sample/config, GET {index}/_sample/config, GET _sample/config , and DELETE {index}/_sample/config

[Copilot]

Pull Request Overview

This PR adds comprehensive API specifications for sampling configuration management in Elasticsearch. It introduces four new endpoints for creating, retrieving, and deleting sampling configurations for indices, enabling users to configure random sampling of documents with parameters like sample rate, size limits, retention periods, and conditional filtering.

Key changes:

• Added PUT endpoint for creating/updating sampling configurations with configurable rate, max samples, size limits, TTL, and conditional scripts
• Added GET endpoints for retrieving single and all index sampling configurations
• Added DELETE endpoint for removing sampling configurations

Reviewed Changes

Copilot reviewed 20 out of 20 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
IndicesPutSampleConfigurationRequest.ts	Defines request structure for creating/updating sampling configs with validation constraints
IndicesPutSampleConfigurationResponse.ts	Response type returning acknowledgment for PUT operations
IndicesGetSampleConfigurationRequest.ts	Request structure for retrieving single index sampling config
IndicesGetSampleConfigurationResponse.ts	Response containing index name and configuration (nullable)
IndicesGetAllSampleConfigurationRequest.ts	Request structure for retrieving all sampling configs
IndicesGetAllSampleConfigurationResponse.ts	Response containing array of index configurations
IndexSamplingConfiguration.ts	Type definition pairing index name with its configuration
IndicesDeleteSampleConfigurationRequest.ts	Request structure for deleting sampling config
IndicesDeleteSampleConfigurationResponse.ts	Response returning acknowledgment for DELETE operations
SampleConfigurationOutput.ts	Core type defining sampling configuration structure with both human-readable and raw numeric fields
Request/response example YAML files	Example payloads demonstrating API usage
types.ts	Generated TypeScript interface definitions
schema.json	Generated JSON schema with API metadata and type definitions

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[github-actions]

Following you can find the validation changes against the target branch for the APIs.

API	Status	Request	Response
indices.delete_sample_configuration	🟠 → 🟢	Missing type → 15/15	Missing type → 15/15
indices.get_all_sample_configuration	🟠 → 🟢	Missing type → 8/8	Missing type → 8/8
indices.get_sample_configuration	🟠 → 🟢	Missing type → 10/10	Missing type → 10/10
indices.put_sample_configuration	🟠 → 🟢	Missing type → 52/52	Missing type → 52/52

You can validate these APIs yourself by using the make validate target.

[masseyke]

or data stream

[masseyke]

I left one very minor comment, but looks good to me.

[JoshMock]

A couple (hopefully simple) questions, but this is great overall.

[JoshMock]

If the string in this union is just a string representation of a double, you should use the Stringified<double> utility type instead.

[JoshMock]

What is the format of these if strings? Painless?