-
Notifications
You must be signed in to change notification settings - Fork 1
feat!: add changeset capabilites to API #104
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
angstwad
wants to merge
18
commits into
main
Choose a base branch
from
api-changesets
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
6ffe932 to
fd368fb
Compare
fd368fb to
cf1de82
Compare
cf1de82 to
eb30113
Compare
tests: update group tests and admin interception tests
refactor: consistent url endpoints for cluster and group by name and by ID
feat(api): use entity UUID to uniquely idenfity a record within the API feat(api): add historical record visibility for a given entity within the API
intentionally missing screenshots that will come later
… in the current changeset
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.
Okay, so this is a massive PR, so apologies.
To make it easier to review, I guess, you can trust the tests a little bit. Or not. I think they're decent. But I made you a "verify the behavior of the API" doc that is in this PR at
docs/verification-walkthrough.md. There is also a newuser-guide.mdthere, too, that should help.Also, I'd suggest you walk through some of the flows in the UI as well... Check out the API endpoints in the OpenAPI page when running locally at http://localhost:8000/api/v1/docs.
And in the UI, you can verify the actions do what they're supposed to do.
I added a ton of documentation on this and in the code to help make review a bit easier.
Summary:
This PR introduces a comprehensive ChangeSet system to the Parameter Store API, enabling atomic, versioned updates to Groups and Clusters. It transitions the API from direct "live" modifications to a staged workflow where changes are drafted, reviewed, and committed as cohesive units.
Key Changes:
ChangeSetlifecycle management: creation, metadata updates, abandonment, and atomic committing.GroupandClusterCRUD endpoints to strictly require achangeset_idfor all state-changing operations (POST,PUT,DELETE)./id/{id}) to use stableshared_entity_id(UUID) rather than ephemeral database row IDs.GET /changeset/{id}/changes) providing a categorized breakdown (Create/Update/Delete) of all pending modifications./.../history) for Groups and Clusters to browse the version trail of an entity.docs/user-guide.mdproviding a clear, approachable walkthrough of the ChangeSet system for both UI and API users.