Fail on missing properties.

[dblock]

Description

A large category of bugs in the schema is that some fields are missing. For example, the distribution filed in the response from GET / was added in #336.

We should have detected the missing field in tests. Had the info schema had additionalProperties: false the schema validation would have failed with "data/version must NOT have additional properties". However adding that option means that our published schema cannot be future-proof for when new fields are added.

This PR dynamically injects additionalProperties: ... with ajv-errors that allows to custom render an error message that contains the property name that is missing.

For now it only applies to any set of properties with a required field. Otherwise it creates some false positives on index responses with dynamic mappings.

With this change:

npm run test:spec -- --verbose --tests tests/_core/info.yaml --opensearch-insecure

FAILED  Test root endpoint. (/Users/dblock/source/opensearch-project/opensearch-api-specification/dblock-opensearch-api-specification/tests/_core/info.yaml)
    FAILED  CHAPTERS 
        FAILED  Get server info. 
            PASSED  REQUEST BODY 
            PASSED  RESPONSE STATUS 
            FAILED  RESPONSE PAYLOAD (data/version/distribution property is not defined in the spec)

You get all the errors:

FAILED  Test the creation of an ingest pipeline with a text embedding processor.
 (/Users/dblock/source/opensearch-project/opensearch-api-specification/dblock-opensearch-api-specification/tests/ingest/pipeline.yaml)
    FAILED  CHAPTERS 
        FAILED  Create ingest pipeline for text embedding. 
            PASSED  PARAMETERS 
                PASSED  id 
            FAILED  REQUEST BODY (data/processors/0/text_embedding/model_id property is not defined in the spec, data/processors/0/text_embedding/field_map property is not defined in the spec)
            PASSED  RESPONSE STATUS 
            PASSED  RESPONSE PAYLOAD 
        FAILED  Query created pipeline. 
            PASSED  PARAMETERS 
                PASSED  id 
            PASSED  REQUEST BODY 
            PASSED  RESPONSE STATUS 
            FAILED  RESPONSE PAYLOAD (data/books_pipeline/processors/0/text_embedding/model_id property is not defined in the spec, data/books_pipeline/processors/0/text_embedding/field_map property is not defined in the spec)

Issues Resolved

Closes #338.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[github-actions]

Changes Analysis

Commit SHA: b789df6
Comparing To SHA: 16bcb63

API Changes

Summary

└─┬Paths
  └─┬/_plugins/_ml/model_groups/{model_group_id}
    └─┬GET
      └─┬Responses
        └─┬200
          └─┬application/json
            └─┬Schema
              ├──[➕] properties (24437:15)
              └──[➕] properties (24440:15)

Document Element	Total Changes	Breaking Changes
paths	2	0

• Total Changes: 2
• Additions: 2

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/9571977030/artifacts/1614563652

API Coverage

	Before	After	Δ
Covered (%)	483 (47.31 %)	483 (47.31 %)	0 (0 %)
Uncovered (%)	538 (52.69 %)	538 (52.69 %)	0 (0 %)
Unknown	24	24	0

[dblock]

@nhtruong I'll write tests and document this, but would love your thoughts in the meantime please?

[dblock]

@nhtruong @Xtansia this is ready for review