beckn / missions

This repo is solely created for the project management of the fide missions. the repo will be utilised for documentation purposes.
MIT License
7 stars 1 forks source link

Add additionalProperties: false to UEI Layer 2 Configuration #162

Closed rajaneeshk90 closed 1 week ago

rajaneeshk90 commented 2 weeks ago

Description:

This PR updates the UEI Layer 2 Configuration OpenAPI YAML document by setting additionalProperties: false in each object schema. This change is intended to enforce strict validation of the API schema, disallowing properties not explicitly defined in the schema.

Changes Made:

Added additionalProperties: false to all object schemas within the UEI Layer 2 Configuration OpenAPI YAML file. Ensured the document aligns with OpenAPI standards to prevent unexpected properties from being accepted in API requests and responses.

Rationale:

Setting additionalProperties: false improves API reliability and data integrity by ensuring clients adhere strictly to the specified schema. This change prevents accidental inclusion of unintended fields, reducing potential data inconsistencies and making the API easier to maintain.

Impact:

Validation: Requests and responses with properties not defined in the schema will now be rejected. Compatibility: Existing clients sending extra properties may need adjustments to conform to the stricter schema validation.

Testing:

Verified that the OpenAPI document is valid and compatible with OpenAPI tools. Tested the schema validation in the application to ensure no unexpected properties are accepted.

Additional Notes:

This update is backward-incompatible with clients that currently rely on unspecified properties.