Skip to content

docs(api): align upload limit descriptions with current constants#114

Merged
rubenhensen merged 1 commit intomainfrom
docs/align-api-description-limits
Apr 26, 2026
Merged

docs(api): align upload limit descriptions with current constants#114
rubenhensen merged 1 commit intomainfrom
docs/align-api-description-limits

Conversation

@dobby-coder
Copy link
Copy Markdown
Contributor

@dobby-coder dobby-coder Bot commented Apr 25, 2026

Summary

`api-description.yaml` still listed the rolling upload limit as "15 GB" and made no mention of the API-key tier. The actual constants in `src/store.rs` are:

  • `PER_UPLOAD_LIMIT` = 5 GB
  • `ROLLING_LIMIT` = 5 GB
  • `API_KEY_PER_UPLOAD_LIMIT` = 100 GB
  • `API_KEY_ROLLING_LIMIT` = 100 GB

This PR updates the four affected description strings (two on the chunk PUT / finalize 413 responses, two on the `/usage` response schema). No code or behaviour changes.

Why draft

Pure docstring change in the OpenAPI spec; want a maintainer pass on the wording before flipping to ready. There's an existing `cargo fmt` drift on the Rust source tree (independent of this PR — the night-shift verification surfaced it). Not touching that here so the diff stays one-line per location.

Test plan

  • `cargo check` clean
  • `cargo test --quiet` (30 passed)
  • No constants changed; only response/schema description text

Reviewer quickstart

```
git fetch origin && git checkout docs/align-api-description-limits && git diff main -- api-description.yaml
```


🤖 Generated with Claude Code

The OpenAPI description listed a stale 15 GB rolling limit and did not
mention the API-key tier. Bring the human-readable response and schema
descriptions in line with the constants in src/store.rs:

- PER_UPLOAD_LIMIT          = 5 GB
- ROLLING_LIMIT             = 5 GB
- API_KEY_PER_UPLOAD_LIMIT  = 100 GB
- API_KEY_ROLLING_LIMIT     = 100 GB
@dobby-coder dobby-coder Bot requested a review from rubenhensen April 25, 2026 22:18
@rubenhensen rubenhensen marked this pull request as ready for review April 26, 2026 10:21
@rubenhensen rubenhensen merged commit 58883a8 into main Apr 26, 2026
5 checks passed
@rubenhensen rubenhensen deleted the docs/align-api-description-limits branch April 26, 2026 10:21
@dobby-coder
Copy link
Copy Markdown
Contributor Author

dobby-coder Bot commented Apr 26, 2026

Dobby sees the approval from Master rubenhensen! Dobby is most grateful — Dobby's tiny docstring fix has been blessed and merged! Dobby thanks you, sir, Dobby thanks you very much! 🧦

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant