question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

JSONSchema for the frigate.yaml?

See original GitHub issue

Describe what you are trying to accomplish and why in non technical terms I use the VS Code add-on on Hassio to edit the frigate.yaml. But oftenly I have to go back and forth to the documentation and try to restart the Frigate server to find out if I messed up with it or not.

Describe the solution you’d like With a JSON Schema, we could leverage VS Code’s YAML validation almost for free, by just configuring it to use it, or by adding this in the top of the YAML file:

# yaml-language-server: $schema=<urlToTheSchema>

Describe alternatives you’ve considered Going back and forward to the Frigate docs and restarting it as mentioned.

Additional context Not exactly the point here, but there are also tools which can create documentation in markdown format which can be used with Docusaurus based on the JSON Schema, so that you don’t have to maintain the documentation in two different places. Only in the JSON Schema.

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:7 (3 by maintainers)

github_iconTop GitHub Comments

2reactions
blakeblackshearcommented, Dec 10, 2021

This is why we migrated the config parser to Pydantic, but I don’t think the endpoint that exposes the JSON schema was created yet.

1reaction
felipecrscommented, May 28, 2022

It worked! 😄

I used: # yaml-language-server: $schema=http://ccab4aaf-frigate:5000/api/config/schema

Read more comments on GitHub >

github_iconTop Results From Across the Web

Configuration File - Frigate Docs
VSCode (and VSCode addon) supports the JSON schemas which will automatically validate the config. This can be added by adding # yaml-language-server: $schema= ......
Read more >
Generate JSON Schema in YAML format
Generate JSON Schema in YAML format. Input: JSON response. Output: JSON schema in YAML format.
Read more >
Syntax for documenting JSON structure - Stack Overflow
I'd like to be able to validate JSON using a Json Schema, is that possible, or is it only useful for generating documentation?...
Read more >
Supported hooks - pre-commit
Also available in json. ... github.com/jumanjihouse/pre-commit-hook-yamlfmt ... check-jsonschema - Validate JSON or YAML files against a jsonschema on disk ...
Read more >
frigate vs hull - compare differences and reviews? | LibHunt
The interface itself is based on the Kubernetes API schema itself which is integrated as a JSON schema in the HULL chart. Since...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found