Sign in
Code Search

Get LSP-style hover info for a definition

Fetches the full declaration header and leading doc comment for the definition at a file/line from peregrine via entire-api. Used by the code viewer hover card. Anonymous callers (no session, no bearer) are served for public repos via entire-api's public-repo path; a private or unknown repo yields 404. When org and repoName are sent, forge (gh or et) is required.

get/api/v1/code-search/hover

Query parameters

repostring required
pathstring required
lineinteger required
namestring

Disambiguates lines holding several definitions.

orgstring
repoNamestring
forge'gh' | 'et'

Forge of org/repoName: gh or et. Required when org and repoName are sent.

Response

Hover info for the definition

namestring required
kindstring required
signaturestring required
docsstring
pathstring required
linenumber required

Changes

Changed in 2 of the 29 revisions of this API.2