Conversation
Before this RFC we explored a few options including JSON-LD, keep something similar as the register register and field register or JSON Schema. None of them is fit for purpose, mainly because our custom datatype system. Signed-off-by: Arnau Siches <arnau.siches@digital.cabinet-office.gov.uk>
Signed-off-by: Arnau Siches <arnau.siches@digital.cabinet-office.gov.uk>
Signed-off-by: Arnau Siches <arnau.siches@digital.cabinet-office.gov.uk>
Signed-off-by: Arnau Siches <arnau.siches@digital.cabinet-office.gov.uk>
Signed-off-by: Arnau Siches <arnau.siches@digital.cabinet-office.gov.uk>
MatMoore
left a comment
MatMoore
left a comment
There was a problem hiding this comment.
I touched on this in #27, but could this be combined into the summary resource?
If a user cares about the schema they probably need the summary information as well, and keeping a small number of endpoints makes it easier to understand how to use the API.
It could but I made them different on purpose.
I don't necessarily agree with "If a user cares about the schema they probably need the summary information as well" but it is probably true that part of the summary is likely to be used by a user that needs the schema. I think the split makes more sense than keeping a single big multipurpose endpoint. The I'll think more about the split of responsibilities between the two endpoints. |
|
|
||
| |Name|Type|Description| | ||
| |-|-|-| | ||
| |`log-size` | Optional `Integer`| Set the log size to the given entry number instead of the latest value.| |
There was a problem hiding this comment.
Not sure I understand this param, is it to retrieve the schema at a particular point in the log?
If so, it would be great if the records endpoint could behave in the same way eventually.
There was a problem hiding this comment.
Yes, that's the purpose and I agree the data counterpart should have the same
Signed-off-by: Arnau Siches <arnau.siches@digital.cabinet-office.gov.uk>
2 participants
Context
Before this RFC we explored a few options including JSON-LD, keep
something similar as the register register and field register or JSON
Schema. None of them is fit for purpose, mainly because our custom
datatype system.
Changes proposed in this pull request
This RFC proposes a schema resource to describe the register set of attributes
with their datatypes.
Guidance to review
It is consistent and forwards compatible.