feat: add reference property to context.report() for external documentation #1969
Conversation
This file contains 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
Add the `reference` property to the `context.report()` method for external documentation links. Fix #1052 * **Documentation**: Update `docs/custom-plugins/custom-rules.md` to include the `reference` property in the `context.report()` method documentation. * **New Rule**: Add `packages/core/src/rules/arazzo/reference-property.ts` to implement a new rule for validating the `reference` property in the report object. * **Rule Integration**: Modify `packages/core/src/rules/arazzo/index.ts` to import and add the new `reference-property` rule to the existing rules. * **Unit Tests**: Add `packages/core/src/rules/arazzo/__tests__/reference-property.test.ts` to test the presence and format validation of the `reference` property and error reporting for missing or incorrect `reference` property.
|
ImBIOS
changed the title
Coverage reportMultiple errors occurred
Show files with reduced coverage 🔻
Test suite run failedFailed tests: 0/846. Failed suites: 51/195.Report generated by 🧪jest coverage report action from fbe438a |
- Implement `isValidURL` utility function in `utils.ts` with comprehensive URL validation - Add extensive test cases for URL validation in `utils.test.ts` - Update Arazzo reference property rule to validate URLs using new utility - Add `reference` property to Arazzo criteria type definition - Enable `reference-property` rule in built-in Arazzo rules
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| operationId: museum-api.getMuseumHours | ||
| successCriteria: | ||
| - condition: $statusCode == 200 | ||
| reference: invalid-url |
There was a problem hiding this comment.
This is not according to the Arazzo specification and I would prefer not to add additional properties to Criterion Object. In case we need one - this can be extension, before accepted and added to the Spec itself.
There was a problem hiding this comment.
In fact reference field already exist in Arazzo, but used for different type Reusable Object.
There was a problem hiding this comment.
This test is completely wrong.
RomanHotsiy
requested changes
Mar 3, 2025
| } | ||
| }); | ||
| }); | ||
| describe('isValidURL', () => { |
There was a problem hiding this comment.
I don't think we need so many tests for this. I would also not validate this at all. I would add a very basic URL validation.
There was a problem hiding this comment.
you're right, URL constructor is also more performant and reliable.
| operationId: museum-api.getMuseumHours | ||
| successCriteria: | ||
| - condition: $statusCode == 200 | ||
| reference: invalid-url |
There was a problem hiding this comment.
This test is completely wrong.
|
I'm sorry. I misunderstood the issue. It should not be a new rule; it should just be an additional string in the reporter.
✌️ Sorry, I'm the one hallucinating. Yeah, I even laugh and feel embarrassed after re-reading the issue. |
- Remove `isValidURL` utility function from `utils.ts` - Delete Arazzo `reference-property` rule and its test file - Remove `reference-property` from Arazzo rules index - Add `reference` property to `Problem` and `NormalizedProblem` types in `walk.ts` - Update `formatProblems` to display reference URL when present - Add reference URL to `no-schema-type-mismatch` rule - Update related test cases to include reference property
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What/Why/How?
Add the
referenceproperty to thecontext.report()method for external documentation links.docs/custom-plugins/custom-rules.mdto include thereferenceproperty in thecontext.report()method documentation.packages/core/src/rules/arazzo/reference-property.tsto implement a new rule for validating thereferenceproperty in the report object.packages/core/src/rules/arazzo/index.tsto import and add the newreference-propertyrule to the existing rules.packages/core/src/rules/arazzo/__tests__/reference-property.test.tsto test the presence and format validation of thereferenceproperty and error reporting for missing or incorrectreferenceproperty.Reference
Fix #1052
Testing
ran npm run test
Screenshots (optional)
Check yourself
Security