API-30 FetchingData.FetchingResources #55
Merged
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
This commit introduces a new set of Spectral rules specifically tailored for validating JSON:API v1.0 Fetching Data - Fetching Resources within an OpenAPI Document. Key highlights include: - Creation of Spectral rules to ensure compliance with JSON:API v1.0 standards, focusing on Fetching Resources specifications. - Validating that a server MUST supprt fetching resource data for every URL that is provided to a strict format. These additions significantly improve our capability to automatically validate and ensure the consistency of API responses with the JSON:API v1.0 standard.
This document serves as a standardized template for verifying positive test scenarios in ruleset development. To ensure that the document can be tested against multiple rulesets, the design and endpoints were refactored. This document is now closer to adhering to JSON:API v1.0 specifications. Covered sections include: - ContentNegotiation.ClientResponsibilities - ContentNegotiation.ServerResponsibilities - DocumentStructure - DocumentStructure.TopLevel - DocumentStructure.ResourceObjects - DocumentStructure.ResourceObjects.Attributes - DocumentStructure.Links - DocumentStructure.MetaInformation - DocumentStructure.MemberNames - FetchingData.FetchingResources - FetchingData.Sorting - FetchingData.Pagination - FetchingData.Filtering - Errors.ProcessingErrors - Errors.ErrorObjects
This commit marks the completion of detailed test cases for all of the JSON:API v1.0 Fetching Data - Fetching Resources ruleset. These updates significantly improve the robustness and relaibility of the JSON:API v1.0 specifications for Fetching Resources validation process.
- These two files provides a way to test all the created rules for both positive and negative scenarios. - Created a failing-rules.yaml which generates a way to trigger all the rules to display the error message - Updated the passing-rules.yaml to adhere to the specifications of JSON:API v1.0 for Fetching Resources.
AkshayPathakMLF
approved these changes
Dec 27, 2023
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.
Added New Spectral Rules for JSON:API v1.0 FetchingData.FetchingResources
This introduces a new set of Spectral rules specifically tailored for validation JSON:API v1.0 Fetching Data - Fetching Resources within an OpenAPI Document. Key Highlights Include:
These additions significantly improve our capability to automatically validate and ensure the consistency of API responses with the JSON:API v1.0 standard.