Update schemas to support async runs #477
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
plutopulp
reviewed
Jul 31, 2024
plutopulp
approved these changes
Jul 31, 2024
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.
Pull request outline
Here we update the run schemas to support async runs in the pipeline container (which are coming soon).
It no longer makes sense to share the run schemas across the main API and the pipeline container since several params are now specific to one or the other, so it is best to separate them to avoid confusion. For example
run_idis an optional parameter forContainerRunCreatebut was inherited byRunCreate, even though it is not used by the main API.Main changes here are adding
async_runandcallback_urltoContainerRunCreate- these will be needed for async runs. These are optional so shouldn't cause anything to breakI have kept
run_idinRunCreatejust for backwards compatibility, in case users are using this unknowingly (we can probably check in the main API if it's being used and deprecate if not)Checklist: