Improve JSON Schema compatibility #1099
Conversation
- use `allOf` instead of a combination of `$ref` and `properties` for inheritance. - bump to version 1.0.1 **Notes** The schema in JSON format has been temporarily added. This allows some tools to use the JSON version as it's not accessible elsewhere otherwise. Signed-off-by: Jean-Baptiste Bianchi <[email protected]>
There was a problem hiding this comment.
@fjtirado I think you can start testing the Java SDK with this new schema.
@JBBianchi can we have a script to translate from YAML to JSON as part of this PR? We can create one under the hack or scripts directory. This way we keep the JSON generation from YAML idempotent.
| @@ -24,7 +24,7 @@ export module SWSchemaValidator { | |||
| const ajv = new Ajv({ strict: false, allowUnionTypes: true }); | |||
| addFormats(ajv); | |||
|
|
|||
| const workflowSchemaId = "https://serverlessworkflow.io/schemas/1.0.0/workflow.yaml"; | |||
| const workflowSchemaId = "https://serverlessworkflow.io/schemas/1.0.1/workflow.yaml"; | |||
There was a problem hiding this comment.
Are we merging this as part of the 1.0.1 release?
There was a problem hiding this comment.
I'm not sure what else is planned for v1.0.1, but since this introduces a schema change, I think we should bump the version. Otherwise, anyone relying on v1.0.0 might be caught off guard when this gets merged.
For example, if @fjtirado wasn’t aware of the change and we published an override of v1.0.0, it could break the Java SDK.
|
@ricardozanini The new schema is already incorporated to the latest version of the SDK serverlessworkflow/sdk-java#567 |
I forgot to remove the JSON file altogether. I would rather keep only the YAML file in this repo, and build a pipeline to update the website with both YAML and JSON. WDYT ? |
Notes
The schema in JSON format has been temporarily added. This allows some tools to use the JSON version as it's not accessible elsewhere otherwise.
Please specify parts of this PR update:
Discussion or Issue link:
#1093
What this PR does:
allOfinstead of a combination of$refandpropertiesfor inheritance.Additional information: