-
Notifications
You must be signed in to change notification settings - Fork 66
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
[CST] Modifies claim letter downloader to include a new field for a unified display description #19241
[CST] Modifies claim letter downloader to include a new field for a unified display description #19241
Conversation
… display description
@@ -69,6 +69,7 @@ class ClaimLetters < ApplicationController | |||
end | |||
property :version, type: :string | |||
property :type_description, type: :string | |||
property :display_description, type: :string |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm flying blind on this one, I'm not sure if this file is automated or if I need to change it or what.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would go ahead and call this display_name
as that is used elsewhere in CST
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After this conversation I am going to reappropriate the type_description
, actually. That's what mobile is displaying, so I will simply change that field to be the human-readable name.
Does that sound ok to you?
@@ -6,6 +6,20 @@ module ClaimStatusTool | |||
class ClaimLetterDownloader | |||
FILENAME = 'ClaimLetter' | |||
DEFAULT_ALLOWED_DOCTYPES = %w[184].freeze | |||
DOCTYPE_TO_DISPLAY_DESCRIPTION = { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the same mapping from the frontend, which also mirrors Julie's table in the initial change request.
…displaying type_description
…github.com/department-of-veterans-affairs/vets-api into 96224-additional-claim-development-letters
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pretty cool to have this mapping happening in one place
40 commits behind master. I'm updating your branch just in case. |
Backend-review-group approval confirmed. |
Summary
display_description
, to the rendered letter json. This allows the clients (web and mobile) to display the same, human-readable name for each letter.cst_include_ddl_5103_letters
cst_include_ddl_sqd_letters
Related issue(s)
Testing done
display_description
field within the claim letter json.display_description
.What areas of the site does it impact?
This affects the Claim Letters view.
Acceptance criteria
Requested Feedback
I was looking around in the mobile app to see their analogous code to the frontend transformation linked above, but did not find any. How does mobile do this? My goal is to get the letter names standardized without the need for changing any mobile code, but I think adding a new field to the json response will necessitate accommodating changes to display that new field in the mobile app. Right?