allow colon in apiDefine (apidoc#1021)

Fix apidoc#877. By @esaracco
s-chizhik · Oct 11, 2021 · a5651e6 · a5651e6
1 parent caa8cb6
commit a5651e6
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/example/example.js b/example/example.js
@@ -1,9 +1,14 @@
+/**
+ * @apiDefine admin:computer User access only
+ * This optional description belong to to the group admin.
+ */
+
 /**
  * @api {get} /user/:region/:id/:opt Read data of a User
  * @apiVersion 0.3.0
  * @apiName GetUser
  * @apiGroup User
- * @apiPermission admin
+ * @apiPermission admin:computer
  *
  * @apiDescription Compare version 0.3.0 with 0.2.0 and you will see the green markers with new items in version 0.3.0 and red markers with removed items since 0.2.0.
  *

diff --git a/lib/core/parsers/api_define.js b/lib/core/parsers/api_define.js
@@ -16,7 +16,7 @@ function parse (content, source, messages) {
 
   content = content.trim();
 
-  const parseRegExp = /^(\w*)(.*?)(?:\s+|$)(.*)$/gm;
+  const parseRegExp = /^([\w:]*)(.*?)(?:\s+|$)(.*)$/gm;
   let matches = parseRegExp.exec(content);
 
   if (!matches) { return null; }
@@ -27,7 +27,7 @@ function parse (content, source, messages) {
   }
 
   if (matches[2] !== '') {
-    throw new ParameterError('Name must contain only alphanumeric characters.',
+    throw new ParameterError('Name must contain only alphanumeric and colon characters.',
       messages.common.element, messages.common.usage, messages.common.example);
   }