Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
dc87c0a
Bundle specs using Redocly
simon-dew Nov 12, 2025
b8ff94f
Build inline examples
simon-dew Nov 12, 2025
a11f79d
Update README for this PoC
simon-dew Jan 30, 2026
46f2c60
Update inline example code for handlebars
simon-dew Jan 30, 2026
c867d68
Update FTS builds to bundle specs using Redocly
simon-dew Jan 30, 2026
11eb12a
Update FTS request example partials
simon-dew Jan 30, 2026
805c149
Remove local FTS examples
simon-dew Jan 30, 2026
5862213
Build output documentation
simon-dew Jan 30, 2026
8e8c4ef
Remove unnecessary FTS response example partials
simon-dew Jan 30, 2026
6c44799
Add ID to response examples
simon-dew Jan 30, 2026
6fd0cec
Update FTS response example partials — they're just explanations now
simon-dew Jan 30, 2026
de88be2
Handle request body examples
simon-dew Jan 30, 2026
10f492f
Remove unnecessary FTS request body partials
simon-dew Jan 30, 2026
9bb60ae
Update FTS request body partials
simon-dew Jan 30, 2026
a167538
Fix xref
simon-dew Jan 30, 2026
82815c1
Rename all existing http-request partials to curl-request
simon-dew Jan 31, 2026
60c7686
Remove unnecessary Query response examples
simon-dew Jan 31, 2026
37def76
Build output documentation
simon-dew Jan 31, 2026
589dd1b
Remove example captions from Query APIS
simon-dew Feb 2, 2026
8fc35a4
Output default for response code 0
simon-dew Feb 2, 2026
58911cc
Objects in body param
simon-dew Feb 2, 2026
d92daf3
Title for Example HTTP Response
simon-dew Feb 2, 2026
4fa920a
Rationalize HTTP Request examples
simon-dew Feb 2, 2026
03dc395
Rationalize Request Body examples
simon-dew Feb 2, 2026
4fa2959
Rationalize HTTP Response examples
simon-dew Feb 2, 2026
bca87ae
Minor tweaks
simon-dew Feb 3, 2026
51ef609
Revert "Objects in body param"
simon-dew Feb 3, 2026
e05e451
Revert "Update README for this PoC"
simon-dew Feb 3, 2026
4abab7b
Build output documentation
simon-dew Feb 3, 2026
2ef108b
Remove remaining unnecessary Query examples
simon-dew Feb 3, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions docs/modules/analytics-rest-admin/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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]
Expand Down
40 changes: 38 additions & 2 deletions docs/modules/analytics-rest-config/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -639,7 +666,7 @@ a¦ *Body* +
optional
a¦ [markdown]
--

An object specifying one or more of the configurable service-level parameters.
--

[%hardbreaks]
Expand Down Expand Up @@ -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]
Expand Down
27 changes: 27 additions & 0 deletions docs/modules/analytics-rest-library/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -296,8 +296,17 @@ include::{specDir}paths/delete_library/operation-security-end.adoc[opts=optional

include::{specDir}paths/delete_library/operation-security-after.adoc[opts=optional]

include::{snippetDir}delete_library/curl-request.adoc[opts=optional]



include::{snippetDir}delete_library/http-request.adoc[opts=optional]

ifeval::["" != ""]
[#delete_library-ex-response]
= Example HTTP Response
endif::[]

include::{snippetDir}delete_library/http-response.adoc[opts=optional]

include::{specDir}paths/delete_library/operation-end.adoc[opts=optional]
Expand Down Expand Up @@ -433,8 +442,17 @@ include::{specDir}paths/get_collection/operation-security-end.adoc[opts=optional

include::{specDir}paths/get_collection/operation-security-after.adoc[opts=optional]

include::{snippetDir}get_collection/curl-request.adoc[opts=optional]



include::{snippetDir}get_collection/http-request.adoc[opts=optional]

ifeval::["" != ""]
[#get_collection-ex-response]
= Example HTTP Response
endif::[]

include::{snippetDir}get_collection/http-response.adoc[opts=optional]

include::{specDir}paths/get_collection/operation-end.adoc[opts=optional]
Expand Down Expand Up @@ -654,8 +672,17 @@ include::{specDir}paths/post_library/operation-security-end.adoc[opts=optional]

include::{specDir}paths/post_library/operation-security-after.adoc[opts=optional]

include::{snippetDir}post_library/curl-request.adoc[opts=optional]



include::{snippetDir}post_library/http-request.adoc[opts=optional]

ifeval::["" != ""]
[#post_library-ex-response]
= Example HTTP Response
endif::[]

include::{snippetDir}post_library/http-response.adoc[opts=optional]

include::{specDir}paths/post_library/operation-end.adoc[opts=optional]
Expand Down
Loading