fix failing test

bee-travels · Jun 19, 2020 · 5e8a739 · 5e8a739
1 parent 9e05848
commit 5e8a739
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 8 deletions.
diff --git a/example/src/routes/pet.js b/example/src/routes/pet.js
@@ -2,16 +2,18 @@ const { Router } = require('express');
 
 const router = Router();
 
+/* block comments aren't parsed */
+
 /**
- * GET /hello-world
- * @summary Hello World
- * @response 200 - OK
+ * Doc comments are only parsed if they have `METHOD /path` at the top of the
+ * comment.
  */
 
-/* block comment */
-
 /**
- * Doc comment
+ * For example, this comment is ignored.
+ * GET /hello/world
+ * @summary Says hello
+ * @response 200 - OK
  */
 
 /**

diff --git a/openapi-ui-express/package.json b/openapi-ui-express/package.json
@@ -1,6 +1,6 @@
 {
   "name": "openapi-ui-express",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "license": "MIT",
   "dependencies": {
     "express": "^4.17.1"

diff --git a/src/util/commentsToOpenApi.test.ts b/src/util/commentsToOpenApi.test.ts
@@ -264,7 +264,6 @@ describe('commentsToOpenApi', () => {
 			 */
 		});
 
-		// TODO: this isn't valid openapi, schema isn't allowed here.
 		const expected = {
 			paths: {
 				'/hello': {