update apidoc wwws

This commit is contained in:
2024-05-03 12:32:25 +02:00
parent fe64375566
commit ab562c7e9e
2 changed files with 15 additions and 15 deletions

View File

@@ -31,19 +31,14 @@ router.post(
/**
* @api {get} /api/adminapi/wwws/updatelocaldbanonymous/:tribe/:appname/:pagename/:version - Get app data model for anonymous only
* @apiGroup Wwws
* @apiName getappcontext
* @apiDescription Get data base from backend to localstorage
* @apiName getappcontextforanonymous
* @apiDescription Get data base from backend to localstorage for anonymous (see Get app data model)
*
* @apiParams {string} tribe (adminapi,smatchit,..) to looking for
* @apiParams {string} appname agregate a full data referential to store localy
* @apiParams {string} pagename app page name
* @apiParams {interger} version the current version
* @apiSuccess {object} contain new version data model for a local web app in a PWA logical in the language of the header or if no new version exist then return
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
* {"status":200, "ref":"Odmdb", "msg":"datamodelupdate", "data":{version,conpages,profils,...}}
* {"status":200, "ref":"Odmdb", "msg":"nonewdatamodel", "data":{}}
*/
*/
router.get(
"/updatelocaldbanonymous/:tribe/:appname/:pagename/:version",
checkHeaders,
@@ -68,17 +63,22 @@ router.get(
* @api {get} /api/adminapi/wwws/updatelocaldb/:tribe/:appname/:pagename/:version - Get app data model
* @apiGroup Wwws
* @apiName getappcontext
* @apiDescription Get data base from backend to localstorage
* @apiDescription Get data base from backend to localstorage for authenticated user
*
* @apiParams {string} tribe (adminapi,smatchit,..) to looking for
* @apiParams {string} appname agregate a full data referential to store localy
* @apiParams {string} pagename app page name
* @apiParams {interger} version the current version
* @apiSuccess {object} contain new version data model for a local web app in a PWA logical in the language of the header or if no new version exist then return
* @apiSuccessExample {json} Success-Response:
* @apiSuccessExample {json} datamodelupdate
* {"status":200, "ref":"Wwws", "msg":"datamodelupdate", "data":{version,confpage,profils,schema,options,ref,tpl,tpldata}}
* @apiSuccessExample {json} datamodelnoupdate
* HTTP/1.1 200 OK
* {"status":200, "ref":"Odmdb", "msg":"datamodelupdate", "data":{version,conpages,profils,...}}
* {"status":200, "ref":"Odmdb", "msg":"nonewdatamodel", "data":{}}
* {"status":200, "ref":"Wwws", "msg":"datamodelupdate", "data":{version,confpage,profils,schema,options,ref,tpl,tpldata}}
* @apiSuccessExample {json} pagedoesnotexist
* {status: 200,ref: "Wwws", msg: "pagedoesnotexist", data: { pagename } }
* @apiSuccessExample {json} forbidenaccess
* {status: 200,ref: "Wwws", msg: "forbidenaccess",data: { pagename, profils } }
*/
router.get(
"/updatelocaldb/:tribe/:appname/:pagename/:version",