[FOLIO-1390] specify naming conventions in FOLIO Created: 01/Aug/18 Updated: 12/Nov/18 Resolved: 16/Aug/18 |
|
| Status: | Closed |
| Project: | FOLIO |
| Components: | None |
| Affects versions: | None |
| Fix versions: | None |
| Type: | Task | Priority: | P3 |
| Reporter: | Jakub Skoczen | Assignee: | David Crossley |
| Resolution: | Done | Votes: | 0 |
| Labels: | ci, devdoc, sprint44 | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original estimate: | Not Specified | ||
| Sprint: |
| Description |
|
We need a document to capture naming conventions for various things in FOLIO (JSON Schemas, RAML, permission sets, etc) which are not named consistently at this point. For endpoints and permissions we also may want to provide a scheme for creating matching names. Zak Burke will provide more details and David Crossley will help out create a guideline doc. The automated build output of the branch in preparation is here |
| Comments |
| Comment by Zak Burke [ 01/Aug/18 ] |
|
Browsing through backend APIs, there is a lot of inconsistency: single vs. plural, word separation with dash vs underscore vs snakeCase vs everythingruntogether, even within the same module. We should pick one convention and document it so that future API endpoints can be consistent. |
| Comment by David Crossley [ 02/Aug/18 ] |
|
See initial document at branch: FOLIO-1390-doc-naming-conventions Please enhance or provide feedback, especially the "API endpoints" section. Not yet said anything about hierarchies or plural. |
| Comment by David Crossley [ 08/Aug/18 ] |
|
Expanded that document. Not yet published. |
| Comment by Jakub Skoczen [ 08/Aug/18 ] |
|
The JSON API is de facto standard for defining REST JSON interfaces, we might want to link to it in the interface/RAML section. http://jsonapi.org/ |
| Comment by David Crossley [ 15/Aug/18 ] |
|
Added a basic link to that. Not sure what specific naming conventions we need to list. Also expanded the "module names" section. And linked to from other pages. |
| Comment by David Crossley [ 16/Aug/18 ] |
|
Merged the initial document today via pull/237 See https://dev.folio.org/guidelines/naming-conventions/ Please suggest other conventions as new issues. |