Comments (5)
It seems like TopLevelFacetedUnitSpec
currently only gets things from TopLevel
, but nothing from FacetedExtendedUnitSpec
.
Perhaps, the NormalizedUnitSpec<EE> | CompositeUnitSpec<EE>
part is something the schema isn't smart about.
from ts-json-schema-generator.
If I have to guess, the generator doesn't use allOf
, but rather create a more complex object, but isn't good at converting A & (B | C)
into (A & B) | (A & C)
yet.
from ts-json-schema-generator.
I think using allOf
will reduce the JSON schema size in many places as well.
For example, in Vega-Lite, we have many things that share common parts such as:
Encoding
andEncodingWithFacet
*Spec
andTopLevel*Spec
Since we already reproduce merged schema for each of these pairs, the output schema can be quite huge.
from ts-json-schema-generator.
export interface A {
a: number;
}
export interface B {
b: number;
}
export interface C {
c: number;
}
export type MyType = A & (B | C);
Produces
{
"$ref": "#/definitions/MyType",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"C": {
"additionalProperties": false,
"properties": {
"c": {
"type": "number"
}
},
"required": [
"c"
],
"type": "object"
},
"MyType": {
"additionalProperties": false,
"properties": {
"a": {
"type": "number"
}
},
"required": [
"a"
],
"type": "object"
}
}
from ts-json-schema-generator.
allOf
is actually incorrect. The issue is that allOf
requires that all definitions match. However, we make heavy use of additionalProperties: false
, which means that none of the definitions match.
{
"$ref": "#/definitions/BC",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"B": {
"additionalProperties": false,
"properties": {
"b": {
"type": "number"
},
"x": {
"type": "number"
}
},
"type": "object"
},
"BC": {
"allOf": [
{
"$ref": "#/definitions/B"
},
{
"$ref": "#/definitions/C"
}
]
},
"C": {
"additionalProperties": false,
"properties": {
"c": {
"type": "number"
},
"x": {
"type": "number"
}
},
"type": "object"
}
}
}
We actually discussed this issue back on 2017 at #4
from ts-json-schema-generator.
Related Issues (20)
- Error: Unknown node "Primitive" (ts.SyntaxKind = 162) in specific Type example HOT 8
- Generate a schema with an enum only includes the enums numeric values HOT 4
- Documentation of annotations ? HOT 1
- Enhancement: support polymorphic arrays
- Enhancement: Docusaurus documentation ? HOT 1
- Question about the goal of this package HOT 2
- Failing to create json schemas for Ocktokit types HOT 1
- tsconfig loading issue with monorepo HOT 1
- Generation failing for custom utility type HOT 1
- Support patternProperties HOT 1
- Recursive types crashes HOT 6
- Approach for renaming definition names HOT 1
- bug in vercel production, but development environment is OK HOT 1
- Issue when attempting to generate a schema from a type, conflict with @types/glob dependencies HOT 2
- External reference breaks arrays
- Get return type from ArrowFunction HOT 2
- Allow --expose option to be a list of named types
- Add support for HTML-like (Vue, Svelte) files that have <script lang="ts"> elements HOT 1
- Handle const like enum with only one option HOT 2
- Add LiteralType as array accessor
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ts-json-schema-generator.