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.

Sign up for GitHub

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

Jump to bottom

Check and fix incorrect documentation for timeout related parameters #108224

Closed
ywangd opened this issue May 3, 2024 · 5 comments · Fixed by #108593
Closed

Check and fix incorrect documentation for timeout related parameters #108224

ywangd opened this issue May 3, 2024 · 5 comments · Fixed by #108593
Labels
:Distributed/Distributed A catch all label for anything in the Distributed Area. If you aren't sure, use this one. >docs General docs changes Team:Distributed Meta label for distributed team Team:Docs Meta label for docs team

Comments

@ywangd
Copy link
Member

ywangd commented May 3, 2024

Templates are used to document common parameters such as timeout and master_timeout. Many APIs do support both parameters. However there are also APIs that support only one of them. For example, ClusterGetSettings API supports only master_timeout while NodesStats API supports only timeout. In addition, the APIs that support only timeout parameter may have a different default than the 30 seconds defined in the template, e.g. NodesStats API defaults to no timeout. We should cross-check with the API implementation to make sure documentation is consistent.
@ywangd ywangd added >docs General docs changes :Distributed/Distributed A catch all label for anything in the Distributed Area. If you aren't sure, use this one. labels May 3, 2024
@elasticsearchmachine elasticsearchmachine added Team:Distributed Meta label for distributed team Team:Docs Meta label for docs team labels May 3, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (Team:Distributed)

@leemthompo
Copy link
Contributor

@lcawl is working on our API docs automation project which should alleviate some of these manual concerns. Just CC'ing in case that might solve issues like this sooner rather than later. :)

@ywangd
Copy link
Member Author

ywangd commented May 3, 2024

@leemthompo Full automation would for sure be better and welcomed in the long run. For the timebeing, we plan to have this issue as an onboarding task for new team members. Thanks!

@nicktindall
Copy link
Contributor

Summary of findings here

Still WIP

nicktindall added a commit to nicktindall/elasticsearch that referenced this issue May 14, 2024
@nicktindall
[DOCS] Fix documentation for timeout-related parameters
1e120da 
Closes elastic#108224
This was referenced May 14, 2024
Merged
Open
nicktindall added a commit that referenced this issue May 16, 2024
@nicktindall
[DOCS] Align docs to implementation for timeout parameters (#108593)
3ecdd77 
* [DOCS] Fix documentation for timeout-related parameters

Closes #108224
parkertimmins pushed a commit to parkertimmins/elasticsearch that referenced this issue May 17, 2024
@nicktindall @parkertimmins
[DOCS] Align docs to implementation for timeout parameters (elastic#1…
68960c3 
…08593)

* [DOCS] Fix documentation for timeout-related parameters

Closes elastic#108224
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
:Distributed/Distributed A catch all label for anything in the Distributed Area. If you aren't sure, use this one. >docs General docs changes Team:Distributed Meta label for distributed team Team:Docs Meta label for docs team
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[DOCS] Align docs to implementation for timeout parameters nicktindall/elasticsearch
4 participants
@nicktindall @ywangd @leemthompo @elasticsearchmachine