Skip to content
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

[OpenAPI] Remove self-referential externalDocs #2925

Merged
merged 1 commit into from
Sep 26, 2024
Merged

[OpenAPI] Remove self-referential externalDocs #2925

merged 1 commit into from
Sep 26, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Sep 23, 2024

This PR accomplishes the first step of #2748 (i.e. no longer adding externalDocs in the OpenAPI operations that are self-referential.

It does not accomplish the second step, which is to enact some way to add optional externalDocs that are meaningful from an API docs point of view. For example, a link to https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html from the _analyze API.

@lcawl lcawl added the OpenAPI label Sep 23, 2024
@lcawl lcawl marked this pull request as ready for review September 23, 2024 20:08
@lcawl lcawl requested a review from flobernd September 23, 2024 20:09
Copy link
Contributor

@l-trotta l-trotta left a comment

Choose a reason for hiding this comment

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

LGTM!

@lcawl lcawl enabled auto-merge (squash) September 26, 2024 15:39
@lcawl lcawl merged commit e7ffee1 into main Sep 26, 2024
6 checks passed
@lcawl lcawl deleted the rm-externalDocs branch September 26, 2024 15:41
Copy link
Contributor

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

Then, create a pull request where the base branch is 8.x and the compare/head branch is backport-2925-to-8.x.

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.

2 participants