Can you validate against schema defined in .yaml?

[ifeeltiredboss]

Is there a possibility to use:

---
type: array
items:
  type: object
  properties:
    type:
      "$ref": some_file.yaml#/components/schemas/SomeOtherSchema
    ids:
      type: array
      items:
        type: string
  required:
  - type

Instead of this:

{
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "type": {
              "$ref": "some_file.json#/components/schemas/SomeOtherSchema"
            },
            "ids": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "required": [
            "type"
          ]
        }
      }

How do I proceed with that? I tend to use validate()

[agammann]

Yes. Load the YAML into Python objects first. For your external $ref, load and register that YAML document too; changing .json to .yaml in the reference does not supply a YAML loader by itself.

For a fixed set of files, you can keep using validate():

from pathlib import Path
import yaml
from jsonschema import Draft202012Validator, validate
from referencing import Registry
from referencing.jsonschema import DRAFT202012

schema = yaml.safe_load(Path('schema.yaml').read_text(encoding='utf-8'))
referenced = yaml.safe_load(Path('some_file.yaml').read_text(encoding='utf-8'))
registry = Registry().with_resource(
    'some_file.yaml',
    DRAFT202012.create_resource(referenced),
)

validate(instance, schema, cls=Draft202012Validator, registry=registry)

Here schema.yaml contains the YAML from your question, and some_file.yaml contains components.schemas.SomeOtherSchema. The registry key matches the document part of your $ref; #/components/schemas/SomeOtherSchema selects the subschema within it. This example explicitly uses Draft 2020-12, so choose the corresponding validator/resource dialect if your schemas use a different draft.

I tested this with jsonschema 4.26.0, referencing 0.37.0, and PyYAML 6.0.3: the external YAML reference resolved, valid data passed, and invalid data produced errors at the nested referenced property and ids item. Keep the YAML within JSON's data types, especially string mapping keys.

The official referencing guide also shows a retrieval callback for loading YAML references dynamically.