Update documentation to reflect deprecation of forms-api #229
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
Updated with latest output from rails-erd.
The forms-api app is no longer used in any part of our system, its data and responsibilities have been moved to the forms-admin app, and this class diagram is no longer relevant and can be removed. All of the entity types that were in the forms-api class diagram are now also in the forms-admin class diagram, so nothing should be lost by this.
The forms-api app is no longer used in any part of our system, its data and responsibilities have been moved to the forms-admin app, and forms-runner retrieves form definitions from forms-admin. The sequence diagrams in this repo need to be updated to reflect that, this commit does so. This does mean that there is less detail in some sequence diagrams, however this is accurate as to our external API surface; forms-admin exposes fewer public API endpoints than forms-api did.
lfdebrux
force-pushed
the
ldeb-remove-forms-api
branch
from
be1751c to
a679155
Compare
theseanything
approved these changes
Oct 1, 2025
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.
PR Checklist
What
Trello card: https://trello.com/c/BxY1aMOZ/2496-update-team-documentation-now-we-no-longer-use-forms-api
The forms-api app is no longer used in any part of our service, its data responsibilities have been moved to the forms-admin app.
This PR updates our documentation and diagrams in this repo to reflect that.
How to review
Describe the steps required to test the changes.
For example:
Who can review
Any devs, SREs.