[Masthead]: Modify the `data-endpoint` prop/attribute to accept full endpoint URL protocol - DDS Consulting

[proeung]

Engineering info:

• HC engineer: @proeung
• HC Jira Ticket: https://jsw.ibm.com/browse/HC-2290
• DDS consulting engineer: Andrew Wang

---

The problem

• The Hybrid Cloud team is in the process of adopting the <dds-masthead-container> component to launch two navigational L0’s supporting the Storage & QRadar ecosystems that are managed in Drupal CMS (see attached).
• We're looking to leverage the existing Drupal SiteNav authoring process for managing the data that will be exposed via a JSON API that the WC Masthead will be fetched.
• The current data-endpoint attribute allows the adopters to set a custom endpoint for the translation service to fetch from, however, it only accepts host domain that's coming from https://1.www.s81c.com - https://github.com/annawen1/ibm-dotcom-library/blob/master/packages/services/src/services/Translation/Translation.js#L19
  • Full API endpoint example: https://1.www.s81c.com/common/carbon-for-ibm-dotcom/translations/masthead-footer/usen.json
• While AEM eventually needs to integrate this content/data management, we can lay the groundwork using Drupal and its SiteNav nodes so that we can eliminate the pain point of manually updating the JSON files and leveraging the translation jobs that are available for use within Drupal.

The solution

• Modify the translation service to accept HTTPS call defined in the data-endpoint attribute.
• This protocol checking logic allows us to define the destination of the endpoint that outputs the same JSON data structure as what's being defined in the ibm-dotcom-translations repo, but the data will be dynamically pulled out of Drupal instead of the manual editing process.

• See the example below:

  <dds-masthead-container
  data-endpoint="https://www.ibm.com/jsonrpc?query=0pioefrql3ekjasdfalml09asd"
  ></dds-masthead-container>
  ```-masthead-container>

Application/website

Drupal

Business priority

High Priority = pressing release

What time frame would this ideally be needed by (if applicable)

No response

Examples

New navigational L0 Masthead supporting the Storage & QRadar products

Dynamic masthead system plan on the Drupal side.

Code of Conduct

• [X] I agree to follow this project's Code of Conduct
• [X] I checked the current issues for duplicate issues

[RobertaJHahn]

@proeung Your priority says that there is a pressing release. What is the release date and when does the work have to be finished to make it into the release?

[proeung]

@RobertaJHahn We're scheduling the Drupal launch of the new masthead for the Storage & QRadar products for around December 14, therefore we'd like to get this feature in sooner rather than later, which means that we might suggest creating a patch rc against v1.27.0. I'm in the process of chatting with @annawen1 and @jeffchew to see this is feasible and if it's not, we're happy to fall back to the manual masthead data management workflow that we've implemented for the current Cloud Masthead through the webstandards/ibm-dotcom-translations repo.

cc: @kjwhitla

[jeffchew]

@RobertaJHahn We're scheduling the Drupal launch of the new masthead for the Storage & QRadar products for around December 14, therefore we'd like to get this feature in sooner rather than later, which means that we might suggest creating a patch rc against v1.27.0. I'm in the process of chatting with @annawen1 and @jeffchew to see this is feasible and if it's not, we're happy to fall back to the manual masthead data management workflow that we've implemented for the current Cloud Masthead through the webstandards/ibm-dotcom-translations repo.

cc: @kjwhitla

Let's discuss in our upcoming meeting, but patches are reserved for sev 1 hotfixes only and should not introduce any new features or functionality. We can probably at best introduce this in the v1.28.0 release.

cc: @RobertaJHahn @ljcarot