docs(v3): document App Actions V3 version history#271
Open
veljko7 wants to merge 1 commit into
Open
Conversation
Document the version-history feature added to V3 App Actions in fliplet-api (DEV-1259 / PR #8070): config snapshots on create/update/ restore, the 100-version retention cap, and the three REST endpoints to list, fetch, and restore versions. - New "Version history" section covering snapshot-on-write behaviour (create/update/pre-restore reasons), retention/pruning, cascade delete, and what a snapshot captures - GET /versions (paginated summary), GET /versions/:id (full snapshot), POST /versions/:id/restore (undo-able restore, refuses production) documented with Fliplet.API.request() examples and response shapes - Added concept point on versioning to "Data models and key concepts" - Error tables: VERSION_NOT_FOUND, CANNOT_RESTORE_PRODUCTION, RESTORE_FAILED (plus the 409 name-collision case on restore) - Rate limits: version reads under CRUD bucket, restore under publish - Frontmatter capabilities: version history, restore version, rollback Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Deploying fliplet-cli with
|
| Latest commit: |
db3d74e
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a0d6f711.fliplet-cli.pages.dev |
| Branch Preview URL: | https://feature-dev-1314.fliplet-cli.pages.dev |
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
1 participant
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.
Summary
Documents the version-history feature added to V3 App Actions in
fliplet-api(DEV-1259 / PR #8070). The API now snapshots an action's configuration on every create/update/restore and exposes REST endpoints to browse and roll back that history — none of which was documented on developers.fliplet.com until now.All changes are confined to
docs/API/core/app-actions-v3.md.What was added
New "Version history" section, covering:
create,update, andrestoresnapshots the config; theactionfield records the reason (create/update/pre-restore). Snapshotting is best-effort and never blocks the write.Fliplet.API.request()examples:GET …/versions— paginated summary list (heavy fields omitted)GET …/versions/:versionId— full snapshotPOST …/versions/:versionId/restore— restores config, takes apre-restoresnapshot so the restore is itself undo-able, refuses production actions, re-applies cron, returnsrestoredFromVersionId+preRestoreVersionId.Supporting updates to keep the rest of the doc consistent:
VERSION_NOT_FOUND,CANNOT_RESTORE_PRODUCTION,RESTORE_FAILED(plus the409 NAME_ALREADY_EXISTScollision case on restore)capabilities:version history,restore version,rollbackNotes for reviewers
Fliplet.API.request()), verified againstdocs/API/core/api.md. There is noFliplet.App.V3.ActionsJS wrapper for versioning in scope here; if one lands later, this section can be converted to the JS API style.release/DEV-1259(routes/v3/app-actions.js,models/task.js,libs/v3/actions.js)..well-known/AI indexes (llms.txt,llms-full.txt, agent skills) are not touched — they are regenerated bybin/build-agent-indexes.mjsat build time on deploy.🤖 Generated with Claude Code