Skip to content

Version 0.5.0: the spec at API 1.18.0, validation error models removed - #10

Merged
bensynapse merged 2 commits into
mainfrom
api-1.18.0
Nov 12, 2026
Merged

bensynapse merged 2 commits into
mainfrom
api-1.18.0

Conversation

@bensynapse

Copy link
Copy Markdown
Contributor

Follows API 1.18.0, in production since 2026-11-12.

  • The saved spec follows the public document at 1.18.0, 145 operations. Models are regenerated.
  • Breaking: the models HTTPValidationError and ValidationError are removed. The server never sent that shape.
  • Breaking: ErrorEnvelope.error is the new model ErrorBody, where 0.4.1 declared a dict.
  • No client method, argument or return type changed. An API key is sent as before.
  • Tests cover the 422 envelope and the 429 with details["cap"] upload_queue.
  • The README links https://faxforagents.com/docs/limits/.

Run here: ruff, mypy, gen_models.py --check, truthcheck, 143 unit tests.
Against production with no key: one_time_sends.config, read_by_token, get_by_token, confirm and create all answered.
With a wrong API key, me() raised AuthenticationError with invalid_token and a correlation id.

The saved spec follows the public document at API 1.18.0.
The models HTTPValidationError and ValidationError are removed.
ErrorEnvelope.error is the new model ErrorBody, no longer a dict.
No client method, argument or return type changed.
Tests cover the 422 envelope and the upload_queue rate limit.
The README links the limits page.
The server counts the limit of an uploaded file in MiB.
The docstrings of create_upload said 25 MB.
@bensynapse
bensynapse merged commit ab60080 into main Nov 12, 2026
12 checks passed
@bensynapse
bensynapse deleted the api-1.18.0 branch November 12, 2026 21:24
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