-
Notifications
You must be signed in to change notification settings - Fork 38
Description
Question on the example prop. Not sure if this is a bug or something I am misunderstanding
An example code block like this:
/** Status
* @oaSchemaProp default
* "Active"
*/
// prettier-ignore
status: "Active" | "Inactive";
When generating the contract, this throws an error like:
Error: property must be compliant with union type or property not allowed
Is this not a valid piece of documentation? This works if status is of type String but the whole point is to have Status limited to certain specific string values and to tell the user what it defaults to. The example prop does not throw an error in this same case but there is definitely a difference between example and default in terms of messaging to the user. Any thoughts?
Hopefully doesn't matter but I am on Node v12.18.3 and using the latest version of Spot @1.9.0
Edit: the issue is still prevalent when trying to use @default "Active"