Add more standards-based conventions to schema

[bollwyvl]

thanks for starting this work :heart:!

elevator pitch

Add #/{$id,$schema,title,description} to the top-level schema object, and a top-level #/properties/$schema to be validated in instance documents.

motivation

The current guidance of using tool-specific comment annotation, pointing at a "hot" file on a repo to get a reasonable developer experience seems like a backslide into the Bad Old Days of # [meta] selectors.

Using a standards-based representation of this metadata, tools would not have to parse magic comments to determine what schema should be used to validate a given instance.

While $schema only strictly has to be an identifier, making it a locator would mean that it could resolve directly, such that it would work with yaml-language-server out of the box, and other tools would not require a comment-aware parser to use the data programmatically.

design ideas

"$id": "https://prefix-dev.github.io/recipe-format/v0.0.0/schema/recipe/schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "conda recipe",
"description": "A declarative description of the build and test processes of a conda package: see https://prefix-dev.github.io/recipe-format/v0.0.0/schema/recipe/schema.html",
"properties": {
  "$schema": {
    "type": "string",
    "title": "Schema"
    "description": "An identifier for the schema used to validate this recipe",
    "format": "uri-reference",
    "default": "https://prefix-dev.github.io/recipe-format/v0.0.0/schema/recipe/schema.json"
  }
}

Or, in pydantic-ese, which generally makes a muck of human-readable schema:

VERSION = "0.0.0"  # or arrived at by other means, such as `pyproject.toml`
URL_BASE = "https://prefix-dev.github.io/recipe-format/v{VERSION}"
SCHEMA_URI = f"{URL_BASE}/schema/recipe/schema.json"  # leave space for related documents, if needed
SCHEMA_HTML = f"{URL_BASE}/schema/recipe/schema.html" # for humans (and SEO bots), a la #21
SCHEMA_DRAFT =  "http://json-schema.org/draft-07/schema#" # or the oldest compatible with pydantic magic used

class Whatever(BaseModel):

    class Config:
        json_schema_extra = {
            "$id": SCHEMA_URI,
            "$schema": SCHEMA_DRAFT,
            "title": "conda recipe",
            "description": f"A declarative description of the build and test processes of a conda package: see {SCHEMA_HTML}"
        }

    schema_: str | None = Field(
        SCHEMA_URI,
        alias="$schema",
        title="Schema",
        description="An identifier for the schema used to validate this recipe",
        format="uri-reference",
    )

alternatives

• add a #/properties/schema_version field
  • this sounds good, as it is possible to represent multiple valid versions in the same schema file
  • practically, this is a pretty enormous pain vs being able to look at a humanely-formatted diff of two checked-in .json files (see below)

follow-on

• adding $schema to #/required (e.g. by removing the | None) would further strengthen this critical piece of metadata
  • adding required fields without a period where they are optional first is fairly drastic

references

• similar changes to the pixi.toml schema
  • https://github.com/prefix-dev/pixi/pull/1265
  • as YAML Ain't TOML, fewer jumping jacks would be required, such as stripping null values (which can't be represented in that serialization)...
  • but sane typography really does improve the long-term usefulness of a schema-at-rest
• an example diff with fairly-immediately obvious changes
  • https://github.com/prefix-dev/pixi/compare/v0.20.1...v0.22.0#diff-0b2fc27ac0471e3c69834e795e5af9bd15eed23346db630db41a10525bbc44e6
• some discussion on CEP56
  • https://github.com/conda/ceps/pull/56/files/ff745b04fb2536e72d3de924ae401fd607d76050#diff-8b3b526c06d97ecb07f560c069a52e367a54b85bd6e98acd4050fc3f89742e1c

[baszalmstra]

I would be very happy to accept a PR! Would you be able to make one?

[bollwyvl]

This is actually going fairly well, but one of my assumptions was poor, and it turns yls does not in fact support an explicit $schema.

As having to specify a long URI twice is worse than the status quo, I'll hold on opening the PR here until I get some feedback on https://github.com/redhat-developer/yaml-language-server/pull/970.