Giter Site home page Giter Site logo

It is definitions or $defs? about jsonschema-go HOT 1 CLOSED

tpoxa avatar tpoxa commented on June 22, 2024
It is definitions or $defs?

from jsonschema-go.

Comments (1)

vearutop avatar vearutop commented on June 22, 2024 1

This library is at draft-07 which has definitions.

But it is possible to use any custom place for definitions with a bit of instrumentation.

https://go.dev/play/p/Zd33cpj6Q4e

package main

import (
	"encoding/json"
	"fmt"
	"github.com/swaggest/jsonschema-go"
)

type S1 struct {
	A int `json:"a"`
	S S2  `json:"s"`
}

type S2 struct {
	B string `json:"b"`
}

func main() {
	r := jsonschema.Reflector{}

	defs := map[string]jsonschema.Schema{}

	s, _ := r.Reflect(S1{}, func(rc *jsonschema.ReflectContext) {
		rc.DefinitionsPrefix = "#/$defs/"
		rc.CollectDefinitions = func(name string, schema jsonschema.Schema) {
			defs[name] = schema
		}
	})

	s.WithExtraPropertiesItem("$defs", defs)

	j, _ := json.MarshalIndent(s, "", " ")

	fmt.Println(string(j))
}
{
 "properties": {
  "a": {
   "type": "integer"
  },
  "s": {
   "$ref": "#/$defs/S2"
  }
 },
 "type": "object",
 "$defs": {
  "S2": {
   "properties": {
    "b": {
     "type": "string"
    }
   },
   "type": "object"
  }
 }
}

from jsonschema-go.

Related Issues (19)

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.