[Bug] v2 API: custom field options are an object on read but must be a JSON string on write
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- go, json
- Domain
- api, backend-api-design
Research direction
Start with the api/openapi-v2.json schema for options on custom fields, then find the v2 handlers for GET /custom-fields and POST/PATCH /custom-fields/{id} to compare how each side encodes and decodes it. Agree with maintainers whether the parsed object or the JSON string is canonical before editing, since the issue leaves that open. Done when a read can be written back unchanged and the OpenAPI document matches the actual behaviour.
Written by the indexing model from the issue text.
Description
Version: main (b1a9898)
GET /rest/api/v2/custom-fields returns each field's options already parsed ({"next_id": N, "items": [{"id", "label"}]}), while POST /custom-fields and PATCH /custom-fields/{id} declare options as a string in api/openapi-v2.json and accept the same structure JSON-encoded. A client that reads a multiselect field, adds an option and writes it back has to re-encode in between; one that assumes the documented string on read crashes.
Expected: the same representation both ways, ideally the parsed object, with the OpenAPI document updated to match.
Minor, but it cost a failed sync run on our side, so noting it.
- Dominant language
- Go
- Stars
- 421
- Forks
- 50
- Avg merge
- 17h 34m
- Merged PRs (30d)
- 80
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Windshiftapp/core
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
Windshiftapp/core#542 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
Windshiftapp/core#334 · 2 comments ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Windshiftapp/core#259 · 1 comment · 1 reaction ·
Maintainers usually reply within 1 day
-
[Bug][AI chat] Select menu dont appear when on index pagePossibly taken @valentimarco claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 20/100
Windshiftapp/core#541 ·
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
Windshiftapp/core#538 · 1 reaction ·
Maintainers usually reply within 1 day
All issues in Windshiftapp/core
Similar issues
-
good first issue help wanted javascript
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
fullsend-ai/fullsend#9733 · 1 comment · 1 reaction ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
karmada-io/karmada#8101 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day