Console-ify curl statements for allocation explain API docs #23190
Conversation
| @@ -17,12 +17,20 @@ To explain the allocation of a shard, issue a request: | |||
|
|
|||
| [source,js] | |||
| -------------------------------------------------- | |||
| $ curl -XGET 'http://localhost:9200/_cluster/allocation/explain' -d '{ | |||
| PUT /myindex | |||
There was a problem hiding this comment.
I'd either call this out in the prose like the painless docs do for their example or I'd surround this in block comments (////) with an explanation that it is hidden but makes the snippets on the page make more sense.
There was a problem hiding this comment.
Sure I added some surrounding prose
| @@ -35,12 +43,12 @@ specified as either the node id or node name. | |||
|
|
|||
| [source,js] | |||
| -------------------------------------------------- | |||
| $ curl -XGET 'http://localhost:9200/_cluster/allocation/explain' -d '{ | |||
There was a problem hiding this comment.
I think this is missing the GET /_cluster/allocation/explain part?
There was a problem hiding this comment.
It moved further down under the // TESTSETUP part
There was a problem hiding this comment.
Er, sorry, posted to the wrong spot.
| @@ -35,12 +43,12 @@ specified as either the node id or node name. | |||
|
|
|||
| [source,js] | |||
| -------------------------------------------------- | |||
| $ curl -XGET 'http://localhost:9200/_cluster/allocation/explain' -d '{ | |||
There was a problem hiding this comment.
Er, sorry, posted to the wrong spot.
| @@ -35,12 +43,12 @@ specified as either the node id or node name. | |||
|
|
|||
| [source,js] | |||
| -------------------------------------------------- | |||
| $ curl -XGET 'http://localhost:9200/_cluster/allocation/explain' -d '{ | |||
| { | |||
There was a problem hiding this comment.
I think this is missing the GET /_cluster/allocation/explain part.
There was a problem hiding this comment.
I don't know how to test this since I don't know the name or ID of a node currently in the cluster to which the shard is assigned
There was a problem hiding this comment.
Which is why I made it a JSON blob instead of a console blob
There was a problem hiding this comment.
I'd make it a CONSOLE blob and explicitly script the test with // TEST[skip:don't know the name or id of a node currently in the cluster]. You could probably get one the same way we do with yaml tests but that seems like a lot of work. Maybe worth it if we find this snippet has an error, but otherwise not. This way we get the COPY AS CURL and VIEW IN CONSOLE links which are handy, even if we do skip the test.
* Console-ify curl statements for allocation explain API docs Relates to #23001 * Fix tests * Remove exclusion from build.gradle * Call out index creation in prose * Add console back and skip test
* Console-ify curl statements for allocation explain API docs Relates to #23001 * Fix tests * Remove exclusion from build.gradle * Call out index creation in prose * Add console back and skip test
Relates to #23001