Repository navigation
feat: implement new result output format for validation - #821
Conversation
Here is an example of how the new markdown output will look like:Demo Bookstore APIVersion: 1.0.0 Quick view
The API impact score, also known as the "Automated Quality Screening" score, is calculated Breakdown by category
The "overall" impact score is the average (mean) of the categorized scores. The categorized scores are Scoring informationInformation about how the scoring gets calculated
Error summary
Warning summary
Detailed resultsErrorsibm-integer-attributesInteger schemas should define property 'minimum'
ibm-required-enum-properties-in-responseIn a response body, an enumeration field MUST be required
ibm-enum-casing-conventionEnum values must be snake case
ibm-required-array-properties-in-responseIn a response body, an array field MUST NOT be optional
Warningsibm-prefer-token-paginationToken-based pagination is recommended over offset/limit pagination
operation-descriptionOperation "description" must be present and non-empty string.
ibm-operationid-casing-conventionOperation ids must be snake case
ibm-operationid-naming-conventionoperationIds should follow naming convention
ibm-pagination-styleThe 'limit' parameter must be of type integer and optional with default and maximum values
ibm-success-response-exampleResponse bodies should include an example response
ibm-response-status-codesOperation responses should use status code 400 instead of 422 for invalid request payloads
ibm-string-attributesString schemas should define property 'pattern'
ibm-patch-request-content-typePATCH operations should support content types application/json-patch+json or application/merge-patch+json
ibm-parameter-descriptionParameters should have a non-empty description
ibm-schema-naming-conventionPrototype schema (POST request body) for path '/books' should use the name
ibm-array-attributesArray schemas should define a numeric 'minItems' field
ibm-error-response-schemasError container model should contain property 'trace' of type string
ibm-avoid-inline-schemasNested objects should be defined as a $ref to a named schema
|
pyrooka
left a comment
There was a problem hiding this comment.
The output looks good so far, but we should tweak the logic a bit.
972f950 to
313dfba
Compare
pyrooka
left a comment
There was a problem hiding this comment.
Left a few more comments to discuss. Also, I tend to forget this, but please also update the copyright years in the changed files.
pyrooka
left a comment
There was a problem hiding this comment.
Just a few comments to discuss. 😄
pyrooka
left a comment
There was a problem hiding this comment.
A few more smallish comments that would be nice to address. We are getting really close though!
pyrooka
left a comment
There was a problem hiding this comment.
Sorry for nitpicking but I found a few really small things that would be good to address before merging. They should be fairly simple to address.
pyrooka
left a comment
There was a problem hiding this comment.
Thanks for addressing my comments, the PR looks pretty good, so I think it's ready to be merged. Great job!
d4fffe3 to
95d38d4
Compare
Signed-off-by: András Felleg <afelleg@gmail.com>
95d38d4 to
09d440b
Compare
In this commit we implement a change,
where the result of the validation contains
the documentation link to the rule that has
been violated. There is also a change for the
markdown report, to have the results grouped
by the rules.