Add reference property to context.report() for external documentation #1904
+130
−0
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 Redocly#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.
|
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.
Add the
referenceproperty to thecontext.report()method for external documentation links.Fix #1052
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.