-
Notifications
You must be signed in to change notification settings - Fork 24.4k
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
Fix URL documentation in API specs #44487
Fix URL documentation in API specs #44487
Conversation
Pinging @elastic/es-core-infra |
Looks like there is a problem with rest-api-spec/src/main/resources/rest-api-spec/api/render_search_template.json That is the only issue I saw with the changes. |
@Trisped I fixed in the second commit here 1796374. I used the specific paragraph for the render template https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html#_validating_templates instead of the one that you proposed https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html. I fixed all the endpoint URLs. |
@ezimuel I miss read the commits (I thought newest was on top). Thanks for the feed back. Everything looks good. |
Do we know why the patch is failing on CI? It would be nice to get this in, so I can fold it into #42346. |
@karmi Not sure, the only changes were made to the documentation.
There are some other errors higher up in the log, but they are not as clear to me. Since we now have merge conflicts, I would suggest merging master into this branch and see if that fixes it. Especially since the first checkin worked and the second only had the one change. I guess I should also point out that I am not actually a dev on this. I was the one who reported the issue and @ezimuel was nice enough to make the changes. |
Jenkins, retest this please. |
The docs build error appears unrelated to the changes (as expected). |
@elasticmachine run elasticsearch-ci/1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Are there any plans to backport these changes to 6.x? Doing so would allow clients to update their libraries with the link changes |
This PR fixes the URL documentation in API specs. I checked the documentation URLs in the API specs and I applied the following changes:
https
instead ofhttp
);info
: https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html;ping
: https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html;render_search_template
: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html#_validating_templates.