Add back examples in "JSON Hyper-Schema and HTTP" section #467
Conversation
…ints" section Add the example as it was in 1865631 (that is, just before merge of json-schema-org#427 "Rewrite the Hyper-Schema spec almost entirely").
Add the example as it was in 1865631 (that is, just before merge of json-schema-org#427 "Rewrite the Hyper-Schema spec almost entirely"). Only added a top-level "headerSchema" key to make it symmetrical with the "targetHints" above.
That's because I intended to move these or something like them to that section. I would still prefer that. |
|
> Also, the introduction of "Examples" section currently states that the section about HTTP contains example, and there are currently none.
That's because I intended to move these or something like them to that section. I would still prefer that.
Since I have no idea what you intent to do, I'm afraid I cannot help...
Again, gathering other opinions on this "examples" issue would really be
beneficial.
|
I think part of how we do that is we publish the document with the examples done a certain way and see what the response is. From past experience, draft publication definitely does flush out a new round of comments. I would like to see how a larger audience reacts to an approach where examples are concentrated in one or two sections. I definitely dropped the ball on this and just forgot to cover it. So you're reacting to a real problem here and I would not expect you to guess my intentions. Let's leave this open for the moment and I'll think about how it should work. I'm not dead set against examples in these sections to the same degree as the introduction, so maybe they will work best here. |
|
Let's fold this into #469 as well, as it is all related in some way to the section that addresses. |
Restore examples about
targetHintsandheaderSchemaas they were before #427.These keywords being new and explicitly meant for experimentation and feedback (as noted in CREF), I think it's worth having examples in the specification so that people get clear idea of what they are for.
Also, the introduction of "Examples" section currently states that the section about HTTP contains example, and there are currently none.