Repository navigation
Commit 4fd4da9
authored
docs: deprecate request options the API ignores (#98)
## Summary
Three request options are sent to the API, which never reads them:
- **`refresh` on assess.** The API stopped reading it when assessment
scoring was removed; every assess is evaluated live.
- **`address` and `operator_token` on session create.** `POST
/v1/sessions` reads only `context`, `product_name` and `kind`, so a
session is never pre-associated with a wallet or a credential. The
README examples presented this as a way to "refresh KYC for an existing
operator credential", which does nothing.
These options are now marked deprecated with the reason, and the README
pre-association examples are gone; the `kind: "sign_in"` example stays.
Nothing is removed and no signature changes, so existing callers keep
compiling. pay's `--refresh` help text says the same. Found in a docs
audit by comparing what each SDK sends with what the API route reads.
## Type of change
- [ ] Bug fix (no breaking change)
- [ ] New feature (no breaking change)
- [ ] Breaking change (existing callers must update)
- [x] Docs, tests, or internal maintenance only
## Public API
None removed. The options gain a deprecation note (`@deprecated` in
TypeScript, a docstring line in Python, help text in pay). No release is
cut for this alone.
## Test plan
Lint, type check and the full test suite pass locally in each repo.
## Checklist
- [x] Tests cover the new behavior, and the suite passes locally (no
behavior changed)
- [x] Lint, format, and type checks pass
- [x] Docs and README examples updated if the public surface changed
- [x] No secrets, credentials, or personal data in the diff or the tests1 parent c8aefd4 commit 4fd4da9
2 files changed
Lines changed: 6 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
64 | 64 | | |
65 | 65 | | |
66 | 66 | | |
67 | | - | |
68 | | - | |
69 | | - | |
70 | | - | |
71 | | - | |
| 67 | + | |
| 68 | + | |
72 | 69 | | |
73 | 70 | | |
74 | 71 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
67 | 67 | | |
68 | 68 | | |
69 | 69 | | |
| 70 | + | |
70 | 71 | | |
71 | 72 | | |
72 | 73 | | |
| |||
421 | 422 | | |
422 | 423 | | |
423 | 424 | | |
| 425 | + | |
424 | 426 | | |
425 | 427 | | |
426 | 428 | | |
| |||
433 | 435 | | |
434 | 436 | | |
435 | 437 | | |
436 | | - | |
| 438 | + | |
437 | 439 | | |
438 | | - | |
| 440 | + | |
439 | 441 | | |
440 | 442 | | |
441 | 443 | | |
| |||
0 commit comments