Improve Contact presentation to Publishing API #4475
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Many of contacts in Publishing API have big chunks of empty data in them
which causes poor rendering.
Example:
```
{:description=>"Email monitored Monday - Friday, 9.00am - 5.00pm",
:contact_type=>"Media contact",
:title=>"Press Office (media enquiries)",
:contact_form_links=>
[{:title=>"Press Office (media enquiries)", :link=>"", :description=>""}],
:post_addresses=>
[{:title=>"",
:street_address=>"",
:locality=>"",
:region=>"",
:postal_code=>"",
:world_location=>""}],
:email_addresses=>[{:title=>"", :email=>"[email protected] "}],
:phone_numbers=>
[{:title=>"Belfast", :number=>"028 9052 7856 "},
{:title=>"Out of hours duty press officer",
:number=>"M: +44 +44 7464 981449"}]}
```
To resolve this this uses the presence methods on strings or nils to
make them nil and then uses compact to remove them from hashes.
This also removes the title from the contact form as it did not make
sense to duplicate the contact title here (and is not required by the
schema)
This adds the iso2_country_code field for the post_addresses section of Contacts' details. Field was introduced in: alphagov/govuk-content-schemas#830
benthorner
approved these changes
Nov 7, 2018
| details[:post_addresses] = [post_address] if postal_code | ||
| details[:email_addresses] = [email_address] if email | ||
| details = { | ||
| title: title, |
There was a problem hiding this comment.
I think you changed the schema so these aren't required anymore - just wondering if you meant to remove these now?
There was a problem hiding this comment.
I'm not 100% sure what the consequences are of removing them, but am confident they shouldn't be used.
kevindew
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Trello: https://trello.com/c/gEAMmD0g/386-ability-to-embed-a-contact-via-markdown
This is marked as DNM as it requires this alphagov/govuk-content-schemas#830 to be deployed.
This resolves a lot of empty data problems with Contacts data in the Publishing API by removing null and empty string values. It also adds in the iso2_country_code field to help with rendering contacts in govspeak correctly: alphagov/govspeak#130