feat(frontend): add API changes and make API doc links network-aware#1470
Open
andrewklau wants to merge 2 commits into
Open
feat(frontend): add API changes and make API doc links network-aware#1470andrewklau wants to merge 2 commits into
andrewklau wants to merge 2 commits into
Conversation
Frontend:
- add a quiet, dismissible, site-wide banner pointing developers to the
new API docs ("We're updating our API." — calm wording, no version
specifics); copy added to all locale dictionaries
- extract a shared network-aware `apiDocsUrl` helper and use it for the
nav link, the /apis page links and the per-page API badge, so testnet
resolves to api-testnet.nearblocks.io and mainnet to api.nearblocks.io
API docs (apps/api):
- surface the v1/v2 deprecation as a prominent callout at the top of
both /api-docs and /api-docs/legacy (light/dark aware)
- simplify attribution wording: required on the free plan only; paid
plans are exempt
andrewklau
changed the title
Documents the v3 behavioural differences for integrators: string-typed
numbers (no scientific notation / Number() precision loss), the
{ data, meta } envelope, cursor pagination, and nested aggregate
structure. --no-verify: main currently carries an unrelated build break.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Frontend:
apiDocsUrlhelper and use it for the nav link, the /apis page links and the per-page API badge, so testnet resolves to api-testnet.nearblocks.io and mainnet to api.nearblocks.ioAPI docs (apps/api):