Skip to content

Commit b494b46

Browse files
TimboKZTimboKZ
committed
Update apidocs
1 parent 70efff7 commit b494b46

File tree

5 files changed

+18
-72
lines changed

5 files changed

+18
-72
lines changed

Diff for: ‎doc/api_data.js

+6-32
Original file line numberDiff line numberDiff line change
@@ -145,11 +145,11 @@ define({ "api": [
145145
"title": "Get list of points of interest",
146146
"permission": [
147147
{
148-
"name": "All authorized users"
148+
"name": "Everyone"
149149
}
150150
],
151151
"version": "1.0.0",
152-
"description": "<p><strong>Authorization required.</strong> Get an array with all points of interest. These points can be used as origin/destination suggestions.</p>",
152+
"description": "<p><strong>No authorization required.</strong> Get an array with all points of interest. These points can be used as origin/destination suggestions.</p>",
153153
"success": {
154154
"examples": [
155155
{
@@ -192,20 +192,7 @@ define({ "api": [
192192
}
193193
},
194194
"filename": "lib/v1/routers/PlanningRouter.js",
195-
"groupTitle": "v1_Planning",
196-
"header": {
197-
"fields": {
198-
"Required headers": [
199-
{
200-
"group": "Required headers",
201-
"type": "string",
202-
"optional": false,
203-
"field": "Authorization",
204-
"description": "<p>Authorization header of form <code>Bearer &lt;accessToken&gt;</code>.</p>"
205-
}
206-
]
207-
}
208-
}
195+
"groupTitle": "v1_Planning"
209196
},
210197
{
211198
"group": "v1_Planning",
@@ -215,11 +202,11 @@ define({ "api": [
215202
"title": "Generate route subject to constraints",
216203
"permission": [
217204
{
218-
"name": "All authorized users"
205+
"name": "Everyone"
219206
}
220207
],
221208
"version": "1.0.0",
222-
"description": "<p><strong>Authorization required.</strong> Generate a route subject to specified constraints.</p>",
209+
"description": "<p><strong>No authorization required.</strong> Generate a route subject to specified constraints.</p>",
223210
"parameter": {
224211
"fields": {
225212
"POST parameters": [
@@ -289,20 +276,7 @@ define({ "api": [
289276
}
290277
},
291278
"filename": "lib/v1/routers/PlanningRouter.js",
292-
"groupTitle": "v1_Planning",
293-
"header": {
294-
"fields": {
295-
"Required headers": [
296-
{
297-
"group": "Required headers",
298-
"type": "string",
299-
"optional": false,
300-
"field": "Authorization",
301-
"description": "<p>Authorization header of form <code>Bearer &lt;accessToken&gt;</code>.</p>"
302-
}
303-
]
304-
}
305-
}
279+
"groupTitle": "v1_Planning"
306280
},
307281
{
308282
"group": "v1_Users",

Diff for: ‎doc/api_data.json

+6-32
Original file line numberDiff line numberDiff line change
@@ -145,11 +145,11 @@
145145
"title": "Get list of points of interest",
146146
"permission": [
147147
{
148-
"name": "All authorized users"
148+
"name": "Everyone"
149149
}
150150
],
151151
"version": "1.0.0",
152-
"description": "<p><strong>Authorization required.</strong> Get an array with all points of interest. These points can be used as origin/destination suggestions.</p>",
152+
"description": "<p><strong>No authorization required.</strong> Get an array with all points of interest. These points can be used as origin/destination suggestions.</p>",
153153
"success": {
154154
"examples": [
155155
{
@@ -192,20 +192,7 @@
192192
}
193193
},
194194
"filename": "lib/v1/routers/PlanningRouter.js",
195-
"groupTitle": "v1_Planning",
196-
"header": {
197-
"fields": {
198-
"Required headers": [
199-
{
200-
"group": "Required headers",
201-
"type": "string",
202-
"optional": false,
203-
"field": "Authorization",
204-
"description": "<p>Authorization header of form <code>Bearer &lt;accessToken&gt;</code>.</p>"
205-
}
206-
]
207-
}
208-
}
195+
"groupTitle": "v1_Planning"
209196
},
210197
{
211198
"group": "v1_Planning",
@@ -215,11 +202,11 @@
215202
"title": "Generate route subject to constraints",
216203
"permission": [
217204
{
218-
"name": "All authorized users"
205+
"name": "Everyone"
219206
}
220207
],
221208
"version": "1.0.0",
222-
"description": "<p><strong>Authorization required.</strong> Generate a route subject to specified constraints.</p>",
209+
"description": "<p><strong>No authorization required.</strong> Generate a route subject to specified constraints.</p>",
223210
"parameter": {
224211
"fields": {
225212
"POST parameters": [
@@ -289,20 +276,7 @@
289276
}
290277
},
291278
"filename": "lib/v1/routers/PlanningRouter.js",
292-
"groupTitle": "v1_Planning",
293-
"header": {
294-
"fields": {
295-
"Required headers": [
296-
{
297-
"group": "Required headers",
298-
"type": "string",
299-
"optional": false,
300-
"field": "Authorization",
301-
"description": "<p>Authorization header of form <code>Bearer &lt;accessToken&gt;</code>.</p>"
302-
}
303-
]
304-
}
305-
}
279+
"groupTitle": "v1_Planning"
306280
},
307281
{
308282
"group": "v1_Users",

Diff for: ‎doc/api_project.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ define({
1212
"apidoc": "0.3.0",
1313
"generator": {
1414
"name": "apidoc",
15-
"time": "2018-04-23T22:29:43.437Z",
15+
"time": "2018-05-04T11:18:00.921Z",
1616
"url": "http://apidocjs.com",
1717
"version": "0.17.6"
1818
}

Diff for: ‎doc/api_project.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"apidoc": "0.3.0",
1313
"generator": {
1414
"name": "apidoc",
15-
"time": "2018-04-23T22:29:43.437Z",
15+
"time": "2018-05-04T11:18:00.921Z",
1616
"url": "http://apidocjs.com",
1717
"version": "0.17.6"
1818
}

Diff for: ‎lib/v1/routers/PlanningRouter.js

+4-6
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,10 @@ const router = express.Router({});
1515
* @apiName planning-route
1616
* @api {post} /api/v1/planning/route Generate route subject to constraints
1717
*
18-
* @apiUse v1AuthHeader
19-
* @apiPermission All authorized users
18+
* @apiPermission Everyone
2019
* @apiVersion 1.0.0
2120
*
22-
* @apiDescription <strong>Authorization required.</strong> Generate a route subject to specified constraints.
21+
* @apiDescription <strong>No authorization required.</strong> Generate a route subject to specified constraints.
2322
*
2423
*
2524
* @apiParam (POST parameters) {object} constraints An object (collection of key-value pairs) that represent
@@ -101,11 +100,10 @@ router.post('/route', (req, res, next) => {
101100
* @apiName planning-points-of-interest
102101
* @api {get} /api/v1/planning/points-of-interest Get list of points of interest
103102
*
104-
* @apiUse v1AuthHeader
105-
* @apiPermission All authorized users
103+
* @apiPermission Everyone
106104
* @apiVersion 1.0.0
107105
*
108-
* @apiDescription <strong>Authorization required.</strong> Get an array with all points of interest. These points
106+
* @apiDescription <strong>No authorization required.</strong> Get an array with all points of interest. These points
109107
* can be used as origin/destination suggestions.
110108
*
111109
*

0 commit comments

Comments
 (0)