CARVIEW |
Select Language
HTTP/2 200
date: Sun, 27 Jul 2025 01:07:47 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=378.172791,conversation_content-fragment;desc="conversation_content fragment";dur=337.958099,conversation_sidebar-fragment;desc="conversation_sidebar fragment";dur=253.42349,nginx;desc="NGINX";dur=0.798712,glb;desc="GLB";dur=100.894664
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=B1iGMJB0pmbZNNd4VTdq4vihfxuZwkRPBaiAAjMUP6y6MxVx%2BgdZnUnrcv2J0cjZG941gVyFzeZDRxmLQX2svNnV0K8cyx9LILjAhrM4uNIipk5gFpc8rciQAELt5IZfRv8eE32Q3lw6cbF2vcYEzqeKUN4OkcFqfwuqBWt8FW6JZVinDmw0S6YZIP%2Fe%2FiHnLuczwQIvaCC3q8WBzTGwA6aYUaTogjjiYEbkwKl4bthyzuIPn0d8KEGDJw3qDcHRvo0UGyi6ilnFT2cmrPSY4Q%3D%3D--1aDhAWdl7FcoFXRj--1fPbF5L46DxwGcAeJtluNA%3D%3D; Path=/; HttpOnly; Secure; SameSite=Lax
set-cookie: _octo=GH1.1.1648575901.1753578467; Path=/; Domain=github.com; Expires=Mon, 27 Jul 2026 01:07:47 GMT; Secure; SameSite=Lax
set-cookie: logged_in=no; Path=/; Domain=github.com; Expires=Mon, 27 Jul 2026 01:07:47 GMT; HttpOnly; Secure; SameSite=Lax
x-github-request-id: AD28:3C6DB4:5F48C:99B52:68857BE3
Read-only and write-only properties (Jackson2, JSDoc tags) by vojtechhabarta · Pull Request #579 · vojtechhabarta/typescript-generator · GitHub
Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 247
Read-only and write-only properties (Jackson2, JSDoc tags) #579
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
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
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.
When communicating using JSON objects over HTTP usually most of the properties are sent in both directions (GET vs. POST, PUT). But sometimes some properties are sent only from server to client and others are sent only from client to server. Classical example can be following REST object:
In this example when client application is creating new
User
it sendsname
andpassword
properties then server generatesid
property and returnsUser
object containingid
andname
properties. As you can see Jackson2 library allows us to mark properties read-only or write-only using@JsonProperty
annotation.This PR provides possibility to leverage Jackson2 support for read-only and write-only properties and generate for example following TypeScript declaration:
This feature is turned off by default and can be turned on using
generateReadonlyAndWriteonlyJSDocTags
parameter.Read-only and write-only properties can be used not only for real read-only or write-only properties like in
id
andpassword
example but we can also have resource object where some property has different "shape" when it is read or written by client. For example we can have logical propertyusers
(access control list) which is sent in "expanded" form by server but client sends just user IDs:Currently this feature is limited to Jackson2 library (input) and JSDoc tags (output) but it can be expanded in the future.