unisonweb/unison
1
0
Fork 0
mirror of https://github.com/unisonweb/unison.git synced 2024-08-15 13:30:27 +03:00
Code Issues Projects Releases Wiki Activity
trunk
unison/unison-src/transcripts/api-getDefinition.md
Chris Penner bbd02a9129 Port getDefinition.md to use projects. 
Fix recontextualization of project queries when using relativeTo
2024-06-25 17:05:38 -07:00

1.4 KiB
Raw Permalink Blame History

Get Definitions Test

scratch/main> builtins.mergeio lib.builtins

nested.names.x.doc = {{ Documentation }}
nested.names.x = 42

scratch/main> add

-- Should NOT find names by suffix
GET /api/projects/scratch/branches/main/getDefinition?names=x

-- Term names should strip relativeTo prefix.
GET /api/projects/scratch/branches/main/getDefinition?names=names.x&relativeTo=nested

-- Should find definitions by hash, names should be relative
GET /api/projects/scratch/branches/main/getDefinition?names=%23qkhkl0n238&relativeTo=nested

doctest.thing.doc = {{ The correct docs for the thing }}
doctest.thing = "A thing"
doctest.thingalias.doc = {{ Docs for the alias, should not be displayed }}
doctest.thingalias = "A thing"
doctest.otherstuff.thing.doc = {{ A doc for a different term with the same name, should not be displayed }}
doctest.otherstuff.thing = "A different thing"

scratch/main> add

Only docs for the term we request should be returned, even if there are other term docs with the same suffix.

GET /api/projects/scratch/branches/main/getDefinition?names=thing&relativeTo=doctest

If we request a doc, the api should return the source, but also the rendered doc should appear in the 'termDocs' list.

GET /api/projects/scratch/branches/main/getDefinition?names=thing.doc&relativeTo=doctest