Skip to content

[DOCS]: Clarify GET / response on Serverless #4981

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

Merged
merged 8 commits into from
Jul 24, 2025

Conversation

charlotte-hoblik
Copy link
Contributor

This PR:

  • clarifies the response when a user runs GET /
  • updates the existing example response
  • adds a new example specific to serverless deployments.

On Serverless, this endpoint will always return 8.11.0 as the version number and it is expected. Serverless offers automatic upgrades. Version is no longer something the user manages.

Based on: elastic/docs-content#1960

Copy link
Contributor

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

No changes detected.

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

@charlotte-hoblik
Copy link
Contributor Author

@leemthompo One question: I used the ::: syntax in my changes to highlight notes (screenshot attached). It renders really nicely in the built docs, but I haven’t seen anyone else use it, so I’m not sure if it’s officially supported or just working by coincidence.

Could you let me know if it’s safe to use? I’d prefer to avoid relying on something that might break later.
Screenshot 2025-07-21 at 10 28 27
Screenshot 2025-07-21 at 10 28 36

Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @charlotte-hoblik! Just suggested a rewording for clarity. On the ::: syntax, I have no idea TBH, I think @flobernd probably knows about this. 😄

I'll let @ppf and @rjernst weigh in on this too

@leemthompo
Copy link
Contributor

@charlotte-hoblik you'll need to run your make generate commands again to make sure the output files are also updated

Would be nice to have screenshots of the examples too for reviewers :)

Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@charlotte-hoblik charlotte-hoblik merged commit a81526b into main Jul 24, 2025
8 checks passed
@charlotte-hoblik charlotte-hoblik deleted the charlotte-GET-api-serverless-1960 branch July 24, 2025 06:48
github-actions bot pushed a commit that referenced this pull request Jul 24, 2025
* Add info about version number for serverless

Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit a81526b)
Copy link
Contributor

The backport to 8.17 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-8.17 8.17
# Navigate to the new working tree
cd .worktrees/backport-8.17
# Create a new branch
git switch --create backport-4981-to-8.17
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 a81526b99d88f1acb13fadf64b9f1d335af72fc2
# Push it to GitHub
git push --set-upstream origin backport-4981-to-8.17
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.17

Then, create a pull request where the base branch is 8.17 and the compare/head branch is backport-4981-to-8.17.

github-actions bot pushed a commit that referenced this pull request Jul 25, 2025
* Add info about version number for serverless

Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit a81526b)
github-actions bot pushed a commit that referenced this pull request Jul 25, 2025
* Add info about version number for serverless

Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit a81526b)
github-actions bot pushed a commit that referenced this pull request Jul 25, 2025
* Add info about version number for serverless

Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit a81526b)
charlotte-hoblik added a commit that referenced this pull request Jul 25, 2025
* Add info about version number for serverless


(cherry picked from commit a81526b)

Co-authored-by: Charlotte Hoblik <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
charlotte-hoblik added a commit that referenced this pull request Jul 25, 2025
* Add info about version number for serverless


(cherry picked from commit a81526b)

Co-authored-by: Charlotte Hoblik <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
charlotte-hoblik added a commit that referenced this pull request Jul 25, 2025
* Add info about version number for serverless


(cherry picked from commit a81526b)

Co-authored-by: Charlotte Hoblik <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
charlotte-hoblik added a commit that referenced this pull request Jul 25, 2025
* Add info about version number for serverless


(cherry picked from commit a81526b)

Co-authored-by: Charlotte Hoblik <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants