JSON Schema Case Study

[egekorkan]

Me and @relu91 have been contacted by @jviotti from Postman about submitting a case study about how we use JSON Schema and what we gained from it. It will be then published in the JSON Schema space (blog). We are supposed to fill a template and they will actually take it and run it through editors.

An example: https://json-schema.org/blog/posts/tyler-technologies-case-study

Template: https://github.com/json-schema-org/community/blob/main/docs/case-studies/template.md

If it is complicated to submit it as W3C, I can also just submit it as "How W3C WoT uses JSON Schema".

CC @koalie

[koalie]

Great! Please submit it on behalf of the W3C WoT group(s). I'm happy to review anything, if you think it's helpful. Thank you.

[egekorkan]

Marketing Call of 05.07:

• We should collect what it is used for:
  • Describing data of devices
    • Using it for describing of semantics and structure of the data
    • Validation of payloads
    • Readable and writable payloads (operation input and output)
  • Validation of TD (and TMs)
    • Validation of extensions (protocol vocabularies)
  • We are generating https://www.w3.org/2019/wot/json-schema
  • We are generating the typescript types thanks to it for the Scripting API.
  • Exploring how to use it for validation of context extensions for JSON-LD.
• We should write it together and review it, i.e. involve the whole group. We will discuss it in the main call.

[egekorkan]

I have started writing this at hackmd at https://hackmd.io/@egekorkan/json-schema-wot . I will create a PR once it is somewhat consistently readable. Feel free to comment or ask me personally for a link that allows editing

[egekorkan]

@jviotti just to be sure, do we have to answer the questions or can we create a "story" ourselves? If we answer the questions, I guess someone from Postman or JSON Schema will write the actual "flowing" text

[jviotti]

Hey @egekorkan ,

Sounds very exciting! I'll take a closer look at the draft later today.

just to be sure, do we have to answer the questions or can we create a "story" ourselves? If we answer the questions, I guess someone from Postman or JSON Schema will write the actual "flowing" text

Either works for us. Some people struggle with creating the story themselves, so we can get just the answers and build that ourselves. However, if you are able to articulate the story yourself, that's probably much better, as you would know how to tell it much better than us anyway!

[jviotti]

@egekorkan Not sure if I'm missing something from my side, but I don't seem to have enough permissions to comment on the HackMD document. I'm definitely signed-in on HackMD.

[egekorkan]

@egekorkan Not sure if I'm missing something from my side, but I don't seem to have enough permissions to comment on the HackMD document. I'm definitely signed-in on HackMD.

I have no idea why this is the case. Everyone should be able to comment, even not signed in. I have added a test comment at "the standardization" word after opening the link in a private window. In order to comment, you first select the text. It is a bit counterintuitive 😅

[jviotti]

@egekorkan I found it! My ad-blocker was hiding the comment section! 😞 Adding comments now

[egekorkan]

@jviotti have another look at the Hackmd file. I have answered your comments and added some new sections and extensions.

[jviotti]

Looks pretty good @egekorkan! Let me bounce it around with a few folks from JSON Schema too in case they have any other comments

[jviotti]

Hi @egekorkan , I left this around for a while to get time for people to review from our side. Everything looks good 👍 We'll be compiling a final draft case study doc over the next week and share it back here 🎉