Skip to content
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

feat(authority-storage): extend authority with additional fields #317

Closed

Conversation

elena-shmygaliova
Copy link
Collaborator

Purpose

Describe the purpose of this pull request. Why is this change necessary? What problem does it solve?

Approach

How does this change fulfill the purpose? Provide a high-level overview of the technical approach taken to address the problem.

Changes Checklist

  • API Changes: Document any API paths, methods, request or response bodies changed, added, or removed.
  • Database Schema Changes: Indicate any database schema changes and their impact. Confirm that migration scripts were created.
  • Interface Version Changes: Indicate any changes to interface versions.
  • Interface Dependencies: Document added or removed dependencies.
  • Permissions: Document any changes to permissions.
  • Logging: Confirm that logging is appropriately handled.
  • Unit Testing: Confirm that changed classes were covered by unit tests.
  • Integration Testing: Confirm that changed logic was covered by integration tests.
  • Manual Testing: Confirm that changes were tested on local or dev environment.
  • NEWS: Confirm that the NEWS file is updated with relevant information about the changes made in this pull request.

Related Issues

List any Jira issues related to this pull request.

Learning and Resources (if applicable)

Discuss any research conducted during the development of this pull request. Include links to relevant blog posts, patterns, libraries, or addons that were used to solve the problem.

Screenshots (if applicable)

If this pull request involves any visual changes or new features, consider including screenshots or GIFs to illustrate the changes.

Copy link
Collaborator

@psmagin psmagin left a comment

Choose a reason for hiding this comment

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

  1. Please create Jira ticket for the change (link is in README) and describe requirements and why it needed. It's needed for history purposes and to be able to have knowledge about why the change was made.
  2. Update NEWS.md
  3. Update Module descriptor by bumping minor version of authority-storage interface (as you made change to API)
  4. Please cover your change with tests.
  5. Please update description of the PR using provided template.

src/main/resources/db/changelog/changelog-master.xml Outdated Show resolved Hide resolved
Comment on lines 14 to 16
<addColumn tableName="authority_archive">
<column name="additional_headings" type="jsonb"/>
</addColumn>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why it was decided to have only one jsonb field?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

just to minimize number of new fields/columns in database

Copy link
Collaborator

Choose a reason for hiding this comment

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

What benefits will we gain from this approach? I want to ensure that it won't require us to undertake refactoring in the future.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

If we want to add other additional fields in future we don't have to add new columns to the table in db, we just need to extend a single "additinal_fields" jsonb column. It required minor change comparing to column-per-fieldType approach.

@psmagin psmagin changed the title feature/US1283231 Extend Authorities with additional fields feat(authority-storage): extend authority with additional fields Aug 22, 2024
Copy link

sonarcloud bot commented Aug 23, 2024

@elena-shmygaliova elena-shmygaliova deleted the feature/US1283231-extend-authorities branch August 23, 2024 14:15
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.

3 participants