You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Start building the base so we only need to edit the OpenAPI v3 spec, and the v2 spec can be generated from v3. Also clean up the test suites so there is one common set of test data files used by all languages.
$ make
Helper commands for AIRR Standards repository
make gen-v2 -- Generate OpenAPI V2 spec from the V3 spec
make build-docs -- Build documentation
make spec-copy -- Copy spec files to language directories
make data-copy -- Copy test data files to language directories
make checks -- Run consistency checks on spec files
make tests -- Run all language test suites
make python-tests -- Run Python test suite
make r-tests -- Run R test suite
make js-tests -- Run Javascript test suite
Looks good! And we should implement the make data-copy function rather sooner than later. #741 will put the the JSON/YAML data files in sync again, but the TSVs still need fixing.
I am not up to speed on the automation. I am all in favor of keeping the specs in sync but not much I can contribute as reviewer. I will leave it in your hands to approve this, am removing myself as reviewer. 8-)
Do we 1) remove the test data file from the lang directories or 2) leave them there? Probably 2) so that the lang directories are "complete" without additional steps. Similar to schema files, so should add consistency checks to verify the test data files match.
the problem we will have with generating the v2 spec from v3 is that the output will not be pretty, will lose comments, etc., unless we write a sophisticated translation program, which probably isn't worth the effort. That implies we should stick with maintaining both files and the consistency check, until we are ready to completely deprecate v2.
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.
Start building the base so we only need to edit the OpenAPI v3 spec, and the v2 spec can be generated from v3. Also clean up the test suites so there is one common set of test data files used by all languages.