Skip to content
This repository has been archived by the owner on May 28, 2019. It is now read-only.

A JSON schema should be provided for JSON formatter output (or wire protocol) #258

Open
jenisys opened this issue May 12, 2013 · 2 comments

Comments

@jenisys
Copy link

jenisys commented May 12, 2013

Gherkin (or Cucumber) should provide a JSON schema to simplify validation of JSON formatter output by the different implementations. While the feature description (and examples) for JSON formatter output is useful, a more concise specification would be helpful.

SEE ALSO:

NOTES:
I provided such a JSON schema for behave, a Python-based BDD framework similar to Cucumber/JBehave. While its JSON output is not 100% compatible to Gherkin/Cucumber, it might serve as starting point. If you are interested, look here.

One additional note, multi-line text like in doc_strings, descriptions, etc. should be either a string or a sequence of lines (array of strings). The latter improves readability in JSON. The JSON schema could support both (also for backward compatibility) with only minor additions needed in the JSON parser/reader part.

@aslakhellesoy
Copy link
Contributor

This is a good idea. The next major version of Gherkin (Gherkin 3) will be a major rewrite that simplifies the reporting format a lot. I think we should wait to implement a schema until Gherkin 3. See discussions on the cukes-devs google group for details about Gherkin 3.

@paroxyzm
Copy link

Any progress in this issue?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants