jsonschema

Documentation

Overview

Example (BasicSchema)

package main

import (
	"fmt"
	"log"

	"github.com/cloudquery/codegen/jsonschema"
)

func main() {
	type basic struct {
		A string `json:"a" jsonschema:"minLength=2,required"`
	}

	data, err := jsonschema.Generate(new(basic))
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(string(data))
}

Output:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/cloudquery/codegen/jsonschema_test/basic",
  "$ref": "#/$defs/basic",
  "$defs": {
    "basic": {
      "properties": {
        "a": {
          "type": "string",
          "minLength": 2
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "a"
      ]
    }
  }
}

Index

• func Generate(a any, options ...Option) ([]byte, error)
• func GenerateIntoFile(a any, filePath string, options ...Option)
• func Sanitize(sc *jsonschema.Schema) error
• func TestJSONSchema(t *testing.T, schema string, cases []TestCase)
• func WithRemovedKeys(t *testing.T, val any, keys ...string) string
• type Option
  • func WithAddGoComments(base, path string) Option
• type TestCase

Examples

• Package (BasicSchema)

Functions

func Generate

func Generate(a any, options ...Option) ([]byte, error)

Generate returns a formatted JSON schema for the input struct, according to the tags defined by https://github.com/invopop/jsonschema

func GenerateIntoFile

func GenerateIntoFile(a any, filePath string, options ...Option)

func Sanitize

func Sanitize(sc *jsonschema.Schema) error

func TestJSONSchema

func TestJSONSchema(t *testing.T, schema string, cases []TestCase)

func WithRemovedKeys

func WithRemovedKeys(t *testing.T, val any, keys ...string) string

Types

type Option

type Option func(*jsonschema.Reflector)

func WithAddGoComments

func WithAddGoComments(base, path string) Option

type TestCase

type TestCase struct {
	Name         string
	Spec         string
	Err          bool
	ErrorMessage string
}