Conversation
Signed-off-by: András Felleg <afelleg@gmail.com>
Signed-off-by: András Felleg <afelleg@gmail.com>
Signed-off-by: András Felleg <afelleg@gmail.com>
Signed-off-by: András Felleg <afelleg@gmail.com>
Signed-off-by: András Felleg <afelleg@gmail.com>
Signed-off-by: András Felleg <afelleg@gmail.com>
Signed-off-by: András Felleg <afelleg@gmail.com>
Signed-off-by: András Felleg <afelleg@gmail.com>
Signed-off-by: András Felleg <afelleg@gmail.com>
Contributor
Author
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
|
Andris28
changed the title
Signed-off-by: András Felleg <afelleg@gmail.com>
pyrooka
requested changes
Sep 15, 2026
pyrooka
left a comment
pyrooka
left a comment
Member
There was a problem hiding this comment.
The output looks good so far, but we should tweak the logic a bit.
|
|
||
| // 2-col table | ||
| expect(lines[10]).toBe( | ||
| '### [ibm-integer-attributes](https://github.com/IBM/openapi-validator/blob/main/docs/ibm-cloud-rules.md#ibm-integer-attributes)' |
Member
There was a problem hiding this comment.
According to the GH Pages deploy actions, the correct URL is https://ibm.github.io/openapi-validator/docs/ibm-cloud-rules.html. See here
Comment on lines
+229
to
+239
| function getDocumentationURL(ruleCode) { | ||
| if (ruleCode.includes('ibm')) { | ||
| const baseUrl = | ||
| 'https://ibm.github.io/openapi-validator/docs/ibm-cloud-rules.html'; | ||
| return `${baseUrl}#${ruleCode}`; | ||
| } else { | ||
| const baseUrl = | ||
| 'https://meta.stoplight.io/docs/spectral/4dec24461f3af-open-api-rules'; | ||
| return `${baseUrl}#${ruleCode}`; | ||
| } | ||
| } |
Member
There was a problem hiding this comment.
Looks like you are hardcoding the documentation URL in this file. Have you checked the documentationUrl that is already exists by spectral? We already set it but needs to be updated:
I think we should leverage this when setting getting the URL.
Also, we might not even need to check the namespace of the rule (IBM or Spectral), because - hopefully - spectral rules have the same field set, pointing to the correct URL. According to the doc that I linked, the correct URL is put together by Spectral, so you don't need to do it manually
The rule name is appended to the link as an anchor.
This must be doubled checked though!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In this commit we implement a 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.