[Feature Request] improve reporting for missing/incorrect examples
#588 opened on Jul 26, 2022
Repository metrics
- Stars
- (2,929 stars)
- PR merge metrics
- (PR metrics pending)
Description
💡 Idea
Today, RESTler does not provide detailed diagnostics on which request types do not have associated examples or which examples did not match the schema of the spec (and hence were only partially used / may contain errors). This is useful to have in order to more quickly fix examples to improve coverage.
Design Notes
One way to improve this is for the compiler to produce an output file with any detected problems in examples, which would contain this information. For example, as a starting point the file could simply include requests which do not contain examples and for which examples do not match the schema.
{
"/customer": {
"post": {
"examples": {
"first example": {
"matches_schema": false
}
}
}
},
"/customer/{id}": {
"get": {
"examples": {}
}
}
}