vmario/docs
1
0
Fork 0
mirror of https://github.com/sismics/docs.git synced 2024-11-22 14:07:55 +01:00
Code Issues Packages Projects Releases Wiki Activity

fix api doc + fix translations

Browse Source
This commit is contained in:
Benjamin Gamard 2018-02-15 20:38:03 +01:00
parent bd51e2ab55
commit 5d335049a2
4 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs-web/src/main/java/com/sismics/docs/rest/resource/RouteModelResource.java
View File

@ -34,7 +34,7 @@ public class RouteModelResource extends BaseResource {
* *
* @api {get} /routemodel Get route models * @api {get} /routemodel Get route models
* @apiName GetRouteModel * @apiName GetRouteModel
* @apiRouteModel RouteModel * @apiGroup RouteModel
* @apiParam {Number} sort_column Column index to sort on * @apiParam {Number} sort_column Column index to sort on
* @apiParam {Boolean} asc If true, sort in ascending order * @apiParam {Boolean} asc If true, sort in ascending order
* @apiSuccess {Object[]} routemodels List of route models * @apiSuccess {Object[]} routemodels List of route models
@ -77,7 +77,7 @@ public class RouteModelResource extends BaseResource {
* *
* @api {put} /routemodel Add a route model * @api {put} /routemodel Add a route model
* @apiName PutRouteModel * @apiName PutRouteModel
* @apiRouteModel RouteModel * @apiGroup RouteModel
* @apiParam {String} name Route model name * @apiParam {String} name Route model name
* @apiParam {String} steps Steps data in JSON * @apiParam {String} steps Steps data in JSON
* @apiSuccess {String} id Route model ID * @apiSuccess {String} id Route model ID
@ -177,7 +177,7 @@ public class RouteModelResource extends BaseResource {
* *
* @api {post} /routemodel/:id Update a route model * @api {post} /routemodel/:id Update a route model
* @apiName PostRouteModel * @apiName PostRouteModel
* @apiRouteModel RouteModel * @apiGroup RouteModel
* @apiParam {String} name Route model name * @apiParam {String} name Route model name
* @apiParam {String} steps Steps data in JSON * @apiParam {String} steps Steps data in JSON
* @apiSuccess {String} status Status OK * @apiSuccess {String} status Status OK
@ -226,7 +226,7 @@ public class RouteModelResource extends BaseResource {
* *
* @api {delete} /routemodel/:id Delete a route model * @api {delete} /routemodel/:id Delete a route model
* @apiName DeleteRouteModel * @apiName DeleteRouteModel
* @apiRouteModel RouteModel * @apiGroup RouteModel
* @apiParam {String} id Route model ID * @apiParam {String} id Route model ID
* @apiSuccess {String} status Status OK * @apiSuccess {String} status Status OK
* @apiError (client) ForbiddenError Access denied * @apiError (client) ForbiddenError Access denied
@ -265,7 +265,7 @@ public class RouteModelResource extends BaseResource {
* *
* @api {get} /routemodel/:id Get a route model * @api {get} /routemodel/:id Get a route model
* @apiName GetRouteModel * @apiName GetRouteModel
* @apiRouteModel RouteModel * @apiGroup RouteModel
* @apiParam {String} id Route model ID * @apiParam {String} id Route model ID
* @apiSuccess {String} id Route model ID * @apiSuccess {String} id Route model ID
* @apiSuccess {String} name Route model name * @apiSuccess {String} name Route model name

8
docs-web/src/main/java/com/sismics/docs/rest/resource/RouteResource.java
View File

@ -38,7 +38,7 @@ public class RouteResource extends BaseResource {
* *
* @api {post} /route/start Start a route on a document * @api {post} /route/start Start a route on a document
* @apiName PostRouteStart * @apiName PostRouteStart
* @apiRouteModel Route * @apiGroup Route
* @apiParam {String} routeModelId Route model ID * @apiParam {String} routeModelId Route model ID
* @apiParam {String} documentId Document ID * @apiParam {String} documentId Document ID
* @apiSuccess {String} status Status OK * @apiSuccess {String} status Status OK
@ -126,7 +126,7 @@ public class RouteResource extends BaseResource {
* *
* @api {post} /route/validate Validate the current step of a route * @api {post} /route/validate Validate the current step of a route
* @apiName PostRouteValidate * @apiName PostRouteValidate
* @apiRouteModel Route * @apiGroup Route
* @apiParam {String} documentId Document ID * @apiParam {String} documentId Document ID
* @apiParam {String} transition Route step transition * @apiParam {String} transition Route step transition
* @apiParam {String} comment Route step comment * @apiParam {String} comment Route step comment
@ -196,7 +196,7 @@ public class RouteResource extends BaseResource {
* @api {get} /route Get the routes on a document * @api {get} /route Get the routes on a document
* @apiName GetRoutes * @apiName GetRoutes
* @apiGroup Route * @apiGroup Route
* @apiParam {String} id Document ID * @apiParam {String} documentId Document ID
* @apiSuccess {Object[]} routes List of routes * @apiSuccess {Object[]} routes List of routes
* @apiSuccess {String} routes.name Name * @apiSuccess {String} routes.name Name
* @apiSuccess {Number} routes.create_date Create date (timestamp) * @apiSuccess {Number} routes.create_date Create date (timestamp)
@ -261,7 +261,7 @@ public class RouteResource extends BaseResource {
* *
* @api {delete} /route Cancel a route * @api {delete} /route Cancel a route
* @apiName DeleteRoute * @apiName DeleteRoute
* @apiRouteModel Route * @apiGroup Route
* @apiParam {String} documentId Document ID * @apiParam {String} documentId Document ID
* @apiSuccess {String} status Status OK * @apiSuccess {String} status Status OK
* @apiError (client) ForbiddenError Access denied * @apiError (client) ForbiddenError Access denied

3
docs-web/src/main/webapp/src/locale/en.json
View File

@ -415,7 +415,8 @@
"Group": "Group", "Group": "Group",
"Tag": "Tag", "Tag": "Tag",
"User": "User", "User": "User",
"RouteModel": "Workflow" "RouteModel": "Workflow model",
"Route": "Workflow"
}, },
"selectrelation": { "selectrelation": {
"typeahead": "Type a document title" "typeahead": "Type a document title"

3
docs-web/src/main/webapp/src/locale/fr.json
View File

@ -415,7 +415,8 @@
"Group": "Groupe", "Group": "Groupe",
"Tag": "Tag", "Tag": "Tag",
"User": "Utilisateur", "User": "Utilisateur",
"RouteModel": "Workflow" "RouteModel": "Modèle de workflow",
"Route": "Workflow"
}, },
"selectrelation": { "selectrelation": {
"typeahead": "Entrez un titre de document" "typeahead": "Entrez un titre de document"