-
-
Notifications
You must be signed in to change notification settings - Fork 274
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ci: script to validate embedded examples in the asyncapi.md file #1059
ci: script to validate embedded examples in the asyncapi.md file #1059
Commits on Jun 7, 2024
-
chore: copy files from test branch
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
Configuration menu - View commit details
-
Copy full SHA for 915f808 - Browse repository at this point
Copy the full SHA 915f808View commit details -
Configuration menu - View commit details
-
Copy full SHA for 74e3080 - Browse repository at this point
Copy the full SHA 74e3080View commit details
Commits on Jun 8, 2024
-
fix: add comment in asyncapi.md for validation
Changes: - added comments in the file as suggested by Sergio here: asyncapi#957 (comment) - more comments to be adjusted according to the json format
Configuration menu - View commit details
-
Copy full SHA for 0515628 - Browse repository at this point
Copy the full SHA 0515628View commit details -
Configuration menu - View commit details
-
Copy full SHA for f64f32c - Browse repository at this point
Copy the full SHA f64f32cView commit details
Commits on Jun 10, 2024
-
fix: update script to handle component object ex
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
Configuration menu - View commit details
-
Copy full SHA for 532c4c2 - Browse repository at this point
Copy the full SHA 532c4c2View commit details
Commits on Jun 11, 2024
-
fix: update comments in spec, update base doc
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
Configuration menu - View commit details
-
Copy full SHA for 4529772 - Browse repository at this point
Copy the full SHA 4529772View commit details
Commits on Jun 12, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 293a172 - Browse repository at this point
Copy the full SHA 293a172View commit details -
Configuration menu - View commit details
-
Copy full SHA for dd069b0 - Browse repository at this point
Copy the full SHA dd069b0View commit details -
Configuration menu - View commit details
-
Copy full SHA for 544d999 - Browse repository at this point
Copy the full SHA 544d999View commit details -
chore: remove added JSON examples
Changes: - removed the examples added through 4529772 - applied suggestion from: asyncapi#1059 (comment)
Configuration menu - View commit details
-
Copy full SHA for a51107d - Browse repository at this point
Copy the full SHA a51107dView commit details
Commits on Jun 13, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 34dd72a - Browse repository at this point
Copy the full SHA 34dd72aView commit details -
fix: update file, create new base doc
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
Configuration menu - View commit details
-
Copy full SHA for 150f3f5 - Browse repository at this point
Copy the full SHA 150f3f5View commit details -
fix: update script, update base doc
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
Configuration menu - View commit details
-
Copy full SHA for 9986715 - Browse repository at this point
Copy the full SHA 9986715View commit details
Commits on Jun 14, 2024
-
Changes: - modified script which now creates an array of extracted examples along with the metadatas of it
Configuration menu - View commit details
-
Copy full SHA for 5806a60 - Browse repository at this point
Copy the full SHA 5806a60View commit details -
Configuration menu - View commit details
-
Copy full SHA for 96871f5 - Browse repository at this point
Copy the full SHA 96871f5View commit details -
Configuration menu - View commit details
-
Copy full SHA for 375070a - Browse repository at this point
Copy the full SHA 375070aView commit details -
fix: update script, update asyncapi.md
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
Configuration menu - View commit details
-
Copy full SHA for ef231f0 - Browse repository at this point
Copy the full SHA ef231f0View commit details
Commits on Jun 15, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 9ad0cc8 - Browse repository at this point
Copy the full SHA 9ad0cc8View commit details -
Configuration menu - View commit details
-
Copy full SHA for 1d806c6 - Browse repository at this point
Copy the full SHA 1d806c6View commit details
Commits on Jun 16, 2024
-
Configuration menu - View commit details
-
Copy full SHA for f9b725e - Browse repository at this point
Copy the full SHA f9b725eView commit details -
fix: add function to validate the files
Changes: - function to validate files using asyncapi-parser - function to validate files using asyncapi-cli
Configuration menu - View commit details
-
Copy full SHA for 754e50e - Browse repository at this point
Copy the full SHA 754e50eView commit details -
fix: update script, asynchronous validation
Changes: - made the creation, updation and deletion of file dynamic - made the functions asynchronous for faster execution
Configuration menu - View commit details
-
Copy full SHA for d78f639 - Browse repository at this point
Copy the full SHA d78f639View commit details -
chore: update asyncapi.md, improve comments
Changes: - modified the comment due to error while processing the slash ('/') character in the code
Configuration menu - View commit details
-
Copy full SHA for 6878498 - Browse repository at this point
Copy the full SHA 6878498View commit details -
Merge branch 'embedded-examples-ci'
Changes: - merging the changes which I was testing separately to not affect this current branch
Configuration menu - View commit details
-
Copy full SHA for 8534ae3 - Browse repository at this point
Copy the full SHA 8534ae3View commit details -
chore: clear the clutter, rename files, move files
Changes: - cleared out the unnecessary files - move files to appropriate location - rename files to be more meaningful
Configuration menu - View commit details
-
Copy full SHA for 9c82ffa - Browse repository at this point
Copy the full SHA 9c82ffaView commit details -
Configuration menu - View commit details
-
Copy full SHA for 46f32a5 - Browse repository at this point
Copy the full SHA 46f32a5View commit details -
Configuration menu - View commit details
-
Copy full SHA for dc81343 - Browse repository at this point
Copy the full SHA dc81343View commit details -
Configuration menu - View commit details
-
Copy full SHA for 71eebd5 - Browse repository at this point
Copy the full SHA 71eebd5View commit details -
Configuration menu - View commit details
-
Copy full SHA for e1c8798 - Browse repository at this point
Copy the full SHA e1c8798View commit details -
fix: update base doc, update script, update spec
Changes: - updated base doc to support more examples - update script to handle arrays, and cleared the clutter - fixed incorrect comment in the spec file - adding updated files temporarily for debugging purpose
Configuration menu - View commit details
-
Copy full SHA for 6f18cbc - Browse repository at this point
Copy the full SHA 6f18cbcView commit details -
Configuration menu - View commit details
-
Copy full SHA for 9e160c1 - Browse repository at this point
Copy the full SHA 9e160c1View commit details
Commits on Jun 17, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 9d83edf - Browse repository at this point
Copy the full SHA 9d83edfView commit details
Commits on Jun 18, 2024
-
Configuration menu - View commit details
-
Copy full SHA for ac4443f - Browse repository at this point
Copy the full SHA ac4443fView commit details -
Configuration menu - View commit details
-
Copy full SHA for ced626f - Browse repository at this point
Copy the full SHA ced626fView commit details -
Configuration menu - View commit details
-
Copy full SHA for ed55789 - Browse repository at this point
Copy the full SHA ed55789View commit details -
Configuration menu - View commit details
-
Copy full SHA for 4bb29e0 - Browse repository at this point
Copy the full SHA 4bb29e0View commit details -
Configuration menu - View commit details
-
Copy full SHA for b8174d8 - Browse repository at this point
Copy the full SHA b8174d8View commit details -
fix: put comments in proper place
Changes: - similar change to: asyncapi#1059 (comment)
Configuration menu - View commit details
-
Copy full SHA for 10ad1ed - Browse repository at this point
Copy the full SHA 10ad1edView commit details -
fix: update script, remove cli validation
Changes: - removed cli validation - improved regex expression - improved extraction process - added `process.exit(1) at appropriate location, commented out for now, will be included in the final version - applied suggestions from: asyncapi#1059 (comment)
Configuration menu - View commit details
-
Copy full SHA for d7eb944 - Browse repository at this point
Copy the full SHA d7eb944View commit details -
Configuration menu - View commit details
-
Copy full SHA for 53290ea - Browse repository at this point
Copy the full SHA 53290eaView commit details -
fix: modify script to support YAML versions
Changes: - modified script to parse and validate YAML versions of the examples - update package.json and package-lock.json with new dependencies
Configuration menu - View commit details
-
Copy full SHA for cf62169 - Browse repository at this point
Copy the full SHA cf62169View commit details -
Configuration menu - View commit details
-
Copy full SHA for 4cb0ea7 - Browse repository at this point
Copy the full SHA 4cb0ea7View commit details -
Configuration menu - View commit details
-
Copy full SHA for 208afe0 - Browse repository at this point
Copy the full SHA 208afe0View commit details
Commits on Jun 19, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 02cbeb2 - Browse repository at this point
Copy the full SHA 02cbeb2View commit details -
fix: update script, make validation in-memory
Changes: - make script to validate the scripts in the memory itself instead of writing it to disk - applied suggestion from: asyncapi#1059
Configuration menu - View commit details
-
Copy full SHA for e2cc95a - Browse repository at this point
Copy the full SHA e2cc95aView commit details -
Configuration menu - View commit details
-
Copy full SHA for 742a2a2 - Browse repository at this point
Copy the full SHA 742a2a2View commit details -
Configuration menu - View commit details
-
Copy full SHA for 1b97ec1 - Browse repository at this point
Copy the full SHA 1b97ec1View commit details -
fix: update script, update spec, json merge patch
Changes: - update script to be suited for json-merge-patch, - suggested by Sergio via Slack DM more details about merge-patch here: https://datatracker.ietf.org/doc/html/rfc7396 - update spec file with comments suited for json-merge-patch - update dependencies
Configuration menu - View commit details
-
Copy full SHA for 803a30d - Browse repository at this point
Copy the full SHA 803a30dView commit details
Commits on Jun 20, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 2bfc0c8 - Browse repository at this point
Copy the full SHA 2bfc0c8View commit details -
Configuration menu - View commit details
-
Copy full SHA for e017f3b - Browse repository at this point
Copy the full SHA e017f3bView commit details -
Configuration menu - View commit details
-
Copy full SHA for cc79163 - Browse repository at this point
Copy the full SHA cc79163View commit details -
Changes: - update script to match the json_pointer object - add check for the root doc
Configuration menu - View commit details
-
Copy full SHA for 13d56c7 - Browse repository at this point
Copy the full SHA 13d56c7View commit details
Commits on Jun 21, 2024
-
fix: add comments to support array objects
Changes: - update json pointer in spec that support the arrays merge in the base doc - update json pointer to support root doc
Configuration menu - View commit details
-
Copy full SHA for f7fdf63 - Browse repository at this point
Copy the full SHA f7fdf63View commit details -
Configuration menu - View commit details
-
Copy full SHA for fa8b894 - Browse repository at this point
Copy the full SHA fa8b894View commit details -
fix: add missing parameter and values in example
Changes: - modify examples in Operation Object
Configuration menu - View commit details
-
Copy full SHA for 3059384 - Browse repository at this point
Copy the full SHA 3059384View commit details -
Configuration menu - View commit details
-
Copy full SHA for 4ef63f7 - Browse repository at this point
Copy the full SHA 4ef63f7View commit details -
fix: remove array handling code section
Changes: - after removing the section the code was still working fine - for inserting examples inside an array we only need to add the `/0` trailing end in the json_pointer object where deemed necessary
Configuration menu - View commit details
-
Copy full SHA for 3edc981 - Browse repository at this point
Copy the full SHA 3edc981View commit details -
fix: change pointer type to URI Representation
Changes: - change json pointer from String Reperesentation to URI Fragment Identifier Representation - more info here: https://datatracker.ietf.org/doc/html/rfc6901#section-6 - suggested by Sergio for consistency
Configuration menu - View commit details
-
Copy full SHA for f9d057f - Browse repository at this point
Copy the full SHA f9d057fView commit details -
Configuration menu - View commit details
-
Copy full SHA for 3928ef3 - Browse repository at this point
Copy the full SHA 3928ef3View commit details
Commits on Jun 26, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 54fab4b - Browse repository at this point
Copy the full SHA 54fab4bView commit details
Commits on Jul 2, 2024
-
Changes: - deleted temporary files which were added to see the changes happening when the files were being constructed - remove example markdown file which simulated the spec doc for testing purposes - applied suggestions from: asyncapi#1059 (comment)
Configuration menu - View commit details
-
Copy full SHA for f31ff2a - Browse repository at this point
Copy the full SHA f31ff2aView commit details -
fix: OAuth Flow Object example fix
Changes: - modify example to match the correct format of the spec - add new sub-heading to denote what kind of OAuth Flow is - applied suggestion from: asyncapi#1059 (comment)
Configuration menu - View commit details
-
Copy full SHA for 882a512 - Browse repository at this point
Copy the full SHA 882a512View commit details -
Configuration menu - View commit details
-
Copy full SHA for b0d36e7 - Browse repository at this point
Copy the full SHA b0d36e7View commit details -
Configuration menu - View commit details
-
Copy full SHA for e1b0e65 - Browse repository at this point
Copy the full SHA e1b0e65View commit details
Commits on Jul 4, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 7ebc2b3 - Browse repository at this point
Copy the full SHA 7ebc2b3View commit details -
chore: update and add new files
Changes: - preparing a combined docs as per suggestion: asyncapi#1059 (comment) - update script to match the new combined document - delete separate security scheme document
Configuration menu - View commit details
-
Copy full SHA for 91e8478 - Browse repository at this point
Copy the full SHA 91e8478View commit details -
Merge pull request #2 from AnimeshKumar923/spec-examples-fix
This PR contains spec example fixes identified during the validation script's testing.
Configuration menu - View commit details
-
Copy full SHA for 9347567 - Browse repository at this point
Copy the full SHA 9347567View commit details -
Changes: - added a file to track down the issues encountered and their fixes in one place. - Taken from: https://github.com/AnimeshKumar923/test-repo/blob/4d1269490a3a12a7c3363ba9efa2527ac40aeb4d/embedded-examples-error-resolution.md
Configuration menu - View commit details
-
Copy full SHA for af9b533 - Browse repository at this point
Copy the full SHA af9b533View commit details -
Configuration menu - View commit details
-
Copy full SHA for ca76882 - Browse repository at this point
Copy the full SHA ca76882View commit details -
Changes: - add more missing example parameters which were identified during the testing of the script
Configuration menu - View commit details
-
Copy full SHA for 4ad2444 - Browse repository at this point
Copy the full SHA 4ad2444View commit details -
Configuration menu - View commit details
-
Copy full SHA for 0534dae - Browse repository at this point
Copy the full SHA 0534daeView commit details -
Configuration menu - View commit details
-
Copy full SHA for e3d6a78 - Browse repository at this point
Copy the full SHA e3d6a78View commit details
Commits on Jul 5, 2024
-
fix: add user-create.avsc file, update reference
Changes: - added external avro schema file: 'user-create.avsc' - change the reference in the spec to point to the location of the avsc file
Configuration menu - View commit details
-
Copy full SHA for f814d82 - Browse repository at this point
Copy the full SHA f814d82View commit details -
Configuration menu - View commit details
-
Copy full SHA for 5e1b0be - Browse repository at this point
Copy the full SHA 5e1b0beView commit details -
Configuration menu - View commit details
-
Copy full SHA for ba11484 - Browse repository at this point
Copy the full SHA ba11484View commit details -
Configuration menu - View commit details
-
Copy full SHA for c60f9ba - Browse repository at this point
Copy the full SHA c60f9baView commit details -
chore: test run for the workflow
Changes: - add process.exit(1) at appropriate locations - workflow should fail
Configuration menu - View commit details
-
Copy full SHA for c8271ca - Browse repository at this point
Copy the full SHA c8271caView commit details -
Changes: - workflow should be passed
Configuration menu - View commit details
-
Copy full SHA for b196b73 - Browse repository at this point
Copy the full SHA b196b73View commit details -
Configuration menu - View commit details
-
Copy full SHA for 8c0e78c - Browse repository at this point
Copy the full SHA 8c0e78cView commit details -
Configuration menu - View commit details
-
Copy full SHA for aa1564f - Browse repository at this point
Copy the full SHA aa1564fView commit details -
Configuration menu - View commit details
-
Copy full SHA for 3dcfe50 - Browse repository at this point
Copy the full SHA 3dcfe50View commit details -
fix: make consistency with the quotes
Changes: - trying to maintain the consistency of the single quotes and double quotes
Configuration menu - View commit details
-
Copy full SHA for c788faf - Browse repository at this point
Copy the full SHA c788fafView commit details -
Changes: - the heading was mistakenly deleted during the addition of comments in the spec file
Configuration menu - View commit details
-
Copy full SHA for b24f71d - Browse repository at this point
Copy the full SHA b24f71dView commit details -
Configuration menu - View commit details
-
Copy full SHA for b60d353 - Browse repository at this point
Copy the full SHA b60d353View commit details -
Changes: - applied suggestion from: asyncapi#1059 (comment) - applied suggestion from: asyncapi#1059 (comment)
Configuration menu - View commit details
-
Copy full SHA for 5c5d91a - Browse repository at this point
Copy the full SHA 5c5d91aView commit details -
Changes: - modify yaml example which was failing due to not properly formatted structure - update json pointer at one location
Configuration menu - View commit details
-
Copy full SHA for 2c3c55b - Browse repository at this point
Copy the full SHA 2c3c55bView commit details -
Configuration menu - View commit details
-
Copy full SHA for 34e00e0 - Browse repository at this point
Copy the full SHA 34e00e0View commit details -
fix: revert back to JSON String representation
Changes: - The json pointer library doesn't supports the URI representation, so to reduce the extra work this change was made
Configuration menu - View commit details
-
Copy full SHA for 6faca8d - Browse repository at this point
Copy the full SHA 6faca8dView commit details -
Configuration menu - View commit details
-
Copy full SHA for 81b40a5 - Browse repository at this point
Copy the full SHA 81b40a5View commit details -
Update scripts/validation/embedded-examples-validation.js
apply suggestion: asyncapi#1059 (comment) Co-authored-by: Sergio Moya <1083296+smoya@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for fd16aef - Browse repository at this point
Copy the full SHA fd16aefView commit details -
Changes: - adjust script according to suggestion: asyncapi#1059 (comment)
Configuration menu - View commit details
-
Copy full SHA for caf79b5 - Browse repository at this point
Copy the full SHA caf79b5View commit details -
Configuration menu - View commit details
-
Copy full SHA for 47c77f3 - Browse repository at this point
Copy the full SHA 47c77f3View commit details