Add OpenAPI contract - phase 1 scope#535
Open
chetanr25 wants to merge 3 commits into
Open
Conversation
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
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.
Add OpenAPI contract - phase 1 scope
Closes #511 (well, the part about having the contract in the codebase).
Based on the feedback from the discussion, the contract has been scoped down to what we're actually building in phase 1. Agencies and auth are out for now the assumption is that FireForm runs inside an org's local network, so there's no real need for auth at this stage.
What changed from the originally proposed contract:
/api/v1/healthdirectlyagency_idwas marked required, which would've broken things once the agencies registry was removedContract structure:
The contract is split into path definitions and schemas to keep it readable as it grows.
openapi.yamlis the root entry point.Fixes: #534