[FOLIO-1915] Improve dev doc guides/describe-schema Created: 27/Mar/19 Updated: 03/Jun/20 Resolved: 05/Apr/19 |
|
| Status: | Closed |
| Project: | FOLIO |
| Components: | None |
| Affects versions: | None |
| Fix versions: | None |
| Type: | Task | Priority: | P3 |
| Reporter: | David Crossley | Assignee: | David Crossley |
| Resolution: | Done | Votes: | 0 |
| Labels: | platform-backlog | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original estimate: | Not Specified | ||
| Issue links: |
|
||||||||
| Sprint: | Core: Platform - Sprint 60 | ||||||||
| Story Points: | 3 | ||||||||
| Development Team: | Core: Platform | ||||||||
| Description |
|
The initial document https://dev.folio.org/guides/describe-schema/ was created to assist with description of each JSON Schema property (
Enhance the document to explain the additional requirements explained in
|
| Comments |
| Comment by Marc Johnson [ 29/Mar/19 ] |
|
David Crossley Jakub Skoczen Has it been decided what information is to be described and how / where it is going to be documented? For example, which aspects are part of the interface, which are part of the implementation (Nassib Nassar is likely sick of me raising this topic repeatedly)? Or what structure will be used, as I had understood there isn't really a place in either RAML or JSON schema for this information? The last conversation I was involved in with Nassib Nassar was in preparation for a proposal to the tech council about this subject. |
| Comment by David Crossley [ 29/Mar/19 ] |
|
Added in https://github.com/folio-org/folio-org.github.io/pull/358 |
| Comment by David Crossley [ 01/Apr/19 ] |
|
Marc, to clarify – the abovementioned comment about PR 358 happened around the same time as your comment. That PR was to incorporate other changes, not necessarily the concerns that you raised here. I am not aware of those conversations, so will need to leave it to others to answer. |
| Comment by David Crossley [ 05/Apr/19 ] |
|
I merged the PR today. When the publish process kicks in, and caches expire, then it will be at the abovementioned URL. Closed this ticket. When
|