Automated OpenAPI spec generation

bin/generate-openapi.js

@@ -0,0 +1,51 @@
+import swaggerJsdoc from 'swagger-jsdoc';
+
+/*
+ * Usage: npm run generate-openapi | tail -n1 > x.json
+ *
+ * Inspect generated file by opening it in https://editor-next.swagger.io/
+ *
+ */
+
+const options = {
+  definition: {
+    openapi: '3.1.1',
+    info: {
+      title: 'Trilium Notes - Sync server API',
+      version: '0.96.6',
+      description: "This is the internal sync server API used by Trilium Notes / TriliumNext Notes.\n\n_If you're looking for the officially supported External Trilium API, see [here](https://triliumnext.github.io/Docs/Wiki/etapi.html)._\n\nThis page does not yet list all routes. For a full list, see the [route controller](https://github.com/TriliumNext/Notes/blob/v0.91.6/src/routes/routes.ts).",
+      contact: {
+        name: "TriliumNext issue tracker",
+        url: "https://github.com/TriliumNext/Notes/issues",
+      },
+      license: {
+        name: "GNU Free Documentation License 1.3 (or later)",
+        url: "https://www.gnu.org/licenses/fdl-1.3",
+      },
+    },
+  },
+  apis: ['./src/routes/api/*.ts', './bin/generate-openapi.js'],
+};
+
+const openapiSpecification = swaggerJsdoc(options);
+
+console.log(JSON.stringify(openapiSpecification));
+
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     UtcDateTime:
+ *       type: string
+ *       example: "2025-02-13T07:42:47.698Z"
+ *   securitySchemes:
+ *     user-password:
+ *       type: apiKey
+ *       name: trilium-cred
+ *       in: header
+ *       description: "Username and password, formatted as `user:password`"
+ *     session:
+ *       type: apiKey
+ *       in: cookie
+ *       name: trilium.sid
+ */