diff --git a/Documentation/Scripts/generateSwagger.py b/Documentation/Scripts/generateSwagger.py old mode 100644 new mode 100755 index d664cb9903..50405cc650 --- a/Documentation/Scripts/generateSwagger.py +++ b/Documentation/Scripts/generateSwagger.py @@ -105,6 +105,30 @@ def BackTicks(txt, wordboundary = ['','']): return r.sub(subpattern, txt) +################################################################################ +### @brief AsteriskItalic +### +### *word* -> word +################################################################################ + +def AsteriskItalic(txt, wordboundary = ['','']): + r = rc(r"""([\(\s'/">]|^|.)\*(.*?)\*([<\s\.\),:;'"?!/-]|$)""", MS) + subpattern = '\\1' + wordboundary[0] + '\\2' + wordboundary[1] + '\\3' + + return r.sub(subpattern, txt) + +################################################################################ +### @brief AsteriskBold +### +### **word** -> word +################################################################################ + +def AsteriskBold(txt, wordboundary = ['','']): + r = rc(r"""([\(\s'/">]|^|.)\*\*(.*?)\*\*([<\s\.\),:;'"?!/-]|$)""", MS) + subpattern = '\\1' + wordboundary[0] + '\\2' + wordboundary[1] + '\\3' + + return r.sub(subpattern, txt) + ################################################################################ ### @brief FA ### @@ -152,6 +176,8 @@ def Typography(txt): txt = txt[0:-1] txt = BackTicks(txt) + txt = AsteriskItalic(txt) + txt = AsteriskBold(txt) txt = FN(txt) txt = LIT(txt) txt = FA(txt) diff --git a/Documentation/Scripts/generateSwaggerApi.py b/Documentation/Scripts/generateSwaggerApi.py old mode 100644 new mode 100755 index bd5ef7dcbe..e6217520a0 --- a/Documentation/Scripts/generateSwaggerApi.py +++ b/Documentation/Scripts/generateSwaggerApi.py @@ -64,7 +64,7 @@ files = { "js/actions/api-system.js" : "system", "js/actions/api-transaction.js" : "transaction", "js/actions/api-traversal.js" : "traversal", - "Documentation/ImplementorManual/HttpUser.md" : "user", + "js/actions/api-user.js" : "user", "lib/Admin/RestVersionHandler.cpp" : "version" } diff --git a/js/actions/api-user.js b/js/actions/api-user.js index 7c54a382e6..60e62c525c 100644 --- a/js/actions/api-user.js +++ b/js/actions/api-user.js @@ -41,6 +41,8 @@ var users = require("org/arangodb/users"); //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// +/// @COMMENT{######################################################################} +/// @anchor HttpUserDocument /// @startDocuBlock JSF_api_user_fetch /// /// @RESTHEADER{GET /_api/user/{user}, Fetch User} @@ -99,6 +101,8 @@ function get_api_user (req, res) { //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// +/// @COMMENT{######################################################################} +/// @anchor HttpUserSave /// @startDocuBlock JSF_api_user_create /// /// @RESTHEADER{POST /_api/user, Create User} @@ -284,6 +288,8 @@ function put_api_user (req, res) { //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// +/// @COMMENT{######################################################################} +/// @anchor HttpUserUpdate /// @startDocuBlock JSF_api_user_update /// /// @RESTHEADER{PATCH /_api/user/{user}, Update User} diff --git a/js/common/modules/org/arangodb/arango-collection-common.js b/js/common/modules/org/arangodb/arango-collection-common.js index 8971d97e92..279941d474 100644 --- a/js/common/modules/org/arangodb/arango-collection-common.js +++ b/js/common/modules/org/arangodb/arango-collection-common.js @@ -614,22 +614,32 @@ ArangoCollection.prototype.closedRange = function (name, left, right) { /// /// arango> db.complex.ensureGeoIndex(""home""); /// arango> db.complex.near(0, 170).limit(5).toArray(); -/// [ { "_id" : "complex/74655276", "_key" : "74655276", "_rev" : "74655276", "name" : "Name/0/170", "home" : [ 0, 170 ], "work" : [ 0, -170 ] }, -/// { "_id" : "complex/74720812", "_key" : "74720812", "_rev" : "74720812", "name" : "Name/0/180", "home" : [ 0, 180 ], "work" : [ 0, -180 ] }, -/// { "_id" : "complex/77080108", "_key" : "77080108", "_rev" : "77080108", "name" : "Name/10/170", "home" : [ 10, 170 ], "work" : [ -10, -170 ] }, -/// { "_id" : "complex/72230444", "_key" : "72230444", "_rev" : "72230444", "name" : "Name/-10/170", "home" : [ -10, 170 ], "work" : [ 10, -170 ] }, -/// { "_id" : "complex/72361516", "_key" : "72361516", "_rev" : "72361516", "name" : "Name/0/-180", "home" : [ 0, -180 ], "work" : [ 0, 180 ] } ] +/// [ { "_id" : "complex/74655276", "_key" : "74655276", "_rev" : "74655276", "name" : +/// "Name/0/170", "home" : [ 0, 170 ], "work" : [ 0, -170 ] }, +/// { "_id" : "complex/74720812", "_key" : "74720812", "_rev" : "74720812", "name" : +/// "Name/0/180", "home" : [ 0, 180 ], "work" : [ 0, -180 ] }, +/// { "_id" : "complex/77080108", "_key" : "77080108", "_rev" : "77080108", "name" : +/// "Name/10/170", "home" : [ 10, 170 ], "work" : [ -10, -170 ] }, +/// { "_id" : "complex/72230444", "_key" : "72230444", "_rev" : "72230444", "name" : +/// "Name/-10/170", "home" : [ -10, 170 ], "work" : [ 10, -170 ] }, +/// { "_id" : "complex/72361516", "_key" : "72361516", "_rev" : "72361516", "name" : +/// "Name/0/-180", "home" : [ 0, -180 ], "work" : [ 0, 180 ] } ] /// /// arango> db.complex.geo("work").near(0, 170).limit(5); /// exception in file '/simple-query' at 1018,5: a geo-index must be known /// /// arango> db.complex.ensureGeoIndex("work"); /// arango> db.complex.geo("work").near(0, 170).limit(5).toArray(); -/// [ { "_id" : "complex/72427052", "_key" : "72427052", "_rev" : "72427052", "name" : "Name/0/-170", "home" : [ 0, -170 ], "work" : [ 0, 170 ] }, -/// { "_id" : "complex/72361516", "_key" : "72361516", "_rev" : "72361516", "name" : "Name/0/-180", "home" : [ 0, -180 ], "work" : [ 0, 180 ] }, -/// { "_id" : "complex/70002220", "_key" : "70002220", "_rev" : "70002220", "name" : "Name/-10/-170", "home" : [ -10, -170 ], "work" : [ 10, 170 ] }, -/// { "_id" : "complex/74851884", "_key" : "74851884", "_rev" : "74851884", "name" : "Name/10/-170", "home" : [ 10, -170 ], "work" : [ -10, 170 ] }, -/// { "_id" : "complex/74720812", "_key" : "74720812", "_rev" : "74720812", "name" : "Name/0/180", "home" : [ 0, 180 ], "work" : [ 0, -180 ] } ] +/// [ { "_id" : "complex/72427052", "_key" : "72427052", "_rev" : "72427052", "name" : +/// "Name/0/-170", "home" : [ 0, -170 ], "work" : [ 0, 170 ] }, +/// { "_id" : "complex/72361516", "_key" : "72361516", "_rev" : "72361516", "name" : +/// "Name/0/-180", "home" : [ 0, -180 ], "work" : [ 0, 180 ] }, +/// { "_id" : "complex/70002220", "_key" : "70002220", "_rev" : "70002220", "name" : +/// "Name/-10/-170", "home" : [ -10, -170 ], "work" : [ 10, 170 ] }, +/// { "_id" : "complex/74851884", "_key" : "74851884", "_rev" : "74851884", "name" : +/// "Name/10/-170", "home" : [ 10, -170 ], "work" : [ -10, 170 ] }, +/// { "_id" : "complex/74720812", "_key" : "74720812", "_rev" : "74720812", "name" : +/// "Name/0/180", "home" : [ 0, 180 ], "work" : [ 0, -180 ] } ] /// ``` /// /// @endDocuBlock