diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 9b0ec1c79d..e4bc66ab1f 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -1,13 +1,14 @@ # Developer guide -- [Introduction](#introduction) -- [Starting the Jekyll server locally](#starting-the-jekyll-server-locally) -- [Using the spec-insert Jekyll plugin](#using-the-spec-insert-jekyll-plugin) - - [Ignoring files and folders](#ignoring-files-and-folders) -- [CI/CD](#cicd) -- [Spec insert components](#spec-insert-components) - - [Query parameters](#query-parameters) - - [Path parameters](#path-parameters) - - [Paths and HTTP methods](#paths-and-http-methods) +- [Developer guide](#developer-guide) + - [Introduction](#introduction) + - [Starting the Jekyll server locally](#starting-the-jekyll-server-locally) + - [Using the `spec-insert` Jekyll plugin](#using-the-spec-insert-jekyll-plugin) + - [Ignoring files and folders](#ignoring-files-and-folders) + - [CI/CD](#cicd) + - [Spec insert components](#spec-insert-components) + - [Endpoints](#endpoints) + - [Path parameters](#path-parameters) + - [Query parameters](#query-parameters) ## Introduction @@ -69,15 +70,15 @@ The `spec-insert` plugin is run as part of the CI/CD pipeline to ensure that the ## Spec insert components All spec insert components accept the following arguments: - `api` (String; required): The name of the API to render the component from. This is equivalent to the `x-operation-group` field in the OpenSearch OpenAPI Spec. -- `component` (String; required): The name of the component to render, such as `query_parameters`, `path_parameters`, or `paths_and_http_methods`. +- `component` (String; required): The name of the component to render, such as `query_parameters`, `path_parameters`, or `endpoints`. - `omit_header` (Boolean; Default is `false`): If set to `true`, the markdown header of the component will not be rendered. -### Paths and HTTP methods -To insert paths and HTTP methods for the `search` API, use the following snippet: +### Endpoints +To insert any endpoints for the `search` API, use the following snippet: ```markdown ``` diff --git a/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md b/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md index 5f8ce4109b..d59fd4ecf2 100644 --- a/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md +++ b/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md @@ -17,7 +17,7 @@ The Query Group Lifecycle API creates, updates, retrieves, and deletes query gro ```json @@ -29,7 +29,7 @@ PUT /_wlm/query_group ```json @@ -41,7 +41,7 @@ PUT /_wlm/query_group ```json @@ -54,7 +54,7 @@ GET /_wlm/query_group/{name} ```json