Inconsistent parameters names for IDs

GALAglobal / TAPICC-API-implementation

TAPICC API implementation using node.js framework sails.js

Other

6 stars 1 forks source link

Closed ysavourel closed 6 years ago

ysavourel commented 6 years ago

Currently the API documentation uses inconsistent names for some of the ID parameters. For example:

/job/{id} (id is the ID of the job)
/job/{parentid}/asset/{id} (parentId is the ID of the job, id is the ID of the asset)

using something like:

/job/{jobId}
/job/{jobId}/asset/{assetId}

would be clearer, more consistent and could not be misinterpreted.

Alino commented 6 years ago