json-editor VS raml-spec

Combined with the fact that the parameter UI is highly dynamic through plugins(like how the extended choice parameters plugin supports defining complex input forms using json-editor means you can use Jenkins as an interface to run any kind of job that requires almost any type of input.

I use JSON schema to generate JSON-editing forms via json-editor: https://github.com/json-editor/json-editor

Then I can use the same schema in the backend to validate the data, both sent in via the form and directly with the application/json content-type. It's a pretty smooth flow, and reduces a lot of redundancy.

I have found stuff similar to this, for example json-editor.

JSON Editor takes a JSON Schema and uses it to generate an HTML form.

Some project followed that way like json-editor

json-editor is a really easy way to build complex forms. The resulting schema is returned as json which you can just convert to yaml. I use this in Jenkins for complex parameters.

https://github.com/json-editor/json-editor was used in the backbone.js version of swagger-ui to generate input forms from json-schema.

Taking this concept further one could model in RAML [0] to define both the types (flat or nested) and api definitions. It's based on YAML 1.2 with enough maturity to provide capabilities such as union types, extensions, includes, user-defined facets, etc.

The AMF project [1] can be used to parse and transform to/from RAML, OpenAPI, GraphQL, and json schema. Code generation to languages of choice can be bolted on from there.

I'm using this approach to define canonical data models. Subsequent code generation scaffolds internal application integration apis, master data management (MDM) entities, and SQL/OLAP artifacts for ETL / BI purposes.

This approach keeps overall end-to-end data architecture consistent, in sync, and versioned under source control. Additionally, flat types as required by relational systems are re-used and composed into nested complex types more appropriate for apis. Metadata is layered on as needed to refine the models for system-specific needs, for example to add user-facing field groups, descriptions, and formats for BI datasets, sensitivity levels and other data security controls, business rule definitions for MDM, etc.

[0] https://github.com/raml-org/raml-spec/blob/master/versions/r...

> Do you use JSON Schema?

At one point I did, but then discovered RAML[0] and it subsumed the value of what JSON Schema provides as well as being easier to work with than OpenAPI[1]. Also, generating JSON Schema from RAML definitions has proven to be a fairly straightforward process.

The usual caveats apply... Your mileage may vary, my experiences do not speak for any others, my opinion does not detract from the value of JSON Schema, etc.

0 - https://github.com/raml-org/raml-spec/blob/master/versions/r...

1 - https://swagger.io/specification/