DOC-13663: Improve process for Search and Query REST API examples (#207)

* Bundle Query and FTS specs using Redocly
* Build inline curl request, http request, and http response examples using handlebars templates
* Remove unnecessary local examples
* Remove unnecessary example partials
* Update remaining example partials — they're just explanations now
* Rename all existing http-request partials to curl-request
* Add ID to examples
* Fix xref in example partial
* Remove example captions from Query API docs
* Output default for response code 0
* Build output documentation

Author: simon-dew

docs/modules/analytics-rest-admin/pages/index.adoc

@@ -296,8 +296,17 @@ include::{specDir}paths/cancel_request/operation-security-end.adoc[opts=optional
 
 include::{specDir}paths/cancel_request/operation-security-after.adoc[opts=optional]
 
+include::{snippetDir}cancel_request/curl-request.adoc[opts=optional]
+
+
+
 include::{snippetDir}cancel_request/http-request.adoc[opts=optional]
 
+ifeval::["" != ""]
+[#cancel_request-ex-response]
+= Example HTTP Response
+endif::[]
+
 include::{snippetDir}cancel_request/http-response.adoc[opts=optional]
 
 include::{specDir}paths/cancel_request/operation-end.adoc[opts=optional]
@@ -432,8 +441,17 @@ include::{specDir}paths/cluster_status/operation-security-end.adoc[opts=optional
 
 include::{specDir}paths/cluster_status/operation-security-after.adoc[opts=optional]
 
+include::{snippetDir}cluster_status/curl-request.adoc[opts=optional]
+
+
+
 include::{snippetDir}cluster_status/http-request.adoc[opts=optional]
 
+ifeval::["" != ""]
+[#cluster_status-ex-response]
+= Example HTTP Response
+endif::[]
+
 include::{snippetDir}cluster_status/http-response.adoc[opts=optional]
 
 include::{specDir}paths/cluster_status/operation-end.adoc[opts=optional]
@@ -568,8 +586,17 @@ include::{specDir}paths/completed_requests/operation-security-end.adoc[opts=opti
 
 include::{specDir}paths/completed_requests/operation-security-after.adoc[opts=optional]
 
+include::{snippetDir}completed_requests/curl-request.adoc[opts=optional]
+
+
+
 include::{snippetDir}completed_requests/http-request.adoc[opts=optional]
 
+ifeval::["" != ""]
+[#completed_requests-ex-response]
+= Example HTTP Response
+endif::[]
+
 include::{snippetDir}completed_requests/http-response.adoc[opts=optional]
 
 include::{specDir}paths/completed_requests/operation-end.adoc[opts=optional]
@@ -704,8 +731,17 @@ include::{specDir}paths/ingestion_status/operation-security-end.adoc[opts=option
 
 include::{specDir}paths/ingestion_status/operation-security-after.adoc[opts=optional]
 
+include::{snippetDir}ingestion_status/curl-request.adoc[opts=optional]
+
+
+
 include::{snippetDir}ingestion_status/http-request.adoc[opts=optional]
 
+ifeval::["" != ""]
+[#ingestion_status-ex-response]
+= Example HTTP Response
+endif::[]
+
 include::{snippetDir}ingestion_status/http-response.adoc[opts=optional]
 
 include::{specDir}paths/ingestion_status/operation-end.adoc[opts=optional]
@@ -845,8 +881,17 @@ include::{specDir}paths/monitor_node/operation-security-end.adoc[opts=optional]
 
 include::{specDir}paths/monitor_node/operation-security-after.adoc[opts=optional]
 
+include::{snippetDir}monitor_node/curl-request.adoc[opts=optional]
+
+
+
 include::{snippetDir}monitor_node/http-request.adoc[opts=optional]
 
+ifeval::["" != ""]
+[#monitor_node-ex-response]
+= Example HTTP Response
+endif::[]
+
 include::{snippetDir}monitor_node/http-response.adoc[opts=optional]
 
 include::{specDir}paths/monitor_node/operation-end.adoc[opts=optional]
@@ -980,8 +1025,17 @@ include::{specDir}paths/restart_cluster/operation-security-end.adoc[opts=optiona
 
 include::{specDir}paths/restart_cluster/operation-security-after.adoc[opts=optional]
 
+include::{snippetDir}restart_cluster/curl-request.adoc[opts=optional]
+
+
+
 include::{snippetDir}restart_cluster/http-request.adoc[opts=optional]
 
+ifeval::["" != ""]
+[#restart_cluster-ex-response]
+= Example HTTP Response
+endif::[]
+
 include::{snippetDir}restart_cluster/http-response.adoc[opts=optional]
 
 include::{specDir}paths/restart_cluster/operation-end.adoc[opts=optional]
@@ -1115,8 +1169,17 @@ include::{specDir}paths/restart_node/operation-security-end.adoc[opts=optional]
 
 include::{specDir}paths/restart_node/operation-security-after.adoc[opts=optional]
 
+include::{snippetDir}restart_node/curl-request.adoc[opts=optional]
+
+
+
 include::{snippetDir}restart_node/http-request.adoc[opts=optional]
 
+ifeval::["" != ""]
+[#restart_node-ex-response]
+= Example HTTP Response
+endif::[]
+
 include::{snippetDir}restart_node/http-response.adoc[opts=optional]
 
 include::{specDir}paths/restart_node/operation-end.adoc[opts=optional]
@@ -1251,8 +1314,17 @@ include::{specDir}paths/return_active_requests/operation-security-end.adoc[opts=
 
 include::{specDir}paths/return_active_requests/operation-security-after.adoc[opts=optional]
 
+include::{snippetDir}return_active_requests/curl-request.adoc[opts=optional]
+
+
+
 include::{snippetDir}return_active_requests/http-request.adoc[opts=optional]
 
+ifeval::["" != ""]
+[#return_active_requests-ex-response]
+= Example HTTP Response
+endif::[]
+
 include::{snippetDir}return_active_requests/http-response.adoc[opts=optional]
 
 include::{specDir}paths/return_active_requests/operation-end.adoc[opts=optional]

…s/paths/cancel_request/http-request.adoc …s/paths/cancel_request/curl-request.adocdocs/modules/analytics-rest-admin/partials/paths/cancel_request/http-request.adoc renamed to docs/modules/analytics-rest-admin/partials/paths/cancel_request/curl-request.adoc docs/modules/analytics-rest-admin/partials/paths/cancel_request/http-request.adoc renamed to docs/modules/analytics-rest-admin/partials/paths/cancel_request/curl-request.adoc

@@ -243,8 +243,17 @@ include::{specDir}paths/get_node/operation-security-end.adoc[opts=optional]
 
 include::{specDir}paths/get_node/operation-security-after.adoc[opts=optional]
 
+include::{snippetDir}get_node/curl-request.adoc[opts=optional]
+
+
+
 include::{snippetDir}get_node/http-request.adoc[opts=optional]
 
+ifeval::["" != ""]
+[#get_node-ex-response]
+= Example HTTP Response
+endif::[]
+
 include::{snippetDir}get_node/http-response.adoc[opts=optional]
 
 include::{specDir}paths/get_node/operation-end.adoc[opts=optional]
@@ -372,8 +381,17 @@ include::{specDir}paths/get_service/operation-security-end.adoc[opts=optional]
 
 include::{specDir}paths/get_service/operation-security-after.adoc[opts=optional]
 
+include::{snippetDir}get_service/curl-request.adoc[opts=optional]
+
+
+
 include::{snippetDir}get_service/http-request.adoc[opts=optional]
 
+ifeval::["" != ""]
+[#get_service-ex-response]
+= Example HTTP Response
+endif::[]
+
 include::{snippetDir}get_service/http-response.adoc[opts=optional]
 
 include::{specDir}paths/get_service/operation-end.adoc[opts=optional]
@@ -460,7 +478,7 @@ a¦ *Body* +
 optional
 a¦ [markdown]
 --
-
+An object specifying one or more of the configurable node-level parameters on this node.
 --
 
 [%hardbreaks]
@@ -553,8 +571,17 @@ include::{specDir}paths/put_node/operation-security-end.adoc[opts=optional]
 
 include::{specDir}paths/put_node/operation-security-after.adoc[opts=optional]
 
+include::{snippetDir}put_node/curl-request.adoc[opts=optional]
+
+
+
 include::{snippetDir}put_node/http-request.adoc[opts=optional]
 
+ifeval::["" != ""]
+[#put_node-ex-response]
+= Example HTTP Response
+endif::[]
+
 include::{snippetDir}put_node/http-response.adoc[opts=optional]
 
 include::{specDir}paths/put_node/operation-end.adoc[opts=optional]
@@ -639,7 +666,7 @@ a¦ *Body* +
 optional
 a¦ [markdown]
 --
-
+An object specifying one or more of the configurable service-level parameters.
 --
 
 [%hardbreaks]
@@ -732,8 +759,17 @@ include::{specDir}paths/put_service/operation-security-end.adoc[opts=optional]
 
 include::{specDir}paths/put_service/operation-security-after.adoc[opts=optional]
 
+include::{snippetDir}put_service/curl-request.adoc[opts=optional]
+
+
+
 include::{snippetDir}put_service/http-request.adoc[opts=optional]
 
+ifeval::["" != ""]
+[#put_service-ex-response]
+= Example HTTP Response
+endif::[]
+
 include::{snippetDir}put_service/http-response.adoc[opts=optional]
 
 include::{specDir}paths/put_service/operation-end.adoc[opts=optional]