Skip to content

Commit 1e8a204

Browse files
all-hands-botopenhands-agentenyst
authored
docs: serve api-catalog by enabling download-spec (#890)
* docs: serve api-catalog by enabling download-spec The docs site advertises </.well-known/api-catalog>; rel="api-catalog" in its Link header, but that path returns 404 because no OpenAPI download is configured. Adding "download-spec" to contextual.options makes Mintlify publish the RFC 9727 linkset at /.well-known/api-catalog, linking each OpenAPI spec declared in docs.json (including the OpenHands Cloud spec) so agents can discover the API. Co-authored-by: openhands <openhands@all-hands.dev> * docs: exclude legacy V0 spec from api-catalog The legacy V0_openapi.json is unreferenced in docs.json but Mintlify auto-uploads every OpenAPI spec in the repo, so enabling download-spec advertised it in the /.well-known/api-catalog linkset alongside the two current specs. Add a .mintignore entry to exclude it from publishing. Co-authored-by: openhands <openhands@all-hands.dev> --------- Co-authored-by: openhands <openhands@all-hands.dev> Co-authored-by: enyst <engel.nyst@gmail.com>
1 parent f39a24e commit 1e8a204

2 files changed

Lines changed: 6 additions & 0 deletions

File tree

‎.mintignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Legacy OpenHands V0 REST API schema. Superseded by the Cloud schema
2+
# (openapi/openhands-cloud.json) and kept only for historical reference.
3+
# Excluded so it is not published, indexed, or advertised in the
4+
# /.well-known/api-catalog linkset.
5+
openapi/V0_openapi.json

‎docs.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -702,6 +702,7 @@
702702
"options": [
703703
"copy",
704704
"view",
705+
"download-spec",
705706
"chatgpt",
706707
"claude"
707708
]

0 commit comments

Comments
 (0)