setting additionalProperties to true about ts-json-schema-generator HOT 10 CLOSED

I see. That intent wasn't fully clear - from a reading of the code.

I now see how current behavior is actually a better approach to
determining when additionalProperties should be included and when not.
It's a more natural extension of excess-property-checking in TypeScript.

Nicely done. Thanks much.

from ts-json-schema-generator.

@domoritz that's the workaround we are using today, yes we can continue using this workaround.

from ts-json-schema-generator.

I'd consider a pull request with tests if the changes to the library code are small (which I expect them to be).

from ts-json-schema-generator.

Usually, you wouldn't set it to true but define what types you expect additional properties to be. This is useful for mapsas in https://github.com/vega/typescript-to-json-schema/blob/master/test/valid-data/type-maps/schema.json#L38. Does this make sense?

from ts-json-schema-generator.

ah!
Two questions:

1. Is there a way to specify this in the TypeScript definition? Ideally, @additionalProperties annotation on an object.
2. Currently, this is being set to false. Which seems to trigger a no additionalProperties allowed check from a validator I am using. Per the spec, http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.10, additionalProperties being absent is treated as empty schema, which should validate arbit additional props.

Basically, providing for 1 above will solve 2. Current behavior seems to be amiss from the standard.

Or did I miss something else again?! 😱

from ts-json-schema-generator.

1. I haven't added anything but I don't see why we wouldn't be able to add it
2. That seems to be the behavior you want from a json schema that is generated from typescript. https://github.com/YousefED/typescript-json-schema has an option to not automatically output additionalProperties: false but I haven't bothered adding this to this generator because I always want it.

I don't agree that what I'm doing is not a according to the standard. What this library does is try to create a correspondence between the behavior in typescript and the behavior in json schema. Can you give me an example where you would want a different behavior?

Note that you can a write in typescript (roughly, I don't have a compiler right now)

interface A {
  foo: number
  [key: string]: any
}

which will allow additional properties on the interface A.

from ts-json-schema-generator.

@domoritz we are using this great library but we found we need to allow customers sending JSON files with additional properties anywhere they want in JSON. Can I create a PR to add a --allowAdditionalProperties flag? Thanks!

from ts-json-schema-generator.

@yliu-d would it make sense to just iterate over the generated JSON to change the property instead of adding support to the library itself?

from ts-json-schema-generator.

Would you accept a PR to add a flag for this?

My use case is that I'm writing a library that lets people check if their typescript types match up with a real piece of JSON (for example, the JSON you'd get back from an API call). The reason for it is so that people don't end up using operations in typescript on properties that may not exist in the actual JSON.

In this case, consumers don't care whether or not there are additional properties, they only care that the returned JSON has all of the properties that were specified in their type. https://github.com/tamj0rd2/ncdc

It seems like adding a flag may satisfy other people's use cases also. This is the only roadblock I'm facing switching from typescript-json-schema to this package

from ts-json-schema-generator.

Do you have any guidance on this? Should it be as easy as adding an allowAdditional flag to the different Object parser constructors? e.g InterfaceAndClassNodeParser and ObjectLiteralExpressionNodeParser

from ts-json-schema-generator.