Skip to content

add docUrlServerless field to endpoints#5851

Merged
miguelgrinberg merged 5 commits intomainfrom
add-serverless-doc-url
Jan 9, 2026
Merged

add docUrlServerless field to endpoints#5851
miguelgrinberg merged 5 commits intomainfrom
add-serverless-doc-url

Conversation

@miguelgrinberg
Copy link
Contributor

@miguelgrinberg miguelgrinberg commented Dec 16, 2025

Fixes #5188 (partially)

This change adds a column to table.csv for documentation URLs that apply to serverless. The new column is inserted in the 3rd position, right after doc-url. The value can be a URL, empty when there is no serverless equivalent, or the string [use-doc-url] to use the same URL for both stack and serverless.

The new documentation URLs are included in schema.json for all endpoints with the name docUrlServerless.

This change adds the support for generating the URLs. The table.csv entries are all set to [use-doc-url] for now. The docs team needs to fill URLs that are different as needed.

@github-actions
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.

@miguelgrinberg miguelgrinberg force-pushed the add-serverless-doc-url branch 2 times, most recently from 9a0a2a9 to 1df07ab Compare December 16, 2025 14:33
@miguelgrinberg miguelgrinberg changed the title add docServerlessUrl field to endpoints add docUrlServerless field to endpoints Dec 16, 2025
Copy link
Contributor

@Anaethelion Anaethelion left a comment

Choose a reason for hiding this comment

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

LGTM

@miguelgrinberg
Copy link
Contributor Author

@lcawl This PR is waiting for you now. The 3rd column in table.csv is now the serverless doc url. If you leave it set to [use-doc-url] then the same URL is used for both. This is what I put in all the entries for now. You can replace this with a real URL, or with an empty string when there is no URL. Thanks!

@pquentin
Copy link
Member

pquentin commented Dec 17, 2025

Even though this is only for serverless, I added the backport 9.1 and backport 9.2 labels in the interest of reducing merge conflicts down the road, as the table.csv file is a big source of merge conflicts. Case in point, we have a conflict on this file right now.

@lcawl lcawl force-pushed the add-serverless-doc-url branch from 1df07ab to 5a08ca9 Compare December 30, 2025 00:13
@lcawl
Copy link
Contributor

lcawl commented Dec 30, 2025

I rebased this PR to catch the three PRs that had added rows in the table.csv file. I then used an AI script to update the file as follows: 271 rows were updated with valid serverless URLs, and 264 rows that contained Elasticsearch API URLs were skipped because their serverless URLs returned 404. I have left the latter as [use-doc-url] for now.

[Edit] On second thought, I set those 264 rows to an empty value instead, to more accurately indicate that they don't exist.

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

This does seem to address my original issue, thanks! It also addresses the situation where we have serverless-only APIs like #5874

It might be cool to use that new serverless-specific column for all URL resolution in the serverless-specific OpenAPI output, but that can be discussed as a follow-up.

@miguelgrinberg
Copy link
Contributor Author

@lcawl Do you want to give this PR a last look before we merge? I had to do another merge of the main branch, and that came with one new row in table.csv, the one for cef-processor.

@miguelgrinberg miguelgrinberg merged commit 79acfd9 into main Jan 9, 2026
12 checks passed
@miguelgrinberg miguelgrinberg deleted the add-serverless-doc-url branch January 9, 2026 16:01
@github-actions
Copy link
Contributor

github-actions bot commented Jan 9, 2026

The backport to 9.1 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-9.1 9.1
# Navigate to the new working tree
cd .worktrees/backport-9.1
# Create a new branch
git switch --create backport-5851-to-9.1
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 79acfd91b6a1341650995f789a3378f54122662b
# Push it to GitHub
git push --set-upstream origin backport-5851-to-9.1
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.1

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

@github-actions
Copy link
Contributor

github-actions bot commented Jan 9, 2026

The backport to 9.2 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-9.2 9.2
# Navigate to the new working tree
cd .worktrees/backport-9.2
# Create a new branch
git switch --create backport-5851-to-9.2
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 79acfd91b6a1341650995f789a3378f54122662b
# Push it to GitHub
git push --set-upstream origin backport-5851-to-9.2
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.2

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

@github-actions
Copy link
Contributor

github-actions bot commented Jan 9, 2026

The backport to 9.3 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-9.3 9.3
# Navigate to the new working tree
cd .worktrees/backport-9.3
# Create a new branch
git switch --create backport-5851-to-9.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 79acfd91b6a1341650995f789a3378f54122662b
# Push it to GitHub
git push --set-upstream origin backport-5851-to-9.3
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.3

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

miguelgrinberg added a commit that referenced this pull request Jan 9, 2026
* add docServerlessUrl field to endpoints

* updated schema.json

* Add serverless URLs

* Set 404 serverless URLs to empty values

---------

Co-authored-by: lcawl <lcawley@elastic.co>
miguelgrinberg added a commit that referenced this pull request Jan 9, 2026
* add docServerlessUrl field to endpoints

* updated schema.json

* Add serverless URLs

* Set 404 serverless URLs to empty values

---------

Co-authored-by: lcawl <lcawley@elastic.co>
miguelgrinberg added a commit that referenced this pull request Jan 9, 2026
* add docServerlessUrl field to endpoints

* updated schema.json

* Add serverless URLs

* Set 404 serverless URLs to empty values

---------

Co-authored-by: lcawl <lcawley@elastic.co>
miguelgrinberg added a commit that referenced this pull request Jan 9, 2026
* add docServerlessUrl field to endpoints

* updated schema.json

* Add serverless URLs

* Set 404 serverless URLs to empty values

---------

Co-authored-by: lcawl <lcawley@elastic.co>
miguelgrinberg added a commit that referenced this pull request Jan 9, 2026
* add docServerlessUrl field to endpoints

* updated schema.json

* Add serverless URLs

* Set 404 serverless URLs to empty values

---------

Co-authored-by: lcawl <lcawley@elastic.co>
miguelgrinberg added a commit that referenced this pull request Jan 9, 2026
* add docServerlessUrl field to endpoints

* updated schema.json

* Add serverless URLs

* Set 404 serverless URLs to empty values

---------

Co-authored-by: lcawl <lcawley@elastic.co>
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.

Add serverless docURL in schema.json for Console

5 participants