Skip to content

FINERACT-2095: Support for string type primary keys - part 2 - Use String based identifiers for enums - #3937

Merged
adamsaghy merged 1 commit into
apache:developfrom
marta-jankovics:FINERACT-2095
Jun 26, 2024
Merged

FINERACT-2095: Support for string type primary keys - part 2 - Use String based identifiers for enums#3937
adamsaghy merged 1 commit into
apache:developfrom
marta-jankovics:FINERACT-2095

Conversation

@marta-jankovics

Copy link
Copy Markdown
Contributor

Description

Details are present on the ticket.
Additionally the PR contains a small cleanup regarding the usage of id (or value), code, description (or name).

EnumOptionData has these values:

  • id: T (String, Long or Integer or...) - identifier that is saved into the database and sent in the API requests
  • code: String - systemwide unique identifier, usually built of the name of the enum and the name of the enum option (eg. statusEnum.create), technical, not shown
  • description: String - user friendly display name, shown on the ui

Please see an example in org.apache.fineract.infrastructure.dataqueries.data.StatusEnum

Checklist

Please make sure these boxes are checked before submitting your pull request - thanks!

  • Write the commit message as per https://github.com/apache/fineract/#pull-requests

  • Acknowledge that we will not review PRs that are not passing the build ("green") - it is your responsibility to get a proposed PR to pass the build, not primarily the project's maintainers.

  • Create/update unit or integration tests for verifying the changes made.

  • Follow coding conventions at https://cwiki.apache.org/confluence/display/FINERACT/Coding+Conventions.

  • Add required Swagger annotation and update API documentation at fineract-provider/src/main/resources/static/legacy-docs/apiLive.htm with details of any API changes

  • Submission is not a "code dump". (Large changes can be made "in repository" via a branch. Ask on the developer mailing list for guidance, if required.)

FYI our guidelines for code reviews are at https://cwiki.apache.org/confluence/display/FINERACT/Code+Review+Guide.

@adamsaghy adamsaghy left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kindly asking you to double check your changes and remove the unused classes and move the unrelated changes (refactor, rename, type changes) into a new PR. you might wanna use FINERACT-2081 for this purpose)

@marta-jankovics

Copy link
Copy Markdown
Contributor Author

Kindly asking you to double check your changes and remove the unused classes and move the unrelated changes (refactor, rename, type changes) into a new PR. you might wanna use FINERACT-2081 for this purpose)

Removed one class which will come with the next PR, but I do not see more.

@adamsaghy adamsaghy left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@adamsaghy
adamsaghy merged commit 009e9de into apache:develop Jun 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants