spring-projects / spring-projects/spring-hateoas

Disable readOnly attribute for HAL-FORMS

Open
#1,310 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
1.1k
Forks
476
PR merge metrics
No merged PRs in 30d

Description

Currently, I am using 1.1.0.
Referring to this, the readOnly attribute on a HAL-FORMS field always shows up when there are no setters.
It would be nice to have the option to remove it or not have it at all by default when there are no setters.

The situation that I am currently in is that my POJO only uses builders to modify fields, not setters. Therefore, it is technically mutable, just not with setters. Thus, the readOnly attribute does not apply, and yet, since the attribute always displays when there are no setters, it would be nice to have a way to remove it.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the HAL-FORMS metadata section linked in the issue and trace how fields without setters are marked readOnly. Reproduce the behavior with a POJO that uses builders rather than setters, then define and verify an option for omitting or disabling readOnly when generating HAL-FORMS metadata.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.