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

Add @doc_tag to override default tag behaviour #2961

Merged
merged 12 commits into from
Oct 3, 2024
Merged

Add @doc_tag to override default tag behaviour #2961

merged 12 commits into from
Oct 3, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Sep 27, 2024

Fixes #2310

This PR adds a @doc_tag modifier so that we can override the default operation-level tags that are based on the namespace.

For example, we can use it to put a "data stream" tag on the create data stream API to match its grouping in the existing docs (https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-data-stream.html) rather than the default "indices" value.

Copy link
Contributor

Following you can find the validation results for the API you have changed.

API Status Request Response
indices.create_data_stream 🟢 29/29 29/29

You can validate this API yourself by using the make validate target.

@lcawl lcawl marked this pull request as ready for review September 27, 2024 21:53
@lcawl lcawl requested a review from swallez September 27, 2024 21:53
Copy link
Contributor

Following you can find the validation results for the API you have changed.

API Status Request Response
indices.create_data_stream 🟢 29/29 29/29

You can validate this API yourself by using the make validate target.

Copy link
Contributor

Following you can find the validation results for the API you have changed.

API Status Request Response
indices.create_data_stream 🟢 29/29 29/29

You can validate this API yourself by using the make validate target.

@lcawl lcawl requested review from a team as code owners September 27, 2024 22:36
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.create_data_stream 🟢 29/29 29/29
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_stream 🟢 28/28 28/28
indices.migrate_to_data_stream Missing test Missing test
ml.put_data_frame_analytics 🔴 32/33 32/33
ml.put_job 🔴 219/227 223/225
ml.put_trained_model 🔴 15/16 6/16
search_application.put_behavioral_analytics 🟢 3/3 3/3

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

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.create_data_stream 🟢 29/29 29/29
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_stream 🟢 28/28 28/28
indices.migrate_to_data_stream Missing test Missing test
ml.put_data_frame_analytics 🔴 32/33 32/33
ml.put_job 🔴 219/227 223/225
ml.put_trained_model 🔴 15/16 6/16
search_application.put_behavioral_analytics 🟢 3/3 3/3

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

Copy link
Contributor

github-actions bot commented Oct 1, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.create_data_stream 🟢 29/29 29/29
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_stream 🟢 28/28 28/28
indices.migrate_to_data_stream Missing test Missing test
ml.put_data_frame_analytics 🔴 32/33 32/33
ml.put_job 🔴 219/227 223/225
ml.put_trained_model 🔴 15/16 6/16
search_application.put_behavioral_analytics 🟢 3/3 3/3

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

1 similar comment
Copy link
Contributor

github-actions bot commented Oct 1, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.create_data_stream 🟢 29/29 29/29
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_stream 🟢 28/28 28/28
indices.migrate_to_data_stream Missing test Missing test
ml.put_data_frame_analytics 🔴 32/33 32/33
ml.put_job 🔴 219/227 223/225
ml.put_trained_model 🔴 15/16 6/16
search_application.put_behavioral_analytics 🟢 3/3 3/3

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

@lcawl lcawl removed request for a team October 1, 2024 21:12
Copy link
Contributor

github-actions bot commented Oct 1, 2024

Following you can find the validation results for the API you have changed.

API Status Request Response
indices.create_data_stream 🟢 29/29 29/29

You can validate this API yourself by using the make validate target.

Copy link
Contributor

github-actions bot commented Oct 1, 2024

Following you can find the validation results for the API you have changed.

API Status Request Response
indices.create_data_stream 🟢 29/29 29/29

You can validate this API yourself by using the make validate target.

@lcawl lcawl requested a review from esdocs October 2, 2024 14:30
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
I've left a code suggestion to avoid using expect which simplifies a bit the code.

compiler-rs/clients_schema_to_openapi/src/paths.rs Outdated Show resolved Hide resolved
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Following you can find the validation results for the API you have changed.

API Status Request Response
indices.create_data_stream 🟢 29/29 29/29

You can validate this API yourself by using the make validate target.

1 similar comment
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Following you can find the validation results for the API you have changed.

API Status Request Response
indices.create_data_stream 🟢 29/29 29/29

You can validate this API yourself by using the make validate target.

@lcawl lcawl merged commit 5f59dc3 into main Oct 3, 2024
8 checks passed
@lcawl lcawl deleted the doc-tag branch October 3, 2024 15:17
Copy link
Contributor

github-actions bot commented Oct 3, 2024

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-2961-to-8.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 5f59dc31bbf456d0c1f5f3020ce36091b7da70cd
# Push it to GitHub
git push --set-upstream origin backport-2961-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-2961-to-8.x.

lcawl added a commit that referenced this pull request Oct 3, 2024
lcawl added a commit that referenced this pull request Oct 3, 2024
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 support for tag groupings
2 participants