Skip to content

Fix tokens API documentation#112

Open
findolor wants to merge 1 commit into
mainfrom
feature/rai-479-api-documentation-cleanup
Open

Fix tokens API documentation#112
findolor wants to merge 1 commit into
mainfrom
feature/rai-479-api-documentation-cleanup

Conversation

@findolor
Copy link
Copy Markdown
Collaborator

@findolor findolor commented May 21, 2026

Summary

  • document GET /v1/tokens as a raw array of token objects in OpenAPI instead of ["string"]
  • update the tokens mdBook page to match the existing response contract, including lowercase isin and sanitized network metadata
  • fix the smoke check to validate the root response is an array

Context

GET /v1/tokens already returns a raw JSON array for customers. This keeps that runtime contract intact and only cleans up the generated/API-facing documentation around it.

Closes RAI-479

Validation

  • Not run locally per request; CI should cover compile/static validation.

@linear-code
Copy link
Copy Markdown

linear-code Bot commented May 21, 2026

RAI-479

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 21, 2026

Warning

Rate limit exceeded

@findolor has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 37 minutes and 47 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ed36626f-bb16-4913-8df9-85061e1a14ca

📥 Commits

Reviewing files that changed from the base of the PR and between 0875f73 and 0f99787.

📒 Files selected for processing (3)
  • docs/src/tokens.md
  • scripts/smoke.sh
  • src/routes/tokens.rs
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/rai-479-api-documentation-cleanup

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Collaborator Author


How to use the Graphite Merge Queue

Add the label add-to-gt-merge-queue to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@findolor findolor self-assigned this May 21, 2026
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.

2 participants