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

Fix up api transcripts

Browse Source
This commit is contained in:
Chris Penner 2024-06-27 10:17:27 -07:00
parent 1c75272e9b
commit 47a3a01fbe
8 changed files with 951 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
unison-src/transcripts/api-doc-rendering.md
View File

@ -90,5 +90,5 @@ scratch/main> display term.doc
```
```api
GET /api/non-project-code/getDefinition?names=term
GET /api/projects/scratch/branches/main/getDefinition?names=term
```

795
unison-src/transcripts/api-doc-rendering.output.md
View File

@ -147,12 +147,797 @@ scratch/main> display term.doc
```
```api
GET /api/non-project-code/getDefinition?names=term
GET /api/projects/scratch/branches/main/getDefinition?names=term
{
"missingDefinitions": [
"term"
],
"termDefinitions": {},
"missingDefinitions": [],
"termDefinitions": {
"#qkhkl0n238s1eqibd1ecb8605sqj1m4hpoaag177cu572otqlaf1u28c8suuuqgljdtthsjtr07rv04np05o6oa27ml9105k7uas0t8": {
"bestTermName": "term",
"defnTermTag": "Plain",
"signature": [
{
"annotation": {
"contents": "##Nat",
"tag": "TypeReference"
},
"segment": "Nat"
}
],
"termDefinition": {
"contents": [
{
"annotation": {
"contents": "term",
"tag": "HashQualifier"
},
"segment": "term"
},
{
"annotation": {
"tag": "TypeAscriptionColon"
},
"segment": " :"
},
{
"annotation": null,
"segment": " "
},
{
"annotation": {
"contents": "##Nat",
"tag": "TypeReference"
},
"segment": "Nat"
},
{
"annotation": null,
"segment": "\n"
},
{
"annotation": {
"contents": "term",
"tag": "HashQualifier"
},
"segment": "term"
},
{
"annotation": {
"tag": "BindingEquals"
},
"segment": " ="
},
{
"annotation": null,
"segment": " "
},
{
"annotation": {
"tag": "NumericLiteral"
},
"segment": "42"
}
],
"tag": "UserObject"
},
"termDocs": [
[
"doc",
"#kjfaflbrgl89j2uq4ruubejakm6s02cp3m61ufu7rv7tkbd4nmkvcn1fciue53v0msir9t7ds111ab9er8qfa06gsa9ddfrdfgc99mo",
{
"contents": [
{
"contents": [
{
"contents": "Heading",
"tag": "Word"
}
],
"tag": "Paragraph"
},
[
{
"contents": [
{
"contents": [
{
"contents": "Heading",
"tag": "Word"
},
{
"contents": "2",
"tag": "Word"
}
],
"tag": "Paragraph"
},
[
{
"contents": [
{
"contents": "Term",
"tag": "Word"
},
{
"contents": "Link:",
"tag": "Word"
},
{
"contents": {
"contents": [
{
"annotation": {
"contents": "#k5gpql9cbdfau6lf1aja24joc3sfctvjor8esu8bemn0in3l148otb0t3vebgqrt6qml302h62bbfeftg65gec1v8ouin5m6v2969d8",
"tag": "TermReference"
},
"segment": "otherTerm"
}
],
"tag": "Link"
},
"tag": "Special"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": "Type",
"tag": "Word"
},
{
"contents": "Link:",
"tag": "Word"
},
{
"contents": {
"contents": [
{
"annotation": {
"contents": "#nirp5os0q69o4e1u9p3t6mmq6l6otluefi3ksm7dhm0diidjvkkgl8o9bvnflbj0sanuvdusf34f1qrins3ktcaglpcqv9oums2slsg",
"tag": "TypeReference"
},
"segment": "Maybe"
}
],
"tag": "Link"
},
"tag": "Special"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": "Term",
"tag": "Word"
},
{
"contents": "source:",
"tag": "Word"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": {
"contents": [
{
"contents": [
"#qkhkl0n238s1eqibd1ecb8605sqj1m4hpoaag177cu572otqlaf1u28c8suuuqgljdtthsjtr07rv04np05o6oa27ml9105k7uas0t8",
{
"contents": [
[
{
"annotation": {
"contents": "#qkhkl0n238s1eqibd1ecb8605sqj1m4hpoaag177cu572otqlaf1u28c8suuuqgljdtthsjtr07rv04np05o6oa27ml9105k7uas0t8",
"tag": "TermReference"
},
"segment": "term"
},
{
"annotation": null,
"segment": " "
},
{
"annotation": {
"tag": "TypeAscriptionColon"
},
"segment": ": "
},
{
"annotation": {
"contents": "##Nat",
"tag": "TypeReference"
},
"segment": "Nat"
}
],
[
{
"annotation": {
"contents": "term",
"tag": "HashQualifier"
},
"segment": "term"
},
{
"annotation": {
"tag": "TypeAscriptionColon"
},
"segment": " :"
},
{
"annotation": null,
"segment": " "
},
{
"annotation": {
"contents": "##Nat",
"tag": "TypeReference"
},
"segment": "Nat"
},
{
"annotation": null,
"segment": "\n"
},
{
"annotation": {
"contents": "term",
"tag": "HashQualifier"
},
"segment": "term"
},
{
"annotation": {
"tag": "BindingEquals"
},
"segment": " ="
},
{
"annotation": null,
"segment": " "
},
{
"annotation": {
"tag": "NumericLiteral"
},
"segment": "42"
}
]
],
"tag": "UserObject"
}
],
"tag": "Term"
}
],
"tag": "Source"
},
"tag": "Special"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": "Term",
"tag": "Word"
},
{
"contents": "signature:",
"tag": "Word"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": {
"contents": [
[
{
"annotation": {
"contents": "#qkhkl0n238s1eqibd1ecb8605sqj1m4hpoaag177cu572otqlaf1u28c8suuuqgljdtthsjtr07rv04np05o6oa27ml9105k7uas0t8",
"tag": "TermReference"
},
"segment": "term"
},
{
"annotation": null,
"segment": " "
},
{
"annotation": {
"tag": "TypeAscriptionColon"
},
"segment": ": "
},
{
"annotation": {
"contents": "##Nat",
"tag": "TypeReference"
},
"segment": "Nat"
}
]
],
"tag": "Signature"
},
"tag": "Special"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": [
{
"contents": "List",
"tag": "Word"
},
{
"contents": "item",
"tag": "Word"
}
],
"tag": "Paragraph"
}
],
"tag": "BulletedList"
},
{
"contents": [
1,
[
{
"contents": [
{
"contents": "Numbered",
"tag": "Word"
},
{
"contents": "list",
"tag": "Word"
},
{
"contents": "item",
"tag": "Word"
}
],
"tag": "Paragraph"
}
]
],
"tag": "NumberedList"
},
{
"contents": [
{
"contents": ">",
"tag": "Word"
},
{
"contents": "Block",
"tag": "Word"
},
{
"contents": "quote",
"tag": "Word"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": "Code",
"tag": "Word"
},
{
"contents": "block",
"tag": "Word"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": "Inline",
"tag": "Word"
},
{
"contents": "code:",
"tag": "Word"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": {
"contents": [
{
"annotation": {
"tag": "NumericLiteral"
},
"segment": "1"
},
{
"annotation": null,
"segment": " "
},
{
"annotation": {
"contents": "##Nat.+",
"tag": "TermReference"
},
"segment": "Nat.+"
},
{
"annotation": null,
"segment": " "
},
{
"annotation": {
"tag": "NumericLiteral"
},
"segment": "2"
}
],
"tag": "Example"
},
"tag": "Special"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": {
"contents": "\"doesn't typecheck\" + 1",
"tag": "Word"
},
"tag": "Code"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": [
{
"contents": [
{
"contents": "Link",
"tag": "Word"
}
],
"tag": "Paragraph"
},
{
"contents": {
"contents": "https://unison-lang.org",
"tag": "Word"
},
"tag": "Group"
}
],
"tag": "NamedLink"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": "![Image](https://share-next.unison-lang.org/static/unison-logo-circle.png)",
"tag": "Word"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": {
"contents": [
{
"contents": "Bold",
"tag": "Word"
}
],
"tag": "Paragraph"
},
"tag": "Bold"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": {
"contents": [
{
"contents": "Italic",
"tag": "Word"
}
],
"tag": "Paragraph"
},
"tag": "Bold"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": {
"contents": [
{
"contents": "Strikethrough",
"tag": "Word"
}
],
"tag": "Paragraph"
},
"tag": "Strikethrough"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": "Horizontal",
"tag": "Word"
},
{
"contents": "rule",
"tag": "Word"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": "---",
"tag": "Word"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": "Table",
"tag": "Word"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": "|",
"tag": "Word"
},
{
"contents": "Header",
"tag": "Word"
},
{
"contents": "1",
"tag": "Word"
},
{
"contents": "|",
"tag": "Word"
},
{
"contents": "Header",
"tag": "Word"
},
{
"contents": "2",
"tag": "Word"
},
{
"contents": "|",
"tag": "Word"
},
{
"contents": "|",
"tag": "Word"
},
{
"contents": "--------",
"tag": "Word"
},
{
"contents": "|",
"tag": "Word"
},
{
"contents": "--------",
"tag": "Word"
},
{
"contents": "|",
"tag": "Word"
},
{
"contents": "|",
"tag": "Word"
},
{
"contents": "Cell",
"tag": "Word"
},
{
"contents": "1",
"tag": "Word"
},
{
"contents": "|",
"tag": "Word"
},
{
"contents": "Cell",
"tag": "Word"
},
{
"contents": "2",
"tag": "Word"
},
{
"contents": "|",
"tag": "Word"
},
{
"contents": "|",
"tag": "Word"
},
{
"contents": "Cell",
"tag": "Word"
},
{
"contents": "3",
"tag": "Word"
},
{
"contents": "|",
"tag": "Word"
},
{
"contents": "Cell",
"tag": "Word"
},
{
"contents": "4",
"tag": "Word"
},
{
"contents": "|",
"tag": "Word"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": "Video",
"tag": "Word"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": {
"contents": [
[
{
"mediaSourceMimeType": null,
"mediaSourceUrl": "test.mp4"
}
],
{
"poster": "test.png"
}
],
"tag": "Video"
},
"tag": "Special"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": "Transclusion/evaluation:",
"tag": "Word"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": [
{
"contents": [
{
"contents": "This",
"tag": "Word"
},
{
"contents": "doc",
"tag": "Word"
},
{
"contents": "should",
"tag": "Word"
},
{
"contents": "be",
"tag": "Word"
},
{
"contents": "embedded.",
"tag": "Word"
}
],
"tag": "Paragraph"
},
{
"contents": [
{
"contents": "message",
"tag": "Word"
}
],
"tag": "Paragraph"
}
],
"tag": "UntitledSection"
}
],
"tag": "Paragraph"
}
]
],
"tag": "Section"
}
]
],
"tag": "Section"
}
]
],
"termNames": [
"term"
]
}
},
"typeDefinitions": {}
}
```

2
unison-src/transcripts/api-namespace-details.md
View File

@ -19,5 +19,5 @@ scratch/main> add
```api
-- Should find names by suffix
GET /api/non-project-code/namespaces/nested.names
GET /api/projects/scratch/branches/main/namespaces/nested.names
```

42
unison-src/transcripts/api-namespace-details.output.md
View File

@ -36,10 +36,46 @@ scratch/main> add
```
```api
-- Should find names by suffix
GET /api/non-project-code/namespaces/nested.names
GET /api/projects/scratch/branches/main/namespaces/nested.names
{
"fqn": "nested.names",
"hash": "#sg60bvjo91fsoo7pkh9gejbn0qgc95vra87ap6l5d35ri0lkaudl7bs12d71sf3fh6p23teemuor7mk1i9n567m50ibakcghjec5ajg",
"readme": null
"hash": "#6tnmlu9knsce0u2991u6fvcmf4v44fdf0aiqtmnq7mjj0gi5sephg3lf12iv3odr5rc7vlgq75ciborrd3625c701bdmdomia2gcm3o",
"readme": {
"contents": [
{
"contents": "Here's",
"tag": "Word"
},
{
"contents": "a",
"tag": "Word"
},
{
"contents": {
"contents": [
{
"contents": {
"contents": [
{
"contents": "README",
"tag": "Word"
}
],
"tag": "Paragraph"
},
"tag": "Bold"
},
{
"contents": "!",
"tag": "Word"
}
],
"tag": "Join"
},
"tag": "Group"
}
],
"tag": "Paragraph"
}
}
```

4
unison-src/transcripts/api-namespace-list.md
View File

@ -16,7 +16,7 @@ scratch/main> add
```
```api
GET /api/non-project-code/list?namespace=nested.names
GET /api/projects/scratch/branches/main/list?namespace=nested.names
GET /api/non-project-code/list?namespace=names&relativeTo=nested
GET /api/projects/scratch/branches/main/list?namespace=names&relativeTo=nested
```

98
unison-src/transcripts/api-namespace-list.output.md
View File

@ -33,16 +33,102 @@ scratch/main> add
```
```api
GET /api/non-project-code/list?namespace=nested.names
GET /api/projects/scratch/branches/main/list?namespace=nested.names
{
"namespaceListingChildren": [],
"namespaceListingChildren": [
{
"contents": {
"termHash": "#ddmmatmmiqsts2ku0i02kntd0s7rvcui4nn1cusio8thp9oqhbtilvcnhen52ibv43kr5q83f5er5q9h56s807k17tnelnrac7cch8o",
"termName": "readme",
"termTag": "Doc",
"termType": [
{
"annotation": {
"contents": "#ej86si0ur1",
"tag": "HashQualifier"
},
"segment": "#ej86si0ur1"
}
]
},
"tag": "TermObject"
},
{
"contents": {
"termHash": "#qkhkl0n238s1eqibd1ecb8605sqj1m4hpoaag177cu572otqlaf1u28c8suuuqgljdtthsjtr07rv04np05o6oa27ml9105k7uas0t8",
"termName": "x",
"termTag": "Plain",
"termType": [
{
"annotation": {
"contents": "##Nat",
"tag": "HashQualifier"
},
"segment": "##Nat"
}
]
},
"tag": "TermObject"
},
{
"contents": {
"namespaceHash": "#n1egracfeljprftoktbjcase2hs4f4p8idbhs5ujipl42agld1810hrq9t7p7ped16aagni2cm1fjcjhho770jh80ipthhmg0cnsur0",
"namespaceName": "x",
"namespaceSize": 1
},
"tag": "Subnamespace"
}
],
"namespaceListingFQN": "nested.names",
"namespaceListingHash": "#sg60bvjo91fsoo7pkh9gejbn0qgc95vra87ap6l5d35ri0lkaudl7bs12d71sf3fh6p23teemuor7mk1i9n567m50ibakcghjec5ajg"
"namespaceListingHash": "#oms19b4f9s3c8tb5skeb8jii95ij35n3hdg038pu6rv5b0fikqe4gd7lnu6a1i6aq5tdh2opdo4s0sfrupvk6vfkr9lf0n752gbl8o0"
}
GET /api/non-project-code/list?namespace=names&relativeTo=nested
GET /api/projects/scratch/branches/main/list?namespace=names&relativeTo=nested
{
"namespaceListingChildren": [],
"namespaceListingChildren": [
{
"contents": {
"termHash": "#ddmmatmmiqsts2ku0i02kntd0s7rvcui4nn1cusio8thp9oqhbtilvcnhen52ibv43kr5q83f5er5q9h56s807k17tnelnrac7cch8o",
"termName": "readme",
"termTag": "Doc",
"termType": [
{
"annotation": {
"contents": "#ej86si0ur1",
"tag": "HashQualifier"
},
"segment": "#ej86si0ur1"
}
]
},
"tag": "TermObject"
},
{
"contents": {
"termHash": "#qkhkl0n238s1eqibd1ecb8605sqj1m4hpoaag177cu572otqlaf1u28c8suuuqgljdtthsjtr07rv04np05o6oa27ml9105k7uas0t8",
"termName": "x",
"termTag": "Plain",
"termType": [
{
"annotation": {
"contents": "##Nat",
"tag": "HashQualifier"
},
"segment": "##Nat"
}
]
},
"tag": "TermObject"
},
{
"contents": {
"namespaceHash": "#n1egracfeljprftoktbjcase2hs4f4p8idbhs5ujipl42agld1810hrq9t7p7ped16aagni2cm1fjcjhho770jh80ipthhmg0cnsur0",
"namespaceName": "x",
"namespaceSize": 1
},
"tag": "Subnamespace"
}
],
"namespaceListingFQN": "nested.names",
"namespaceListingHash": "#sg60bvjo91fsoo7pkh9gejbn0qgc95vra87ap6l5d35ri0lkaudl7bs12d71sf3fh6p23teemuor7mk1i9n567m50ibakcghjec5ajg"
"namespaceListingHash": "#oms19b4f9s3c8tb5skeb8jii95ij35n3hdg038pu6rv5b0fikqe4gd7lnu6a1i6aq5tdh2opdo4s0sfrupvk6vfkr9lf0n752gbl8o0"
}
```

26
unison-src/transcripts/api-summaries.md
View File

@ -34,47 +34,47 @@ scratch/main> alias.term ##IO.putBytes.impl.v3 putBytesImpl
```api
-- term
GET /api/non-project-code/definitions/terms/by-hash/@qkhkl0n238s1eqibd1ecb8605sqj1m4hpoaag177cu572otqlaf1u28c8suuuqgljdtthsjtr07rv04np05o6oa27ml9105k7uas0t8/summary?name=nat
GET /api/projects/scratch/branches/main/definitions/terms/by-hash/@qkhkl0n238s1eqibd1ecb8605sqj1m4hpoaag177cu572otqlaf1u28c8suuuqgljdtthsjtr07rv04np05o6oa27ml9105k7uas0t8/summary?name=nat
-- term without name uses hash
GET /api/non-project-code/definitions/terms/by-hash/@qkhkl0n238s1eqibd1ecb8605sqj1m4hpoaag177cu572otqlaf1u28c8suuuqgljdtthsjtr07rv04np05o6oa27ml9105k7uas0t8/summary
GET /api/projects/scratch/branches/main/definitions/terms/by-hash/@qkhkl0n238s1eqibd1ecb8605sqj1m4hpoaag177cu572otqlaf1u28c8suuuqgljdtthsjtr07rv04np05o6oa27ml9105k7uas0t8/summary
-- doc
GET /api/non-project-code/definitions/terms/by-hash/@icfnhas71n8q5rm7rmpe51hh7bltsr7rb4lv7qadc4cbsifu1mhonlqj2d7836iar2ptc648q9p4u7hf40ijvld574421b6u8gpu0lo/summary?name=doc
GET /api/projects/scratch/branches/main/definitions/terms/by-hash/@icfnhas71n8q5rm7rmpe51hh7bltsr7rb4lv7qadc4cbsifu1mhonlqj2d7836iar2ptc648q9p4u7hf40ijvld574421b6u8gpu0lo/summary?name=doc
-- test
GET /api/non-project-code/definitions/terms/by-hash/@u17p9803hdibisou6rlr1sjbccdossgh7vtkd03ovlvnsl2n91lq94sqhughc62tnrual2jlrfk922sebp4nm22o7m5u9j40emft8r8/summary?name=mytest
GET /api/projects/scratch/branches/main/definitions/terms/by-hash/@u17p9803hdibisou6rlr1sjbccdossgh7vtkd03ovlvnsl2n91lq94sqhughc62tnrual2jlrfk922sebp4nm22o7m5u9j40emft8r8/summary?name=mytest
-- function
GET /api/non-project-code/definitions/terms/by-hash/@6ee6j48hk3eovokflkgbmpbfr3oqj4hedqn8ocg3i4i0ko8j7nls7njjirmnh4k2bg8h95seaot798uuloqk62u2ttiqoceulkbmq2o/summary?name=func
GET /api/projects/scratch/branches/main/definitions/terms/by-hash/@6ee6j48hk3eovokflkgbmpbfr3oqj4hedqn8ocg3i4i0ko8j7nls7njjirmnh4k2bg8h95seaot798uuloqk62u2ttiqoceulkbmq2o/summary?name=func
-- constructor
GET /api/non-project-code/definitions/terms/by-hash/@altimqs66j3dh94dpab5pg7j5adjrndq61n803j7fg0v0ohdiut6or66bu1fiongpd45s5euiuo8ru47b928aqv8osln1ikdeg05hq0@d0/summary?name=Thing.This
GET /api/projects/scratch/branches/main/definitions/terms/by-hash/@altimqs66j3dh94dpab5pg7j5adjrndq61n803j7fg0v0ohdiut6or66bu1fiongpd45s5euiuo8ru47b928aqv8osln1ikdeg05hq0@d0/summary?name=Thing.This
-- Long type signature
GET /api/non-project-code/definitions/terms/by-hash/@ieskgcjjvuegpecq9pbha59ttonke7pf31keeq0jlh31ijkfq00e06fdi36ae90u24pjva6ucqdbedropjgi3g3b75nu76ll5ls8ke8/summary?name=funcWithLongType
GET /api/projects/scratch/branches/main/definitions/terms/by-hash/@ieskgcjjvuegpecq9pbha59ttonke7pf31keeq0jlh31ijkfq00e06fdi36ae90u24pjva6ucqdbedropjgi3g3b75nu76ll5ls8ke8/summary?name=funcWithLongType
-- Long type signature with render width
GET /api/non-project-code/definitions/terms/by-hash/@ieskgcjjvuegpecq9pbha59ttonke7pf31keeq0jlh31ijkfq00e06fdi36ae90u24pjva6ucqdbedropjgi3g3b75nu76ll5ls8ke8/summary?renderWidth=20&name=funcWithLongType
GET /api/projects/scratch/branches/main/definitions/terms/by-hash/@ieskgcjjvuegpecq9pbha59ttonke7pf31keeq0jlh31ijkfq00e06fdi36ae90u24pjva6ucqdbedropjgi3g3b75nu76ll5ls8ke8/summary?renderWidth=20&name=funcWithLongType
-- Builtin Term
GET /api/non-project-code/definitions/terms/by-hash/@@IO.putBytes.impl.v3/summary?name=putBytesImpl
GET /api/projects/scratch/branches/main/definitions/terms/by-hash/@@IO.putBytes.impl.v3/summary?name=putBytesImpl
```
## Type Summary APIs
```api
-- data
GET /api/non-project-code/definitions/types/by-hash/@altimqs66j3dh94dpab5pg7j5adjrndq61n803j7fg0v0ohdiut6or66bu1fiongpd45s5euiuo8ru47b928aqv8osln1ikdeg05hq0/summary?name=Thing
GET /api/projects/scratch/branches/main/definitions/types/by-hash/@altimqs66j3dh94dpab5pg7j5adjrndq61n803j7fg0v0ohdiut6or66bu1fiongpd45s5euiuo8ru47b928aqv8osln1ikdeg05hq0/summary?name=Thing
-- data with type args
GET /api/non-project-code/definitions/types/by-hash/@nirp5os0q69o4e1u9p3t6mmq6l6otluefi3ksm7dhm0diidjvkkgl8o9bvnflbj0sanuvdusf34f1qrins3ktcaglpcqv9oums2slsg/summary?name=Maybe
GET /api/projects/scratch/branches/main/definitions/types/by-hash/@nirp5os0q69o4e1u9p3t6mmq6l6otluefi3ksm7dhm0diidjvkkgl8o9bvnflbj0sanuvdusf34f1qrins3ktcaglpcqv9oums2slsg/summary?name=Maybe
-- ability
GET /api/non-project-code/definitions/types/by-hash/@rfi1v9429f9qluv533l2iba77aadttilrpmnhljfapfnfa6sru2nr8ibpqvib9nc4s4nb9s1as45upsfqfqe6ivqi2p82b2vd866it8/summary?name=Stream
GET /api/projects/scratch/branches/main/definitions/types/by-hash/@rfi1v9429f9qluv533l2iba77aadttilrpmnhljfapfnfa6sru2nr8ibpqvib9nc4s4nb9s1as45upsfqfqe6ivqi2p82b2vd866it8/summary?name=Stream
-- builtin type
GET /api/non-project-code/definitions/types/by-hash/@@Nat/summary?name=Nat
GET /api/projects/scratch/branches/main/definitions/types/by-hash/@@Nat/summary?name=Nat
```

26
unison-src/transcripts/api-summaries.output.md
View File

@ -23,7 +23,7 @@ structural ability Stream s where
```api
-- term
GET /api/non-project-code/definitions/terms/by-hash/@qkhkl0n238s1eqibd1ecb8605sqj1m4hpoaag177cu572otqlaf1u28c8suuuqgljdtthsjtr07rv04np05o6oa27ml9105k7uas0t8/summary?name=nat
GET /api/projects/scratch/branches/main/definitions/terms/by-hash/@qkhkl0n238s1eqibd1ecb8605sqj1m4hpoaag177cu572otqlaf1u28c8suuuqgljdtthsjtr07rv04np05o6oa27ml9105k7uas0t8/summary?name=nat
{
"displayName": "nat",
"hash": "#qkhkl0n238s1eqibd1ecb8605sqj1m4hpoaag177cu572otqlaf1u28c8suuuqgljdtthsjtr07rv04np05o6oa27ml9105k7uas0t8",
@ -42,7 +42,7 @@ GET /api/non-project-code/definitions/terms/by-hash/@qkhkl0n238s1eqibd1ecb8605sq
"tag": "Plain"
}
-- term without name uses hash
GET /api/non-project-code/definitions/terms/by-hash/@qkhkl0n238s1eqibd1ecb8605sqj1m4hpoaag177cu572otqlaf1u28c8suuuqgljdtthsjtr07rv04np05o6oa27ml9105k7uas0t8/summary
GET /api/projects/scratch/branches/main/definitions/terms/by-hash/@qkhkl0n238s1eqibd1ecb8605sqj1m4hpoaag177cu572otqlaf1u28c8suuuqgljdtthsjtr07rv04np05o6oa27ml9105k7uas0t8/summary
{
"displayName": "#qkhkl0n238s1eqibd1ecb8605sqj1m4hpoaag177cu572otqlaf1u28c8suuuqgljdtthsjtr07rv04np05o6oa27ml9105k7uas0t8",
"hash": "#qkhkl0n238s1eqibd1ecb8605sqj1m4hpoaag177cu572otqlaf1u28c8suuuqgljdtthsjtr07rv04np05o6oa27ml9105k7uas0t8",
@ -61,7 +61,7 @@ GET /api/non-project-code/definitions/terms/by-hash/@qkhkl0n238s1eqibd1ecb8605sq
"tag": "Plain"
}
-- doc
GET /api/non-project-code/definitions/terms/by-hash/@icfnhas71n8q5rm7rmpe51hh7bltsr7rb4lv7qadc4cbsifu1mhonlqj2d7836iar2ptc648q9p4u7hf40ijvld574421b6u8gpu0lo/summary?name=doc
GET /api/projects/scratch/branches/main/definitions/terms/by-hash/@icfnhas71n8q5rm7rmpe51hh7bltsr7rb4lv7qadc4cbsifu1mhonlqj2d7836iar2ptc648q9p4u7hf40ijvld574421b6u8gpu0lo/summary?name=doc
{
"displayName": "doc",
"hash": "#icfnhas71n8q5rm7rmpe51hh7bltsr7rb4lv7qadc4cbsifu1mhonlqj2d7836iar2ptc648q9p4u7hf40ijvld574421b6u8gpu0lo",
@ -80,7 +80,7 @@ GET /api/non-project-code/definitions/terms/by-hash/@icfnhas71n8q5rm7rmpe51hh7bl
"tag": "Doc"
}
-- test
GET /api/non-project-code/definitions/terms/by-hash/@u17p9803hdibisou6rlr1sjbccdossgh7vtkd03ovlvnsl2n91lq94sqhughc62tnrual2jlrfk922sebp4nm22o7m5u9j40emft8r8/summary?name=mytest
GET /api/projects/scratch/branches/main/definitions/terms/by-hash/@u17p9803hdibisou6rlr1sjbccdossgh7vtkd03ovlvnsl2n91lq94sqhughc62tnrual2jlrfk922sebp4nm22o7m5u9j40emft8r8/summary?name=mytest
{
"displayName": "mytest",
"hash": "#u17p9803hdibisou6rlr1sjbccdossgh7vtkd03ovlvnsl2n91lq94sqhughc62tnrual2jlrfk922sebp4nm22o7m5u9j40emft8r8",
@ -111,7 +111,7 @@ GET /api/non-project-code/definitions/terms/by-hash/@u17p9803hdibisou6rlr1sjbccd
"tag": "Test"
}
-- function
GET /api/non-project-code/definitions/terms/by-hash/@6ee6j48hk3eovokflkgbmpbfr3oqj4hedqn8ocg3i4i0ko8j7nls7njjirmnh4k2bg8h95seaot798uuloqk62u2ttiqoceulkbmq2o/summary?name=func
GET /api/projects/scratch/branches/main/definitions/terms/by-hash/@6ee6j48hk3eovokflkgbmpbfr3oqj4hedqn8ocg3i4i0ko8j7nls7njjirmnh4k2bg8h95seaot798uuloqk62u2ttiqoceulkbmq2o/summary?name=func
{
"displayName": "func",
"hash": "#6ee6j48hk3eovokflkgbmpbfr3oqj4hedqn8ocg3i4i0ko8j7nls7njjirmnh4k2bg8h95seaot798uuloqk62u2ttiqoceulkbmq2o",
@ -151,7 +151,7 @@ GET /api/non-project-code/definitions/terms/by-hash/@6ee6j48hk3eovokflkgbmpbfr3o
"tag": "Plain"
}
-- constructor
GET /api/non-project-code/definitions/terms/by-hash/@altimqs66j3dh94dpab5pg7j5adjrndq61n803j7fg0v0ohdiut6or66bu1fiongpd45s5euiuo8ru47b928aqv8osln1ikdeg05hq0@d0/summary?name=Thing.This
GET /api/projects/scratch/branches/main/definitions/terms/by-hash/@altimqs66j3dh94dpab5pg7j5adjrndq61n803j7fg0v0ohdiut6or66bu1fiongpd45s5euiuo8ru47b928aqv8osln1ikdeg05hq0@d0/summary?name=Thing.This
{
"displayName": "Thing.This",
"hash": "#altimqs66j3dh94dpab5pg7j5adjrndq61n803j7fg0v0ohdiut6or66bu1fiongpd45s5euiuo8ru47b928aqv8osln1ikdeg05hq0#0",
@ -191,7 +191,7 @@ GET /api/non-project-code/definitions/terms/by-hash/@altimqs66j3dh94dpab5pg7j5ad
"tag": "DataConstructor"
}
-- Long type signature
GET /api/non-project-code/definitions/terms/by-hash/@ieskgcjjvuegpecq9pbha59ttonke7pf31keeq0jlh31ijkfq00e06fdi36ae90u24pjva6ucqdbedropjgi3g3b75nu76ll5ls8ke8/summary?name=funcWithLongType
GET /api/projects/scratch/branches/main/definitions/terms/by-hash/@ieskgcjjvuegpecq9pbha59ttonke7pf31keeq0jlh31ijkfq00e06fdi36ae90u24pjva6ucqdbedropjgi3g3b75nu76ll5ls8ke8/summary?name=funcWithLongType
{
"displayName": "funcWithLongType",
"hash": "#ieskgcjjvuegpecq9pbha59ttonke7pf31keeq0jlh31ijkfq00e06fdi36ae90u24pjva6ucqdbedropjgi3g3b75nu76ll5ls8ke8",
@ -378,7 +378,7 @@ GET /api/non-project-code/definitions/terms/by-hash/@ieskgcjjvuegpecq9pbha59tton
"tag": "Plain"
}
-- Long type signature with render width
GET /api/non-project-code/definitions/terms/by-hash/@ieskgcjjvuegpecq9pbha59ttonke7pf31keeq0jlh31ijkfq00e06fdi36ae90u24pjva6ucqdbedropjgi3g3b75nu76ll5ls8ke8/summary?renderWidth=20&name=funcWithLongType
GET /api/projects/scratch/branches/main/definitions/terms/by-hash/@ieskgcjjvuegpecq9pbha59ttonke7pf31keeq0jlh31ijkfq00e06fdi36ae90u24pjva6ucqdbedropjgi3g3b75nu76ll5ls8ke8/summary?renderWidth=20&name=funcWithLongType
{
"displayName": "funcWithLongType",
"hash": "#ieskgcjjvuegpecq9pbha59ttonke7pf31keeq0jlh31ijkfq00e06fdi36ae90u24pjva6ucqdbedropjgi3g3b75nu76ll5ls8ke8",
@ -565,7 +565,7 @@ GET /api/non-project-code/definitions/terms/by-hash/@ieskgcjjvuegpecq9pbha59tton
"tag": "Plain"
}
-- Builtin Term
GET /api/non-project-code/definitions/terms/by-hash/@@IO.putBytes.impl.v3/summary?name=putBytesImpl
GET /api/projects/scratch/branches/main/definitions/terms/by-hash/@@IO.putBytes.impl.v3/summary?name=putBytesImpl
{
"displayName": "putBytesImpl",
"hash": "##IO.putBytes.impl.v3",
@ -671,7 +671,7 @@ GET /api/non-project-code/definitions/terms/by-hash/@@IO.putBytes.impl.v3/summar
```api
-- data
GET /api/non-project-code/definitions/types/by-hash/@altimqs66j3dh94dpab5pg7j5adjrndq61n803j7fg0v0ohdiut6or66bu1fiongpd45s5euiuo8ru47b928aqv8osln1ikdeg05hq0/summary?name=Thing
GET /api/projects/scratch/branches/main/definitions/types/by-hash/@altimqs66j3dh94dpab5pg7j5adjrndq61n803j7fg0v0ohdiut6or66bu1fiongpd45s5euiuo8ru47b928aqv8osln1ikdeg05hq0/summary?name=Thing
{
"displayName": "Thing",
"hash": "#altimqs66j3dh94dpab5pg7j5adjrndq61n803j7fg0v0ohdiut6or66bu1fiongpd45s5euiuo8ru47b928aqv8osln1ikdeg05hq0",
@ -710,7 +710,7 @@ GET /api/non-project-code/definitions/types/by-hash/@altimqs66j3dh94dpab5pg7j5ad
"tag": "Data"
}
-- data with type args
GET /api/non-project-code/definitions/types/by-hash/@nirp5os0q69o4e1u9p3t6mmq6l6otluefi3ksm7dhm0diidjvkkgl8o9bvnflbj0sanuvdusf34f1qrins3ktcaglpcqv9oums2slsg/summary?name=Maybe
GET /api/projects/scratch/branches/main/definitions/types/by-hash/@nirp5os0q69o4e1u9p3t6mmq6l6otluefi3ksm7dhm0diidjvkkgl8o9bvnflbj0sanuvdusf34f1qrins3ktcaglpcqv9oums2slsg/summary?name=Maybe
{
"displayName": "Maybe",
"hash": "#nirp5os0q69o4e1u9p3t6mmq6l6otluefi3ksm7dhm0diidjvkkgl8o9bvnflbj0sanuvdusf34f1qrins3ktcaglpcqv9oums2slsg",
@ -759,7 +759,7 @@ GET /api/non-project-code/definitions/types/by-hash/@nirp5os0q69o4e1u9p3t6mmq6l6
"tag": "Data"
}
-- ability
GET /api/non-project-code/definitions/types/by-hash/@rfi1v9429f9qluv533l2iba77aadttilrpmnhljfapfnfa6sru2nr8ibpqvib9nc4s4nb9s1as45upsfqfqe6ivqi2p82b2vd866it8/summary?name=Stream
GET /api/projects/scratch/branches/main/definitions/types/by-hash/@rfi1v9429f9qluv533l2iba77aadttilrpmnhljfapfnfa6sru2nr8ibpqvib9nc4s4nb9s1as45upsfqfqe6ivqi2p82b2vd866it8/summary?name=Stream
{
"displayName": "Stream",
"hash": "#rfi1v9429f9qluv533l2iba77aadttilrpmnhljfapfnfa6sru2nr8ibpqvib9nc4s4nb9s1as45upsfqfqe6ivqi2p82b2vd866it8",
@ -808,7 +808,7 @@ GET /api/non-project-code/definitions/types/by-hash/@rfi1v9429f9qluv533l2iba77aa
"tag": "Ability"
}
-- builtin type
GET /api/non-project-code/definitions/types/by-hash/@@Nat/summary?name=Nat
GET /api/projects/scratch/branches/main/definitions/types/by-hash/@@Nat/summary?name=Nat
{
"displayName": "Nat",
"hash": "##Nat",