Added support for request headers. (#461)

* Renamed request_body to request.

Signed-off-by: dblock <dblock@amazon.com>

* Added npm run generate-types.

Signed-off-by: dblock <dblock@amazon.com>

* Added support for request headers.

Signed-off-by: dblock <dblock@amazon.com>

---------

Signed-off-by: dblock <dblock@amazon.com>

Author: dblock

CHANGELOG.md

@@ -54,13 +54,14 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added `plugins` to NodeInfoSettings ([#442](https://github.com/opensearch-project/opensearch-api-specification/pull/442)) 
 - Added test coverage ([#443](https://github.com/opensearch-project/opensearch-api-specification/pull/443))
 - Added `--opensearch-version` to `merger` that excludes schema elements per semver ([#428](https://github.com/opensearch-project/opensearch-api-specification/pull/428))
-- Added `retry` to `tester` to support asynchronous tasks ([453](https://github.com/opensearch-project/opensearch-api-specification/pull/453))
+- Added `retry` to `tester` to support asynchronous tasks ([#453](https://github.com/opensearch-project/opensearch-api-specification/pull/453))
 - Added passing OPENSEARCH_JAVA_OPTS into the docker container used for tests ([#454](https://github.com/opensearch-project/opensearch-api-specification/pull/454))
 - Added a warning on mulitple paths being tested in the same file ([#452](https://github.com/opensearch-project/opensearch-api-specification/pull/452))
 - Added validation of titles and descriptions in info and schema objects ([#463](https://github.com/opensearch-project/opensearch-api-specification/pull/463))
 - Added `/_plugins/_query/settings` ([#456](https://github.com/opensearch-project/opensearch-api-specification/pull/456))
 - Added `/_plugins/_ppl`, `explain` and `stats` ([#460](https://github.com/opensearch-project/opensearch-api-specification/pull/460))
 - Added tests against OpenSearch 3.0 ([#459](https://github.com/opensearch-project/opensearch-api-specification/pull/459))
+- Added support for request headers in tests [#461](https://github.com/opensearch-project/opensearch-api-specification/pull/461)
 
 ### Changed
 

TESTING_GUIDE.md

@@ -75,10 +75,12 @@ chapters:
   - synopsis: Create an index named `books` with mappings and settings.
     path: /{index} # The test will fail if "PUT /{index}" operation is not found in the spec.
     method: PUT
-    parameters: # All parameters are validated against their schemas in the spec
+    parameters: # All parameters are validated against their schemas in the spec.
       index: books
-    request_body: # The request body is validated against the schema of the requestBody in the spec
-      payload:
+    request: # The request.
+      headers: # Optional headers.
+        user-agent: OpenSearch API Spec/1.0
+      payload: # The request body is validated against the schema of the requestBody in the spec.
         mappings:
           properties:
             name:
@@ -88,7 +90,8 @@ chapters:
         settings:
           number_of_shards: 5
           number_of_replicas: 2
-    response: # The response body is validated against the schema of the corresponding response in the spec
+    response: # The response.
+      payload: # Matching response payload. The entire payload is validated against the schema of the corresponding response in the spec.
       status: 200 # This is the expected status code of the response. Any other status code will fail the test.
 
   - synopsis: Retrieve the mappings and settings of the `books` index.
@@ -113,7 +116,7 @@ Consider the following chapters in [ml/model_groups](tests/ml/model_groups.yaml)
     id: create_model_group # Only needed if you want to refer to this chapter in another chapter.
     path: /_plugins/_ml/model_groups/_register
     method: POST
-    request_body:
+    request:
       payload:
         name: NLP_Group
         description: Model group for NLP models.