Misleading information example

[supertong]

Example input:

{
  "version": 1,
  "type": "doc",
  "content": [
    {
      "type": "paragraph",
      "content": [
        {
          "type": "text",
          "text": "test"
        }
      ]
    },
    {
      "type": "mediaSingle",
      "attrs": {
        "layout": "wide"
      },
      "content": [
        {
          "type": "media",
          "attrs": {
            "id": "cfb55f7b-68be-42ac-9930-216f754805a1",
            "type": "file",
            "collection": "",
            "occurrenceKey": null,
            "width": null
          }
        }
      ]
    },
    {
      "type": "paragraph",
      "content": [
        {
          "type": "text",
          "text": " "
        }
      ]
    }
  ]
}

and the error message is

{
    "message": "Document field document JSON doesn't comply with Atlassian Document Format Full",
    "meta": {
        "errors": [
            {
                "start": {
                    "line": 1,
                    "column": 109,
                    "offset": 108
                },
                "end": {
                    "line": 1,
                    "column": 122,
                    "offset": 121
                },
                "error": "/content/1/type should be equal to one of the allowed values: orderedList, heading, panel, table, decisionList, taskList, bodiedExtension, codeBlock",
                "suggestion": "Did you mean heading?"
            }
        ]
    },
    "status": 400
}

But the error was actually inside the mediaNode under mediaSingle.

[zanedev]

We're seeing this a lot where the error is very misleading, showing an unrelated error at the top of a nested $ref when the problem is actually in the $ref children somewhere.

[torifat]

@zanedev The whole thing works based on some heuristics. Because in some cases it's really difficult to find the exact error. It would make my life easier if you could share some examples where it doesn't work.

[torifat]

@supertong ajv returns the following error for this case 🤦‍♂

[
    {
      keyword: 'additionalProperties',
      dataPath: '/content/1',
      schemaPath: '#/additionalProperties',
      params: [Object],
      message: 'should NOT have additional properties'
    },
    {
      keyword: 'additionalProperties',
      dataPath: '/content/1',
      schemaPath: '#/additionalProperties',
      params: [Object],
      message: 'should NOT have additional properties'
    },
    {
      keyword: 'additionalProperties',
      dataPath: '/content/1',
      schemaPath: '#/additionalProperties',
      params: [Object],
      message: 'should NOT have additional properties'
    },
    {
      keyword: 'additionalProperties',
      dataPath: '/content/1',
      schemaPath: '#/additionalProperties',
      params: [Object],
      message: 'should NOT have additional properties'
    },
    {
      keyword: 'type',
      dataPath: '/content/1/content/0/attrs/width',
      schemaPath: '#/definitions/media_node/properties/attrs/anyOf/0/properties/width/type',
      params: [Object],
      message: 'should be number'
    },
    {
      keyword: 'additionalProperties',
      dataPath: '/content/1/content/0/attrs',
      schemaPath: '#/definitions/media_node/properties/attrs/anyOf/1/additionalProperties',
      params: [Object],
      message: 'should NOT have additional properties'
    },
    {
      keyword: 'anyOf',
      dataPath: '/content/1/content/0/attrs',
      schemaPath: '#/definitions/media_node/properties/attrs/anyOf',
      params: {},
      message: 'should match some schema in anyOf'
    },
    {
      keyword: 'enum',
      dataPath: '/content/1/type',
      schemaPath: '#/properties/type/enum',
      params: [Object],
      message: 'should be equal to one of the allowed values'
    },
    {
      keyword: 'enum',
      dataPath: '/content/1/type',
      schemaPath: '#/properties/type/enum',
      params: [Object],
      message: 'should be equal to one of the allowed values'
    },
    {
      keyword: 'enum',
      dataPath: '/content/1/type',
      schemaPath: '#/properties/type/enum',
      params: [Object],
      message: 'should be equal to one of the allowed values'
    },
    {
      keyword: 'enum',
      dataPath: '/content/1/type',
      schemaPath: '#/properties/type/enum',
      params: [Object],
      message: 'should be equal to one of the allowed values'
    },
    {
      keyword: 'enum',
      dataPath: '/content/1/type',
      schemaPath: '#/properties/type/enum',
      params: [Object],
      message: 'should be equal to one of the allowed values'
    },
    {
      keyword: 'enum',
      dataPath: '/content/1/type',
      schemaPath: '#/properties/type/enum',
      params: [Object],
      message: 'should be equal to one of the allowed values'
    },
    {
      keyword: 'enum',
      dataPath: '/content/1/type',
      schemaPath: '#/properties/type/enum',
      params: [Object],
      message: 'should be equal to one of the allowed values'
    },
    {
      keyword: 'additionalProperties',
      dataPath: '/content/1',
      schemaPath: '#/additionalProperties',
      params: [Object],
      message: 'should NOT have additional properties'
    },
    {
      keyword: 'additionalProperties',
      dataPath: '/content/1',
      schemaPath: '#/definitions/rule_node/additionalProperties',
      params: [Object],
      message: 'should NOT have additional properties'
    },
    {
      keyword: 'additionalProperties',
      dataPath: '/content/1',
      schemaPath: '#/additionalProperties',
      params: [Object],
      message: 'should NOT have additional properties'
    },
    {
      keyword: 'additionalProperties',
      dataPath: '/content/1',
      schemaPath: '#/definitions/applicationCard_node/additionalProperties',
      params: [Object],
      message: 'should NOT have additional properties'
    },
    {
      keyword: 'enum',
      dataPath: '/content/1/type',
      schemaPath: '#/properties/type/enum',
      params: [Object],
      message: 'should be equal to one of the allowed values'
    },
    {
      keyword: 'enum',
      dataPath: '/content/1/type',
      schemaPath: '#/properties/type/enum',
      params: [Object],
      message: 'should be equal to one of the allowed values'
    },
    {
      keyword: 'enum',
      dataPath: '/content/1/type',
      schemaPath: '#/properties/type/enum',
      params: [Object],
      message: 'should be equal to one of the allowed values'
    },
    {
      keyword: 'additionalProperties',
      dataPath: '/content/1',
      schemaPath: '#/definitions/extension_node/additionalProperties',
      params: [Object],
      message: 'should NOT have additional properties'
    },
    {
      keyword: 'enum',
      dataPath: '/content/1/type',
      schemaPath: '#/properties/type/enum',
      params: [Object],
      message: 'should be equal to one of the allowed values'
    },
    {
      keyword: 'additionalProperties',
      dataPath: '/content/1',
      schemaPath: '#/definitions/blockCard_node/additionalProperties',
      params: [Object],
      message: 'should NOT have additional properties'
    },
    {
      keyword: 'additionalProperties',
      dataPath: '/content/1',
      schemaPath: '#/additionalProperties',
      params: [Object],
      message: 'should NOT have additional properties'
    },
    {
      keyword: 'anyOf',
      dataPath: '/content/1',
      schemaPath: '#/properties/content/items/anyOf',
      params: {},
      message: 'should match some schema in anyOf'
    }
  ]