-
Notifications
You must be signed in to change notification settings - Fork 226
Closed as not planned
Closed as not planned
Copy link
Labels
Description
What problem does your feature solve?
The history archive in local mode is currently accessible at /archive, which is ambiguous. The term "archive" could refer to:
- History archive - the ledger history archive produced by stellar-core
- State archival - the protocol feature for archiving contract state
- Metadata store - the SEP-54 data store, called in that document the "Ledger Metadata Storage," that I've heard be called a "meta lake," also being added to quickstart, which resembles a meta archive
The current /archive path doesn't clearly identify which of these it serves. We should use the full and specific name, "history archive" to make it unambiguous this is the history archive endpoint.
What would you like to see?
- Add a new
/history-archivepath that clearly identifies this as the history archive endpoint - Keep the existing
/archivepath for backwards compatibility (used bystellar snapshotcommand) - Document the history archive path in the README's HTTP APIs section, noting it's only available in local mode
The /archive endpoint was never documented in the README, so there are likely very few users relying on this path. This makes it a good opportunity to introduce the clearer /history-archive path going forward. Since the endpoint was never documented, this change would also be a good time to add it to the README.
What alternatives are there?
Retain the existing /archive URL path, which isn't a big problem but leaves the ambiguity in place.
Metadata
Metadata
Assignees
Labels
Type
Projects
Status
Done