You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Issue described by Chris Wood at Ozone API in this talk.
Description:
TypeSpec currently does not support setting the additionalProperties keyword to false. This is a significant issue for financial services APIs, where it is crucial to prevent the inclusion of extra properties that are not explicitly defined in the schema.
In many open banking and open finance standards, it is essential to enforce strict schemas to ensure data integrity and compliance with regulatory requirements. The inability to set additionalProperties to false leads to potential schema violations and requires additional manual steps to correct the emitted Open API document.
Steps to Reproduce:
Define a schema in TypeSpec.
Attempt to set additionalProperties to false.
Emit the Open API document.
Observe that the additionalProperties setting is not applied.
Expected Behavior:
TypeSpec should allow setting additionalProperties to false, ensuring that no extra properties are allowed in the JSON objects defined by the schema.
Actual Behavior:
The emitted Open API document does not include the additionalProperties setting, allowing extra properties to be included in the JSON objects.
Additional Context:
Enhancing TypeSpec to support the additionalProperties keyword would improve the accuracy and compliance of the emitted Open API documents, particularly for financial services APIs that require strict schema enforcement.
Clear and concise description of the problem
Issue described by Chris Wood at Ozone API in this talk.
Description:
TypeSpec currently does not support setting the
additionalProperties
keyword tofalse
. This is a significant issue for financial services APIs, where it is crucial to prevent the inclusion of extra properties that are not explicitly defined in the schema.In many open banking and open finance standards, it is essential to enforce strict schemas to ensure data integrity and compliance with regulatory requirements. The inability to set
additionalProperties
tofalse
leads to potential schema violations and requires additional manual steps to correct the emitted Open API document.Steps to Reproduce:
additionalProperties
tofalse
.additionalProperties
setting is not applied.Expected Behavior:
TypeSpec should allow setting
additionalProperties
tofalse
, ensuring that no extra properties are allowed in the JSON objects defined by the schema.Actual Behavior:
The emitted Open API document does not include the
additionalProperties
setting, allowing extra properties to be included in the JSON objects.Additional Context:
Enhancing TypeSpec to support the
additionalProperties
keyword would improve the accuracy and compliance of the emitted Open API documents, particularly for financial services APIs that require strict schema enforcement.Checklist
The text was updated successfully, but these errors were encountered: