Skip to content

Commit e546c08

Browse files
JohnMcLearclaude
andcommitted
docs(openapi): clarify admin spec scope includes pad-side endpoints
/api/version-status is a public pad-side endpoint but lives in the admin OpenAPI document because it shares the same internal route registration. Add a note to info.description so downstream tooling consumers are not misled into treating it as an admin-only route. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 844ea6c commit e546c08

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

src/node/hooks/express/openapi-admin.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,10 @@ export const generateAdminDefinition = (): any => ({
2020
title: 'Etherpad Admin API',
2121
description:
2222
'Authenticated administrative endpoints consumed by the Etherpad admin UI. ' +
23-
'Distinct from the public /api/{version}/* surface served by /api/openapi.json.',
23+
'Distinct from the public /api/{version}/* surface served by /api/openapi.json. ' +
24+
'For completeness this document also includes non-admin endpoints that are ' +
25+
'consumed by the pad UI itself (e.g. /api/version-status) since they share the ' +
26+
'same internal route registration.',
2427
version: getEpVersion(),
2528
},
2629
paths: {

0 commit comments

Comments
 (0)