Skip to content

docs: deprecate request options the API ignores - #129

Merged
vvillait88 merged 1 commit into
mainfrom
deprecate-ignored-options
Oct 3, 2026
Merged

vvillait88 merged 1 commit into
mainfrom
deprecate-ignored-options

Conversation

@vvillait88

Copy link
Copy Markdown
Contributor

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)
  • 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

  • Tests cover the new behavior, and the suite passes locally (no behavior changed)
  • Lint, format, and type checks pass
  • Docs and README examples updated if the public surface changed
  • No secrets, credentials, or personal data in the diff or the tests

@vvillait88
vvillait88 merged commit 9e4da3f into main Oct 3, 2026
6 checks passed
@vvillait88
vvillait88 deleted the deprecate-ignored-options branch October 3, 2026 23:00
@vvillait88 vvillait88 mentioned this pull request Oct 4, 2026
5 of 8 tasks
vvillait88 added a commit that referenced this pull request Oct 4, 2026
## Summary

Releases 0.6.4, carrying everything merged since 0.6.3:

- help text for options the API ignores now says they are deprecated,
including `--refresh` (#129)
- quota reset documented as a UTC date rather than a timestamp (#128)

Also in this PR: `@agent-score/sdk` floor raised to 2.8.1, released
today.

Worked with: Varun.

Out of scope: no command behavior changes.

## 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.

## Test plan

`bun run lint`, `typecheck`, `test` (578 passed, 2 skipped) and `build`
pass locally on this branch.

## Checklist

- [x] Tests cover the new behavior, and the suite passes locally
- [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 tests
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