fix(web): clean up API docs — parameterized /tile path, truthful examples, image-query one-liner#19
Merged
Merged
Conversation
- Show the /tile endpoint as a parameterized path (/tile/{article_id}/...)
instead of a hardcoded concrete ID, and move it next to /search since
it is step 2 of the search flow.
- Fix wrong example IDs: 2840114 is Fresno_State-Hawaii_football_rivalry,
not Albert Einstein (which is 698618). The photosynthesis example now
shows the real top hit (5878188/1/0).
- Add a copy-pasteable image-query example: base64-encode a local file
inline and POST it (verified live against the API).
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
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.
What
/tileendpoint listing: show the parameterized path/tile/{article_id}/{tile_index}/{chunk_index}in the sidebar/endpoint list instead of a hardcoded concrete ID, and move it up next to/search(it's step 2 of the search flow;/statusand/healthgo after).2840114/0/0is the top of the Albert Einstein article — it's actuallyFresno_State–Hawaii_football_rivalry. Einstein is698618/0/0(verified by fetching the tile). The quickstart's photosynthesis example now shows the real top hit (5878188/1/0, the Photosynthesis article — verified live).base64 < file | tr -d '\n'is portable across Linux and macOS.)Verification
tsc --noEmitpasses.698618/0/0Einstein,5878188/1/0Photosynthesis) fetched and visually confirmed.