https://github.com/json-schema-tools/referencer

Flatten a JSON Schema by turning its subschemas into refs. The result is a schema which is 'maximally reffed'. The opposite of dereferencing.
https://github.com/json-schema-tools/referencer

Last synced: about 1 month ago
JSON representation

Flatten a JSON Schema by turning its subschemas into refs. The result is a schema which is 'maximally reffed'. The opposite of dereferencing.

• Host: GitHub
• URL: https://github.com/json-schema-tools/referencer
• Owner: json-schema-tools
• License: apache-2.0
• Created: 2020-08-29T07:22:21.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-23T22:33:48.000Z (4 months ago)
• Last Synced: 2024-11-06T07:06:02.234Z (about 2 months ago)
• Language: TypeScript
• Homepage: https://json-schema-tools.github.io/referencer/
• Size: 965 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# JSON Schema Referencer

  

    

    

    

    

  

Referencer is a package that exports a single function - a function that accepts and returns a JSON Schema. The returned schema is 'flat', as in, any subschemas of the schema have been converted into $refs. Further, any of the subschemas' subschema are also $reffed, recurively until everything is a $ref, and the definition section is fully populated.

The input schema may have refs, but the refs must already be in the definitions section.

The input schema, as well as all of its subschemas must have titles. Their titles must also be unique for their content. We would like to use $id, but it has special meaning and therefor title is used as the unique identifier on-which schemas will be referenced.

Features:

 - Cyclic schemas become cyclic references

 - Completely synchronous

 - immutable by default, option to mutate in place.

 - No external dependencies

 - Fully typed against the generated [meta-schema typings](https://github.com/json-schema-tools/meta-schema/)

 - magically makes your json schema smaller.

## Usage

install it:

`npm install @json-schema-tools/referencer`

use it:

```typescript

import referencer from "@json-schema-tools/referencer";

const result = referencer({

  title: "example",

  type: "object",

  properties: {

    foo: { title: "foo", type: "number" },

    bar: { title: "bar", type: "string" }

  }

});

console.log(result);

// outputs

{

  title: "example",

  type: "object",

  properties: {

    foo: {$ref: "#/definitions/foo" },

    bar: { $ref: "#/definitions/bar" }

  },

  definitions: {

    foo: { title: "foo", type: "number" }

    bar: { title: "bar", type: "string" }

  }

}

```

## License

Apache-2.0

### Contributing

How to contribute, build and release are outlined in [CONTRIBUTING.md](CONTRIBUTING.md), [BUILDING.md](BUILDING.md) and [RELEASING.md](RELEASING.md) respectively. Commits in this repository follow the [CONVENTIONAL_COMMITS.md](CONVENTIONAL_COMMITS.md) specification.