@oaSchemaProp example fails with numerical strings

[mneumann]

Describe the bug

When using @oaSchemaProp example, providing a numerical string like "123.3" for a String type fails:

 /**
   * @oaSchemaProp example
   * "123.3"
   */
  amount: String;

Error: property type is wrong or property not allowed
    at Object.extractJSDocSchemaProps (.../api-spec/node_modules/@airtasker/spot/build/lib/src/parsers/schemaprop-parser.js:116:31)

As "123.3" is a String, this should work.

[Thodin3]

Ok I can fix this one

[Thodin3]

There is also some other linked issues :
When using @oaSchemaProp default for Date or DateTime type it fails:

/** property-schemaprop date
   * @oaSchemaProp example
   * "1990-12-31"
   *  */
  "property-with-date": Date;

When using @oaSchemaProp example for Object or Array type it fails:

/** property-schemaprop array of integer
   * @oaSchemaProp example
   * [1990,12,31]
   *  */
  "property-with-array": Integer[];

When using @oaSchemaProp example for Union or Intersection type it fails:

/** property-schemaprop union of string
* @oaSchemaProp example
* "WAITING"
*  */
code?: "VALID" | "NOT_VALID" | "WAITING" | "APPROVED";

[Thodin3]

Proposal :
in function extractJSDocSchemaProps(
const typeOf will be refactor and will use the JSON.parse real type instead of regexp filtering.

[amoghsharma1996]

Examples seem to work fine now, but the default oaSchemaProp seems busted for enum strings.

For example

  /** Status
   * @oaSchemaProp default
   * "Active"
   */
  // prettier-ignore
  status: "Active" | "Closed"

Throws an error

[Thodin3]

Hello @amoghsharma1996,

It's seems to be a bug.
Normally this is same check rules for both example and default.
Could you try @default instead of @oaSchemaProp default?
@default is on one line.

[amoghsharma1996]

Hey @Thodin3 same issue trying default.

Whether I try it on 1 line versus 2 lines:

@default "Active"
or

@default
"Active"

In either scenario I still receive the same error,
Error: property must be compliant with union type or property not allowed

I have opened up an issue to track this #1761