UIREC-316: Change field name of "Caption" to Display summary #487
Conversation
There was a problem hiding this comment.
I expected a one-line change in en.json where we just change the displayed name. Given the underlying data structure is changing too, I'm surprised there isn't a breaking change in the version of the Okapi API. Did we miss that here (or did the underlying API miss something when it changed the name of that field 😒)?
|
@zburke after discussion with our team, we are planning to deploy changes at the same time in order to prevent automated tests from failing. We have backend changes that are ready https://github.com/folio-org/mod-orders/pull/826/files |
|
@zburke basically this field is used in editing/receiving/unreceiving piece and also new field to mod-inventory added with the same name folio-org/mod-inventory#673 . To not confuse how 'caption' correlates with 'displaySummary' we decided to rename from 'caption' to 'displaySummary' with writing migration script and increased major versions of interfaces. Regarding external usages - we don't know other consumers for these interfaces, only UI for now, so probably better to rename now than when we have different external consumers. |
|
Thanks for the details, @SerhiiNosko, that's super helpful!
But there were no updates to the interface version here in |
@alisher-epam can you please update to the newest major versions of interfaces, you can find them in this PR: https://github.com/folio-org/mod-orders/pull/826/files |
| "pieces": "3.0", | ||
| "receiving": "2.0", |
There was a problem hiding this comment.
Bumping an okapi interface version is akin to bumping a peer-dependency version; this is a breaking change. Please update the module version to 5.0.0 and call out this change in the CHANGELOG, e.g.
* *BREAKING* Bump minimum okapi interfaces for `pieces` (3.0) and `receiving` (2.0). Refs UIREC-316.
There was a problem hiding this comment.
Update the PR according to your comments.
|
| @@ -15,6 +15,8 @@ | |||
| * Send claim action for piece record. Refs UIREC-304. | |||
| * Align the display of fields in full screen receiving view and piece edit form. Refs UIREC-296. | |||
| * Expect "Unreceivable" pieces on the full screen form. Refs UIREC-307. | |||
| * Change field name of "Caption" to Display summary. Refs UIREC-316. | |||
There was a problem hiding this comment.
this is not required anymore
| @@ -31,8 +31,8 @@ | |||
| "order-lines": "2.0 3.0", | |||
| "orders": "11.0 12.0", | |||
| "organizations.organizations": "1.0", | |||
| "pieces": "2.0", | |||
| "receiving": "1.0", | |||
| "pieces": "3.0", | |||
There was a problem hiding this comment.
check interfaces in other places, inventory orders etc
|
@zburke @SerhiiNosko Since this has breaking changes, I have created a new PR here #488 |
Purpose
UIREC-316 - Change field name of "Caption" to Display summary
Approach
TODOS and Open Questions
Learning
Pre-Merge Checklist
Before merging this PR, please go through the following list and take appropriate actions.
If there are breaking changes, please STOP and consider the following:
Ideally all of the PRs involved in breaking changes would be merged in the same day to avoid breaking the folio-testing environment. Communication is paramount if that is to be achieved, especially as the number of intermodule and inter-team dependencies increase.
While it's helpful for reviewers to help identify potential problems, ensuring that it's safe to merge is ultimately the responsibility of the PR assignee.