gentics / gentics/mesh-model-generator

In a UserResponse rolePerms is optional, but required in all other response models.

Open
#13 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
3
Forks
1
PR merge metrics
No merged PRs in 30d

Description

See https://github.com/gentics/mesh-ui/blob/f3880d4c045d573c40a229ee0e14b0b96f415efe/src/app/common/models/server-models.ts#L4288

In fact, I think rolePerms should always be optional, since it depends on the role query parameter. I'm not sure if the error there lies with the Raml or with the model generator.

On a related theme, the editor property of the UserResponse is also optional, whereas all other response models have it as required. I have created this Jira ticket after discussing the editor thing with Johannes: https://jira.gentics.com/browse/CL-605

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 with the generated UserResponse definition in src/app/common/models/server-models.ts at the referenced location, then compare its rolePerms and editor properties with the other response models. Trace whether their optionality comes from the RAML spec or the model generator. Done means the generated models consistently reflect the intended optionality, including the role query parameter behavior and the related editor requirement.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.