CARVIEW |
Select Language
HTTP/2 200
date: Sun, 27 Jul 2025 01:05:51 GMT
content-type: text/html; charset=utf-8
cache-control: no-cache
content-security-policy: default-src 'none'; base-uri 'self'; child-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com *.rel.tunnels.api.visualstudio.com wss://*.rel.tunnels.api.visualstudio.com objects-origin.githubusercontent.com copilot-proxy.githubusercontent.com proxy.individual.githubcopilot.com proxy.business.githubcopilot.com proxy.enterprise.githubcopilot.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com productionresultssa0.blob.core.windows.net/ productionresultssa1.blob.core.windows.net/ productionresultssa2.blob.core.windows.net/ productionresultssa3.blob.core.windows.net/ productionresultssa4.blob.core.windows.net/ productionresultssa5.blob.core.windows.net/ productionresultssa6.blob.core.windows.net/ productionresultssa7.blob.core.windows.net/ productionresultssa8.blob.core.windows.net/ productionresultssa9.blob.core.windows.net/ productionresultssa10.blob.core.windows.net/ productionresultssa11.blob.core.windows.net/ productionresultssa12.blob.core.windows.net/ productionresultssa13.blob.core.windows.net/ productionresultssa14.blob.core.windows.net/ productionresultssa15.blob.core.windows.net/ productionresultssa16.blob.core.windows.net/ productionresultssa17.blob.core.windows.net/ productionresultssa18.blob.core.windows.net/ productionresultssa19.blob.core.windows.net/ github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com api.githubcopilot.com api.individual.githubcopilot.com api.business.githubcopilot.com api.enterprise.githubcopilot.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com copilot-workspace.githubnext.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: blob: github.githubassets.com media.githubusercontent.com camo.githubusercontent.com identicons.github.com avatars.githubusercontent.com private-avatars.githubusercontent.com github-cloud.s3.amazonaws.com objects.githubusercontent.com release-assets.githubusercontent.com secured-user-images.githubusercontent.com/ user-images.githubusercontent.com/ private-user-images.githubusercontent.com opengraph.githubassets.com copilotprodattachments.blob.core.windows.net/github-production-copilot-attachments/ github-production-user-asset-6210df.s3.amazonaws.com customer-stories-feed.github.com spotlights-feed.github.com objects-origin.githubusercontent.com *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/ secured-user-images.githubusercontent.com/ private-user-images.githubusercontent.com github-production-user-asset-6210df.s3.amazonaws.com gist.github.com; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; upgrade-insecure-requests; worker-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/
referrer-policy: no-referrer-when-downgrade
server-timing: pull_request_layout-fragment;desc="pull_request_layout fragment";dur=270.112837,conversation_content-fragment;desc="conversation_content fragment";dur=357.589912,conversation_sidebar-fragment;desc="conversation_sidebar fragment";dur=180.322197,nginx;desc="NGINX";dur=0.929052,glb;desc="GLB";dur=101.463086
strict-transport-security: max-age=31536000; includeSubdomains; preload
vary: X-PJAX, X-PJAX-Container, Turbo-Visit, Turbo-Frame, X-Requested-With,Accept-Encoding, Accept, X-Requested-With
x-content-type-options: nosniff
x-frame-options: deny
x-voltron-version: a2eb102
x-xss-protection: 0
server: github.com
content-encoding: gzip
accept-ranges: bytes
set-cookie: _gh_sess=jiXbbW%2FGQohctPSpXG2BHTIbt7eYlO11Te%2F4u0BdbKEdGuXHWeyduHQGi76Z%2BauTeJRd4utv5HlExGx3hpJShG%2FTqWIoxuvyYHww7dL%2BjS8ToLXMMqdzOaLu2eBZvVgLTt35KeuuxNFHB68pAKnxXyntTpgQ3CIuMTNKe5heWOce%2B8aW9fjWJz026Q7GXPK3w7Ppb4udGSWkcm7SsNHtniqmJf7Bh22LJ0vT2oyHA9DqSv3H56nfmdCxH7pNvS251aYFkbMpasTkst4JmB0rEA%3D%3D--th%2FXKKE2qVhZMY4P--L42UsfZhgTgZZ44Ou6ezVQ%3D%3D; Path=/; HttpOnly; Secure; SameSite=Lax
set-cookie: _octo=GH1.1.362126498.1753578351; Path=/; Domain=github.com; Expires=Mon, 27 Jul 2026 01:05:51 GMT; Secure; SameSite=Lax
set-cookie: logged_in=no; Path=/; Domain=github.com; Expires=Mon, 27 Jul 2026 01:05:51 GMT; HttpOnly; Secure; SameSite=Lax
x-github-request-id: B554:3467EF:9C7AC4:CEAC3F:68857B6F
Optional properties using Jackson2 by vojtechhabarta · Pull Request #183 · vojtechhabarta/typescript-generator · GitHub
Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 247
Optional properties using Jackson2 #183
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
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This looks great, thanks. I've tested it on my Kotlin project and everything seems to work as expected. |
This was referenced Oct 3, 2017
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
You can’t perform that action at this time.
This PR is continuation of #179, thanks @Yona-Appletree for feature request and first implementation.
This PR adds
optionalProperties
parameter with allowed valuesuseSpecifiedAnnotations
,useLibraryDefinition
andall
.It also changes how Jackson2 modules are treated, this is incompatible change, please see details below.
Optional Properties
1.
optionalProperties
=useSpecifiedAnnotations
Let's say we want to generate following TypeScript interface:
We can do this with this configuration:
and Java class:
This was already possible and it is still default behavior.
2.
optionalProperties
=useLibraryDefinition
With this new feature we can leverage Jackson2 to determine which properties are optional and which required. Then it is possible to use Jackson2 annotations, JAXB annotations or even Kotlin nullable types to specify property optionality.
Jackson2 library
Following configuration:
allows us to use
@JsonProperty
to specify optionality:JAXB library
Similarly for JAXB. Configuration:
class:
Kotlin nullable types
Jackson2 provides
KotlinModule
which makes nullable types accessible to typescript-generator.This module can be configured using this snippet:
Then we can write Kotlin data class like this:
and typescript-generator will know from Jackson2 which properties are required/optional.
3.
optionalProperties
=all
This makes all properties optional. This setting have same effect as
declarePropertiesAsOptional
parameter (which is now deprecated).Jackson2 modules
Before this PR typescript-generator by default loaded all Jackson2 modules automatically. This automatic module discovery relies on module presence on classpath which is relatively fragile mechanism and for example
JaxbAnnotationModule
currently breaks@JsonProperty.required
functionality.So now typescript-generator by default loads no modules. Previous behavior can be turned on using
jackson2ModuleDiscovery
parameter. Individual modules can be specified usingjackson2Modules
parameter (recommended way). OlddisableJackson2ModuleDiscovery
parameter is effectively removed.