Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation of annotations ? #1819

Closed
NotSqrt opened this issue Nov 22, 2023 · 3 comments
Closed

Documentation of annotations ? #1819

NotSqrt opened this issue Nov 22, 2023 · 3 comments

Comments

@NotSqrt
Copy link

NotSqrt commented Nov 22, 2023

Hello,

I've discovered the @discriminator annotation in this example : https://github.com/vega/ts-json-schema-generator/blob/898525113e9763f592664232a50824ca4da64d02/test/valid-data/discriminator/main.ts

Is there a list / documentation of the available annotations somewhere ?

Thanks a lot !

@domoritz
Copy link
Member

Should be in the readme. If not, that's a documentation bug that the pull request author for the feature should resolve.

@GKersten
Copy link

GKersten commented Aug 20, 2024

@domoritz I am just trying to get a hang of this library, you mention the documentation for the annotations should be in the readme, but the readme in the root of this repository does not seem to mention anything regarding annotations. To me this question asked here is still valid, but maybe I am missing something?

Could you point me to any documentation regarding the annotations we can use? So far only thing I was able to find are the "valid-data" tests to use as a reference:
https://github.com/vega/ts-json-schema-generator/tree/next/test/valid-data

@domoritz
Copy link
Member

I agree. I made a new issue with the specific documentation request #2045.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants