gogo/apxtri
1
0
Fork 0
forked from apxtri/apxtri
Code Pull Requests Activity

doc modification and minor change

Browse Source
This commit is contained in:
philc 2024-07-16 09:02:05 +02:00
parent 6e71911978
commit ae5c48bf59
2 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
models/Pagans.js
View File

@ -19,6 +19,7 @@ const log = conf.api.activelog.includes(currentmod);
*/ */
const Pagans = {}; const Pagans = {};
/** /**
* Remove authentification token after a logout * Remove authentification token after a logout
* @param {string} alias * @param {string} alias

4
routes/odmdb.js
View File

@ -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 * @apiGroup Odmdb
* @apiName deleteItm * @apiName deleteItm
* @apiPermission none * @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. * @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} 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} 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 * @apiBody {Object} data must pass Checkjson.js with schema
* *
* @apiSuccess {json} data idxprimary Value of idxprimary into objectname collection * @apiSuccess {json} data idxprimary Value of idxprimary into objectname collection