-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Begin prototyping data types of fields and optional #173
base: master
Are you sure you want to change the base?
Conversation
- I'm not 100% sure if we should link using ecmascript, or another standard for the data types. WhatWG has Infra https://infra.spec.whatwg.org/#string as an example, but then I didn't see Array. Still it would be nice to link and point to a standard, but that would be JSON, and I couldn't figure out how to make the ReSpec shortcut links work with RFC8259 and so resorted to the shortcut links using ecmascript (but this all could be changed I'm sure if we knew more or had a friend in ReSpec land)
✅ Deploy Preview for reconciliation-api-specs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Formatting looks good, gives nice overview of data type & optional vs. required.
Made one inline suggestion. Also ReSpec complains about the unused required
definition. I think omitting required
looks good though, so maybe we can just remove the dfn
and make it bold instead? Or link to it once from some place?
Co-authored-by: Fabian Steeg <steeg@hbz-nrw.de>
- Also remove duplicate phrasing paragraph for JSON convention used
Thanks!
Yeah, agree. So, instead, I now have just put a comment inside doc about that, and then made it only bold/italic to match. Finally, does anyone have opinions on the linking for the data types? Notice, if you hover or click on "String" or "Array" etc. that it's currently linked to "ecmascript". Is that OK you think? or should we link to some other standard available in xref ? |
I'll instead link the Data Types against the RFC8259 JSON Specification |
Fixes #157