json-schema-ref-parser
json-schema-ref-parser copied to clipboard
APIDevTools
Parse, Resolve, and Dereference JSON Schema $ref pointers in Node and browsers
I have multiple OpenAPI 3.0 API:s using some common types, such as some common schema types and common error responses. The responses also reference common schemas. A simple example setup:...
STR: 1. Create file `schema.json` ```json { "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "address": { "$id": "#address", "type": "object", "properties": { "street_address": { "type": "string" }, "city": { "type": "string" }, "state":...
Hey, Thanks so much for your excellent work on this module and swagger-parser, we're extensive users of both @ ReadMe. We occasionally accept very large files from our customers which...
How can I make a custom resolver for relative paths? How do I see the path from which the `$ref` originates?
This might be a way to achieve similar to: https://github.com/APIDevTools/json-schema-ref-parser/issues/1 We've been using `json-schema-ref-parser` with OpenAPI specs in YAML format. It would be very useful to be able to have...
According to RFC 7159, documents with a byte order mark are not valid JSON: https://tools.ietf.org/html/rfc7159#section-8.1 > Implementations MUST NOT add a byte order mark to the beginning of a >...
It would be super helpful to have support for proxies in the HTTP resolver. Suggest this could be implemented with the following optional fields in the `HTTPResolverOptions` type: * `proxyHost`...
If I use `dereference` with `dereference.circular` option set to `"ignore"` circular refs are hoisted to the first usage. For example, given the following input ```yaml A: props: prop: $ref: "#/A"...
I am interested in ```ts dereference(path: string, schema: string | JSONSchema4, options?: $RefParser.Options, callback?: (err: Error | null, schema: JSONSchema4 | null) => any): Promise ``` used in [**`bcherny/json-schema-to-typescript`**](https://github.com/bcherny/json-schema-to-typescript/blob/master/src/resolver.ts) Is...
Glossary ------------------------ An "extended object" is a JSON object that has other properties in addition to `$ref`. For example: ```json { "name": "additional name property", "$ref": "#/some/reference" } ``` >...
Metadata
Owner
Metadata
Parse, Resolve, and Dereference JSON Schema $ref pointers in Node and browsers