Eric Rakestraw
ee6a351960
All checks were successful
ci/woodpecker/tag/release Pipeline was successful
26 lines
1.3 KiB
Markdown
26 lines
1.3 KiB
Markdown
# API Roadmap
|
|
|
|
This document records API work that is not part of the current implementation. Current HTTP upload behavior is documented in `docs/integrations/http-upload.md`, current configuration behavior is documented in `docs/config.md`, and current producer package usage is documented under `docs/consumers/`.
|
|
|
|
## Deferred Upload API Work
|
|
|
|
- Durable upload status storage.
|
|
- Durable idempotency records across server restarts.
|
|
- Run listing, retry, and cancellation endpoints.
|
|
- Long-polling or wait-for-completion workflows.
|
|
- Multipart, resumable, or streaming upload protocols.
|
|
- Additional archive content negotiation beyond tar and gzip-compressed tar.
|
|
- URL-token authentication for constrained clients.
|
|
- Upload token lifecycle tooling.
|
|
- Mutual TLS or other in-app identity mechanisms.
|
|
- In-app TLS termination.
|
|
- In-app public exposure policy.
|
|
- In-app upload rate limiting.
|
|
|
|
## Boundaries
|
|
|
|
- Producers do not choose destination ids, destination paths, transforms, links, publish policy, transfer policy, or storage backends through upload requests.
|
|
- Source manifests remain free of routing, destination, transform, and credential data.
|
|
- `http_upload` remains source-only unless a future design changes that contract.
|
|
- Public access policy, TLS termination, and rate limiting belong in deployment infrastructure unless a future design changes that boundary.
|