Run migrations on API initialization, add /admin/db/{action} endpoints
#224
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
Removes the need for new users to run `fidesctl init-db` immediately after loading a fresh CLI env with `make cli`. Fidesapi now also loads the default taxonomy without requiring itself - by interacting directly with the database to "upsert" the default taxonomy's resources. Uses and `INSERT` + `ON CONFLICT...DO UPDATE`, to simplify the process for systems that have previously loaded the default taxonomy, or some other variation.
Prevents the CLI from interacting directly with the database by adding a new API endpoint, `/admin/init-db`, and uses it instead.
Further reduces direct database interaction from the CLI by enabling resetting of the fides database via the API, and using the endpoint when running the `fidesctl reset-db` command.
PSalant726
added
documentation
PSalant726
commented
Nov 12, 2021
ThomasLaPiana
suggested changes
Nov 12, 2021
Enables the auto-generated documentation to show the available path
parameters for the `/admin/db/{action}` endpoint.
PSalant726
force-pushed
the
ps/migrate-on-start
branch
from
65ea401 to
47a0891
Compare
ThomasLaPiana
approved these changes
Nov 12, 2021
ThomasLaPiana
pushed a commit
that referenced
this pull request
Aug 17, 2022
ThomasLaPiana
pushed a commit
that referenced
this pull request
Sep 26, 2022
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.
Closes #202
Closes #204
Code Changes
fidesctl init-dbto be an API callfidesctl reset-dbto be an API callSteps to Confirm
make cliruns without errorsfidesctl init-dbfidesctl reset-dbPre-Merge Checklist
Description Of Changes
/admin/db/{action}whereactionmay be eitherinitorresetdatabase_urlvalue should be passed from the CLI to the API viaPOSTbody, not via query param (as it is at the time of opening this PR).