Add spec and docs for new logs streams endpoints #5258
+284
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds the new logs streams endpoints to the Elasticsearch specification, including API definitions for enabling, disabling, and checking the status of logs streams functionality.
- Adds TypeScript interface definitions for three new logs streams endpoints
- Includes comprehensive example files for requests and responses with various status codes
- Updates the tsconfig.json to include the new streams module path mapping
Reviewed Changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| specification/tsconfig.json | Adds path mapping for the new @streams/* module |
| specification/streams/status/StreamsStatusRequest.ts | Defines the GET _streams/status endpoint interface |
| specification/streams/status/StreamsStatusResponse.ts | Defines response structure for streams status endpoint |
| specification/streams/logs_enable/StreamsLogsEnableRequest.ts | Defines the POST _streams/logs/_enable endpoint interface |
| specification/streams/logs_enable/StreamsLogsEnableResponse.ts | Defines response structure for logs enable endpoint |
| specification/streams/logs_disable/StreamsLogsDisableRequest.ts | Defines the POST _streams/logs/_disable endpoint interface |
| specification/streams/logs_disable/StreamsLogsDisableResponse.ts | Defines response structure for logs disable endpoint |
| Various example files | Provides request/response examples for all endpoints including error cases |
| docs/add-new-api.md | Minor grammar improvement in documentation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
specification/streams/status/examples/200_response/GetStreamsStatusResponseExample1.yaml
Outdated
Show resolved
Hide resolved
…tatusResponseExample1.yaml Co-authored-by: Copilot <[email protected]>
pquentin
reviewed
Sep 5, 2025
Co-authored-by: Quentin Pradet <[email protected]>
|
Following you can find the validation changes against the target branch for the APIs.
You can validate these APIs yourself by using the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds the new logs streams endpoints to the spec.
This will need backporting to 9.1 as that's when these endpoints were added.