Mirrors/Plex-Meta-Manager
2
0
Fork 0
mirror of https://github.com/meisnate12/Plex-Meta-Manager synced 2024-11-21 12:03:09 +00:00
Code Issues Projects Releases Packages Wiki Activity
Plex-Meta-Manager/json-schema
History
Chaz Larson ffcbac6042 Adds a few things to validate the kitchen sink
2024-05-20 12:41:07 -05:00
..
config-schema.json Adds a few things to validate the kitchen sink 2024-05-20 12:41:07 -05:00
kitchen_sink_config.yml Adds a few things to validate the kitchen sink 2024-05-20 12:41:07 -05:00
prototype_config.yml Update prototype_config.yml 2024-05-01 16:52:19 -05:00
README.md [13] add spellcheck 2024-05-01 12:17:46 -04:00

README.md

JSON schemas for Kometa YAML files

How to:

Add this as the first line in your config.yml:

# yaml-language-server: $schema=https://raw.githubusercontent.com/Kometa-Team/Kometa/nightly/json-schema/config-schema.json

[change nightly to develop, or master if you wish]

Then open your config file in an editor that supports the use of JSON schema.

For example, VS Code with the Red Hat YAML extension.

This will give you context-sensitive hints and auto-complete for much of the Kometa config.yml

image

image

limitations:

  • template variables not cased for specific default file
  • template variables with keys are wildcarded
  • "position" attribute has no validation
  • "streaming" default has no validation
  • search has no validation; just accepts string
  • schedule has no validation; just accepts string

TODO: "list of coordinates"

  • schema for collection yaml
  • schema for metadata yaml
  • schema for overlay yaml
  • schema for template yaml

Notes: