add docUrlServerless field to endpoints#5851
Conversation
|
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 |
8592731 to
dd36608
Compare
9a0a2a9 to
1df07ab
Compare
|
@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 |
|
Even though this is only for serverless, I added the |
1df07ab to
5a08ca9
Compare
|
I rebased this PR to catch the three PRs that had added rows in the [Edit] On second thought, I set those 264 rows to an empty value instead, to more accurately indicate that they don't exist. |
There was a problem hiding this comment.
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.
|
@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 |
|
The backport to 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.1Then, create a pull request where the |
|
The backport to 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.2Then, create a pull request where the |
|
The backport to 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.3Then, create a pull request where the |
* 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>
* 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>
* 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>
Fixes #5188 (partially)
This change adds a column to
table.csvfor documentation URLs that apply to serverless. The new column is inserted in the 3rd position, right afterdoc-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.