From ae5c48bf59efb8ec22186186b9fbf2d6b160fbcd Mon Sep 17 00:00:00 2001 From: philc Date: Tue, 16 Jul 2024 09:02:05 +0200 Subject: [PATCH] doc modification and minor change --- models/Pagans.js | 1 + routes/odmdb.js | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/models/Pagans.js b/models/Pagans.js index 35a2a0f..74d3cd0 100644 --- a/models/Pagans.js +++ b/models/Pagans.js @@ -19,6 +19,7 @@ const log = conf.api.activelog.includes(currentmod); */ const Pagans = {}; + /** * Remove authentification token after a logout * @param {string} alias diff --git a/routes/odmdb.js b/routes/odmdb.js index 0e60ead..68da169 100644 --- a/routes/odmdb.js +++ b/routes/odmdb.js @@ -302,14 +302,14 @@ router.put( ); /** - * @api {delete} /adminapi/odmdb/itm/:tribe/:objectname/:primaryid - item Delete + * @api {delete} /adminapi/odmdb/itm/:tribe/:objectname/:apxid/:primaryid - item Delete * @apiGroup Odmdb * @apiName deleteItm * @apiPermission none * @apiDescription Delete an item (data) into a collection of objectname items. This will reindex all idx for this object, but this won't check if this item.apxid is not already use somewhere else. If you use this endpoint be sure that no one will use it, if not then a get request will answer not found. For data integrity is better to use a scpecifc endpoint per tribe to manage a bunch of objects. * @apiParam {string} tribe adminapi or tribe name (smatchit), where object is store * @apiParam {string} objectname Place where to create new item, schema and version are available in /objectname/conf.json - * + * @apiParam {string} apxid the key that is use as unique id for this object you find it in the schema.apxid * @apiBody {Object} data must pass Checkjson.js with schema * * @apiSuccess {json} data idxprimary Value of idxprimary into objectname collection