Validate titles and descriptions in info and schema objects. (#463)

Signed-off-by: dblock <[email protected]>

CHANGELOG.md

@@ -57,6 +57,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - 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))

TESTING_GUIDE.md

@@ -115,8 +115,8 @@ Consider the following chapters in [ml/model_groups](tests/ml/model_groups.yaml)
     method: POST
     request_body:
       payload:
-        name: "NLP_Group"
-        description: "Model group for NLP models"
+        name: NLP_Group
+        description: Model group for NLP models.
     response:
       status: 200
     output: # Save the model group id for later use.

json_schemas/test_story.schema.yaml

@@ -94,7 +94,7 @@ definitions:
       The values are paths to the values in the response.
       The values should be in the form:
       - `payload.<payload-path>` for the payload
-      - `headers.<header-name>` for the headers
+      - `headers.<header-name>` for the headers.
     type: object
     additionalProperties:
       type: string

package.json

@@ -30,6 +30,7 @@
     "@types/lodash": "^4.14.202",
     "@types/node": "^20.10.3",
     "@types/qs": "^6.9.15",
+    "@types/titlecase": "^1.1.2",
     "@types/tmp": "^0.2.6",
     "@typescript-eslint/eslint-plugin": "^6.21.0",
     "ajv": "^8.13.0",
@@ -52,6 +53,7 @@
     "lodash": "^4.17.21",
     "qs": "^6.12.1",
     "smile-js": "^0.7.0",
+    "titlecase": "^1.1.3",
     "tmp": "^0.2.3",
     "ts-jest": "^29.1.2",
     "ts-node": "^10.9.1",