Validation of json instances in XMLSpy 2026

[larsolofsson]

As far as I understand,
To validate a json instance in XMLSpy we need to create new yaml files for global properties and for the json instance as well as a json file for the instance.', e.g.

• schema files for global properties: PaginationLinks.schema.yaml, PaperAndBoard.schema.yaml and Pulp.schema.yaml
• schema file for a json instance, e.g. SupplierOrderById.schema.yaml
• json file for the instance: e.g. GetSupplierOrderByID-Interaction 2 of scenario_A.json

In the schema for the json instance we have to change all existing $ref:

• $ref: '#/components/schemas/PaginationLinks' to be changed to $ref: 'PaginationLinks.schema.yaml'
• $ref: '#/components/schemas/PaperAndBoard' to be changed to $ref: 'PaperAndBoard.schema.yaml'
• $ref: '#/components/schemas/Pulp' to be changed to $ref: 'Pulp.schema.yaml'

To make it easier to change these $ref: for the validation work, I propose that we use $ref: only to global properties.
It means that we should not have any references to local properties in the schema.

The following type of constructs with references should be change by repeating local properties instead:

     unitReferences:
                                type: array
                                minItems: 1
                                items:
                                  type: object
                                  unevaluatedProperties: false
                                  required:
                                    # transportUnitLevel is not required (as in `units[]`)
                                    - transportUnitType
                                    - transportUnitIdentifier
                                  properties:
                                    transportUnitLevel:
                                      $ref: '#/components/schemas/SupplierOrderById/properties/lineItems/items/properties/deliveryLegs/items/properties/transport/properties/units/items/properties/level'
                                    transportUnitType:
                                      $ref: '#/components/schemas/SupplierOrderById/properties/lineItems/items/properties/deliveryLegs/items/properties/transport/properties/units/items/properties/type'
                                    transportUnitIdentifier:
                                      $ref: '#/components/schemas/SupplierOrderById/properties/lineItems/items/properties/deliveryLegs/items/properties/transport/properties/units/items/properties/identifier'

[globaltopmedia]

From a distance: curious why the Json validation limitations of XMLspy should drive requirements/refactoring.

[patricekrakow]

1. We think that the idea to re-use a locally defined structure by referencing it with #/components/schemas/... was not a good idea and we should go back to local definition unless the structure is exactly the same in all usage (like for the Party). So, we reference with #/components/schemas/... only global structure.

For instance

$ref: '#/components/schemas/SupplierOrderById/properties/lineItems/items/properties/deliveryLegs/items/properties/transport/properties/units/items/properties/level'

is just saving

type: integer
minimum: 1

2. Since XMLSpy do not support the OpenAPI way to "group" schemas, we need to first extract the schemas and having them to refer to each other in a JSON Schema compatible way (e.g., by putting the schemas in different files).

Approved by CWG on the 2026-01-14 (Wed).