Resolving JSON schema failing

[wework]

Resolving JSON schema failing

[MikeRalphson]

Do you get a warning if you specify --verbose?

[simondean]

Just checked and yes there's a warning if I specify --verbose

Without verbose:

$ node_modules/.bin/speccy lint openapi.yaml
Specification schema is invalid.

#/paths/~1example/get/responses/200/content/application~1json
expected '{\n  "type": "object"\n  "properties": {\n    "example": {\n      "type": "string"\n    }\n  }\n}\n' to be an object
    expected '{\n  "type": "object"\n  "properties": {\n    "example": {\n      "type": "string"\n    }\n  }\n}\n' to have type object
        expected 'string' to be 'object'

With verbose:

$ node_modules/.bin/speccy lint openapi.yaml --verbose
GET openapi.yaml
GET example-schema.json 
{ YAMLException: missed comma between flow collection entries at line 3, column 3:
      "properties": {
      ^
    at generateError (node_modules/js-yaml/lib/js-yaml/loader.js:165:10)
    at throwError (node_modules/js-yaml/lib/js-yaml/loader.js:171:9)
    at readFlowCollection (node_modules/js-yaml/lib/js-yaml/loader.js:691:7)
    at composeNode (node_modules/js-yaml/lib/js-yaml/loader.js:1333:11)
    at readBlockMapping (node_modules/js-yaml/lib/js-yaml/loader.js:1009:16)
    at composeNode (node_modules/js-yaml/lib/js-yaml/loader.js:1332:12)
    at readDocument (node_modules/js-yaml/lib/js-yaml/loader.js:1492:3)
    at loadDocuments (node_modules/js-yaml/lib/js-yaml/loader.js:1548:5)
    at load (node_modules/js-yaml/lib/js-yaml/loader.js:1569:19)
    at Object.safeLoad (node_modules/js-yaml/lib/js-yaml/loader.js:1591:10)
  name: 'YAMLException',
  reason: 'missed comma between flow collection entries',
  mark: 
   Mark {
     name: null,
     buffer: '{\n  "type": "object"\n  "properties": {\n    "example": {\n      "type": "string"\n    }\n  }\n}\n\u0000',
     position: 23,
     line: 2,
     column: 2 },
  message: 'missed comma between flow collection entries at line 3, column 3:\n      "properties": {\n      ^' }
Creating initial clone of data at #/paths/~1example/get/responses/200/content/application~1json/schema
Finished resolution! 
Found 14 rules: parameter-description,operation-operationId,operation-summary-or-description,operation-tags,server-trailing-slash,openapi-tags,openapi-tags-alphabetical,reference-no-other-properties,example-value-or-externalValue,reference-components-regex,no-script-tags-in-markdown,info-contact,license-apimatic-bug,no-eval-in-descriptions
Specification schema is invalid.

#/paths/~1example/get/responses/200/content/application~1json
expected '{\n  "type": "object"\n  "properties": {\n    "example": {\n      "type": "string"\n    }\n  }\n}\n' to be an object
    expected '{\n  "type": "object"\n  "properties": {\n    "example": {\n      "type": "string"\n    }\n  }\n}\n' to have type object
        expected 'string' to be 'object'

[philsturgeon]

I'm gonna punt this one off to @MikeRalphson I think 😛

[MikeRalphson]

I'll make a note to look into whether the target of a $ref can ever be other than json or yaml in the upcoming release of openapi-kit, but for now I'll expose those warnings even when verbose isn't set.

[philsturgeon]

This has been solved through improving error messages in #37. Thank you @MikeRalphson!