Skip to content

Commit

Permalink
Replace current automation with endpoints
Browse files Browse the repository at this point in the history
Signed-off-by: Archer <[email protected]>
  • Loading branch information
Naarcha-AWS committed Dec 18, 2024
1 parent f3eb6f7 commit 3161025
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 17 deletions.
27 changes: 14 additions & 13 deletions DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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`.

Check failure on line 73 in DEVELOPER_GUIDE.md

View workflow job for this annotation

GitHub Actions / vale

[vale] DEVELOPER_GUIDE.md#L73

[OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'render, such'.
Raw output
{"message": "[OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'render, such'.", "location": {"path": "DEVELOPER_GUIDE.md", "range": {"start": {"line": 73, "column": 64}}}, "severity": "ERROR"}
- `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
<!-- spec_insert_start
api: search
component: paths_and_http_methods
component: endpoints
-->
<!-- spec_insert_end -->
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The Query Group Lifecycle API creates, updates, retrieves, and deletes query gro

<!-- spec_insert_start
api: wlm.create_query_group
component: paths_and_http_methods
component: endpoints
omit_header: true
-->
```json
Expand All @@ -29,7 +29,7 @@ PUT /_wlm/query_group

<!-- spec_insert_start
api: wlm.create_query_group
component: paths_and_http_methods
component: endpoints
omit_header: true
-->
```json
Expand All @@ -41,7 +41,7 @@ PUT /_wlm/query_group

<!-- spec_insert_start
api: wlm.get_query_group
component: paths_and_http_methods
component: endpoints
omit_header: true
-->
```json
Expand All @@ -54,7 +54,7 @@ GET /_wlm/query_group/{name}

<!-- spec_insert_start
api: wlm.create_query_group
component: paths_and_http_methods
component: endpoints
omit_header: true
-->
```json
Expand Down

0 comments on commit 3161025

Please sign in to comment.