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

Use standard format for reload settings API #51560

Merged

Conversation

williamrandolph
Copy link
Contributor

@williamrandolph williamrandolph commented Jan 28, 2020

The reload-secure-settings API page was not reorganized for the standard
API format, so this commit is reorganizing the page and adding some
links to the page in related documentation.

This is a follow-up to #51123 .

Preview: http://elasticsearch_51560.docs-preview.app.elstc.co/diff

The reload-secure-settings API page was not reorganized for the standard
API format, so this commit is reorganizing the page and adding some
links to the page in related documentation.
@williamrandolph williamrandolph added >docs General docs changes >non-issue :Security/Security Security issues without another label v8.0.0 v7.7.0 labels Jan 28, 2020
@williamrandolph williamrandolph requested a review from lcawl January 28, 2020 19:30
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-security (:Security/Security)

@williamrandolph
Copy link
Contributor Author

williamrandolph commented Jan 28, 2020

Note: these docs were originally written in #45054.

==== {api-request-title}
`POST _nodes/reload_secure_settings` +

`POST _nodes/nodeId1,nodeId2/reload_secure_settings` +
Copy link
Contributor

Choose a reason for hiding this comment

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

This should line up with the path parameter section:

Suggested change
`POST _nodes/nodeId1,nodeId2/reload_secure_settings` +
`POST _nodes/<nodes>/reload_secure_settings` +


`POST _nodes/nodeId1,nodeId2/reload_secure_settings` +

`POST _nodes/_local/reload_secure_settings`
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this can be omitted since it's just another example of a value and it's mentioned in the link from the path parameters section.


`<nodes>`::
(Optional, string) The names of particular nodes in the cluster to target.
For example, you may also selectively target `nodeId1` and `nodeId2`. The
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
For example, you may also selectively target `nodeId1` and `nodeId2`. The
For example, `nodeId1,nodeId2`. The

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

LGTM!

@williamrandolph williamrandolph merged commit 9e4d397 into elastic:master Feb 3, 2020
@williamrandolph williamrandolph deleted the fix-reload-nodes-docs branch February 3, 2020 20:28
williamrandolph added a commit to williamrandolph/elasticsearch that referenced this pull request Feb 3, 2020
* Use standard format for reload settings API

The reload-secure-settings API page was not reorganized for the standard
API format, so this commit is reorganizing the page and adding some
links to the page in related documentation.

* Fix broken links

* Reorder examples to correctly check API response

* Note that only certain settings are reloadable

* [DOCS] Edits layout

* [DOCS] Removes unnecessary callouts

Co-authored-by: Lisa Cawley <[email protected]>
williamrandolph added a commit that referenced this pull request Feb 3, 2020
* Use standard format for reload settings API

The reload-secure-settings API page was not reorganized for the standard
API format, so this commit is reorganizing the page and adding some
links to the page in related documentation.

* Fix broken links

* Reorder examples to correctly check API response

* Note that only certain settings are reloadable

* [DOCS] Edits layout

* [DOCS] Removes unnecessary callouts

Co-authored-by: Lisa Cawley <[email protected]>

Co-authored-by: Lisa Cawley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes >non-issue :Security/Security Security issues without another label v7.7.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants