Skip to content

Commit 660eb18

Browse files
committed
routes/apps.ts: Add example output
1 parent 24e46c3 commit 660eb18

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

src/node/routes/apps.ts

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,28 @@ import { PluginAPI } from "../plugin"
33

44
/**
55
* Implements the /api/applications endpoint
6+
*
7+
* Example output:
8+
*
9+
* [
10+
* {
11+
* "name": "Test App",
12+
* "version": "4.0.0",
13+
* "iconPath": "/test-plugin/test-app/icon.svg",
14+
* "path": "/test-plugin/test-app",
15+
* "description": "This app does XYZ.",
16+
* "homepageURL": "https://example.com",
17+
* "plugin": {
18+
* "name": "test-plugin",
19+
* "version": "1.0.0",
20+
* "modulePath": "/Users/nhooyr/src/cdr/code-server/test/test-plugin",
21+
* "displayName": "Test Plugin",
22+
* "description": "Plugin used in code-server tests.",
23+
* "routerPath": "/test-plugin",
24+
* "homepageURL": "https://example.com"
25+
* }
26+
* }
27+
* ]
628
*/
729
export function router(papi: PluginAPI): express.Router {
830
const router = express.Router()

0 commit comments

Comments
 (0)