Giter Club home page Giter Club logo

cuelang-json-schema's Introduction

Nhost Application Configuration schema

Defines a basic Cue schema from our ongoing discussion, and generates the corresponding JSON schema.

Generates a JSON schema from a Cue schema and validates reference.yaml.

Prerequisites

Convert reference from Yaml to Toml

yj -yt < reference.yaml > reference.toml
# Then manually remove empty properties

Default values

See the generated defaults

To generate them:

# Generate default values in Yaml
echo '#yaml-language-server: $schema=./schema.json' > generated/defaults.yaml
cue eval schema.cue -e '#Config' --out yaml >> generated/defaults.yaml

# Generate default values in Toml
cue eval schema.cue -e '#Config' --out json | yj -jt > generated/defaults.toml
# Then manually remove empty properties

Generate the JSON Schema

See the generated JSON Schema

To generate it:

zx --install convert.mjs

Notes

  • JSON Schema limitations
    • additional properties seem to be enabled (could be solved)
    • "flex" struct definition is not supported (see #Global.environment). The problem is in the cue to OpenAPI export
  • Do we want optional fields or required fields with defaults?

Resources

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.