Examples should allow error results

[BelfordZ]

This would also make automated testing tools able to test against failing cases.

[BelfordZ]

Since all result & param reference ExampleObjects, and example objects aren't really structured to be examples of errors, im wondering what the value for examplePairings.error should be?

[BelfordZ]

Should you be able to ref an ErrorObject? ie:

{
  "name": "examplepair",
  "params": [...],
  "error": { "$ref": "components/errors/bigbad" }
}

[BelfordZ]

Should it be the same as the others, use ExampleObject.value and provide the whole error object?

{
  "name": "examplepair",
  "params": [...],
  "error": { 
    "name": "big bad example", 
    "value": {
      "code": 404, 
      "message": "dog ate homework", 
      "data": {}
     }
   }
}

[BelfordZ]

either?

[shanejonas]

hm maybe value itself should be the raw error or a ref?