From 1ae2f7dced1831c15a22bfe5ab54df4781d18736 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Wed, 20 Nov 2024 13:45:37 -0600 Subject: [PATCH] Order sections to reflect API template (#8782) * Order sections to reflect API template Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update DEVELOPER_GUIDE.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update DEVELOPER_GUIDE.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update DEVELOPER_GUIDE.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --- DEVELOPER_GUIDE.md | 44 +++++++++++++++++++++++--------------------- 1 file changed, 23 insertions(+), 21 deletions(-) diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 18de000473..9b0ec1c79d 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -72,6 +72,29 @@ All spec insert components accept the following arguments: - `component` (String; required): The name of the component to render, such as `query_parameters`, `path_parameters`, or `paths_and_http_methods`. - `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: +```markdown + + +``` + +### Path parameters + +To insert a path parameters table of the `indices.create` API, use the following snippet. Use the `x-operation-group` field from OpenSearch OpenAPI Spec for the `api` value: + +```markdown + + +``` +This table accepts the same arguments as the query parameters table except the `include_global` argument. + ### Query parameters To insert the API query parameters table of the `cat.indices` API, use the following snippet: ```markdown @@ -110,24 +133,3 @@ pretty: true --> ``` - -### Path parameters -To insert path parameters table of the `indices.create` API, use the following snippet: -```markdown - - -``` -This table behaves the same as the query parameters table except that it does not accept the `include_global` argument. - -### Paths and HTTP methods -To insert paths and HTTP methods for the `search` API, use the following snippet: -```markdown - - -``` \ No newline at end of file