ci: script to validate embedded examples in the asyncapi.md file#1059
Merged
asyncapi-bot merged 92 commits intoasyncapi:masterfrom Jul 5, 2024
Merged
ci: script to validate embedded examples in the asyncapi.md file#1059asyncapi-bot merged 92 commits intoasyncapi:masterfrom
asyncapi-bot merged 92 commits intoasyncapi:masterfrom
Conversation
Changes: - copied files from test branch: https://github.com/AnimeshKumar923/asyncapi-spec/tree/embedded-examples-jsonPath-test/scripts/validation - copied because merge conflict and older files in the previous branch - files required for validation of embedded examples - still a WIP, more modification and refinement will be made in future
mistakenly added this file
Changes: - added comments in the file as suggested by Sergio here: asyncapi#957 (comment) - more comments to be adjusted according to the json format
Contributor
Author
Current State of the scriptThis is what the script currently does as of 915f808:
Future objective: |
Changes: - modified the script so that it can handle component object example - the script as of now add the fields and sub-fields in the updated-doc so that the other references remain unaffected - the earlier version was removinga and adding the whole part of the document altogether which affected the references and dependencies in the entire document
|
@asyncapi/bounty_team |
Changes: - updated the spec file to correctly match the json format and for further parsing - updated the base document to support more of the examples - added missing json version for some of the examples
animeshk923
commented
Jun 12, 2024
animeshk923
commented
Jun 12, 2024
animeshk923
commented
Jun 12, 2024
Changes: - removed the examples added through 4529772 - applied suggestion from: asyncapi#1059 (comment)
Contributor
Author
|
/au |
Changes: - created new base doc removing additional fields under 'securitySchemes'. This is because we have to individuallly validate each examples under the Security Scheme Object. The additional fields were giving error during validation of those examples. - changes the object's name from `test` to `name`. - updated the script according to the changed object's name
Changes: - update script to determine the base doc, whether the 'server scheme object' is present or not - updated both the base docs with more missing fields
Changes: - modified script which now creates an array of extracted examples along with the metadatas of it
This was referenced Jun 14, 2024
Changes: - updated the script to make new documents for each examples in the asyncapi.md, and then store them into a new file for further vaidation process - remove an extra character in asyncapi.md
smoya
reviewed
Jul 5, 2024
smoya
reviewed
Jul 5, 2024
Changes: - trying to maintain the consistency of the single quotes and double quotes
Changes: - the heading was mistakenly deleted during the addition of comments in the spec file
smoya
reviewed
Jul 5, 2024
smoya
reviewed
Jul 5, 2024
Changes: - applied suggestion from: asyncapi#1059 (comment) - applied suggestion from: asyncapi#1059 (comment)
Changes: - modify yaml example which was failing due to not properly formatted structure - update json pointer at one location
smoya
reviewed
Jul 5, 2024
smoya
reviewed
Jul 5, 2024
smoya
reviewed
Jul 5, 2024
Changes: - The json pointer library doesn't supports the URI representation, so to reduce the extra work this change was made
smoya
reviewed
Jul 5, 2024
apply suggestion: asyncapi#1059 (comment) Co-authored-by: Sergio Moya <1083296+smoya@users.noreply.github.com>
Changes: - adjust script according to suggestion: asyncapi#1059 (comment)
smoya
reviewed
Jul 5, 2024
Member
|
/rtm |
Contributor
Author
|
Some tasks remaining (out of bounty scope) |
Contributor
|
🎉 This PR is included in version 3.1.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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
4 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.
Description
Remaining tasks:
Related issue(s):
Resolves #957