JSON Schema for the CACAO spec.

[dwjohnston]

Hi - please point me in the right direction if this is not the appropriate place for this.

I am using the spec defined here to create an application that creates CACAO playbooks.

To do this, a couple of tools that are essential:

• TypeScript typings
• A validator that validates that any arbitrary json conforms to the spec.

Both of these toolings can easily be created from a JSON Schema spec.

So question is:

• Does a JSON Schema spec already exist?

  • If not, how are you currently generating that documentation.

• Does it make sense to the committee to use a JSON schema spec?

For what it's worth, I currently have a tool that scrapes the documentation page and converts the tables into CSVs, and I then convert those into TypeScript typings. I can probably modify my tooling to convert to JSON Schema instead, at least to give a starting point.

Let me know if it'll be helpful, and I can give you my scripts and/or a generated JSON Schema

[Vasileios-Mavroeidis]

@dwjohnston

We have not published CACAO JSON schemas yet, and yes any contributions are welcome.

The documentation is a standards work and the tables are edited manually. A number of people need to be able to easily contribute via access to the document that the leadership gives and according to OASIS rules.

Having said that if you are not a technical committee member you cannot contribute your work directly in this repo. I'm in the process of requesting OASIS an open repo so that implementers outside of the TC can contribute code.

I'll post the URL for the "open" repository as soon as I have it.

I would be happy to discuss more about your tool. We have a number of people that work on similar tasks.

Thanks. Vasileios Mavroeidis Secretary of CACAO TC

[dwjohnston]

Hi @Vasileios-Mavroeidis thanks for replying.

I'll post an example JSON schema when I have one. I'll hopefully have time for this this week.

Re: general queries about the spec - this this repo the appropriate place to ask?

(What I'm currently doing, is I have an simple example workflow, and I'm creating a CACAO spec for it, and I want to check that I'm on the right track, particularly around the use of variables).

[mateusdz]

Dear @dwjohnston,

The CACAO TC will shortly publish the CACAO JSON schemas when we have a stable version of the CACAO specification (with the upcoming community specification).

For the time being, you can utilize the CACAO JSON schemas from Cyentific's public repo for the community specification draft 03 to satisfy your needs: https://github.com/cyentific-rni/cacao-json-schemas

Best, Mateusz Zych Voting member of CACAO TC Maintainer of CACAO GitHub