Canonical URL registries in the TermBrowser

[paynejd]

We want to compile initial requirements and designs for the following:

• View global canonical URL registry (available to all users)
• View owner-specific (e.g. user or org) canonical URL registry (same permissions as the user or org)
• Add/Edit/Delete canonical URL registry entry

[paynejd]

@jamlung-ri and I discussed that we might take on the UI for canonical registries in stages something like this:

• Stage 1 - all users can view the global registry, and staff users can manage it
• Stage 2 - users can manage the registries in their own namespaces
• Stage 3 - canonicals integrated throughout the app – e.g. always have clarity on where a canonical is pointing; default workflows implemented for updating the global registry

[paynejd]

Requirements, mockups, and examples are here:
https://docs.google.com/presentation/d/1j49g6zNfwMag4gmoxEGfI0HG-6tQ4zEZpgwHooiUK4w/edit#slide=id.g2be25b8701d_1_34

@paulsonder Handing this over to you to for review and to turn into real designs for TBv3

[paulsonder]

@paynejd @snyaggarwal @jamlung-ri

Here's a proposal for the 'Test a Canonical' UI.

The example above shows a result, which includes where the Canonical resolved to in text form and by showing the Summary UI of the Repository object.

Let me know what you think and I can prepare the various states depending on the result.

[paulsonder]

@paynejd For 'add/edit/delete a canonical' - this only refers to URLs in a registry in a namespace I can edit? e.g. my User or an Org I admin?

[paynejd]

@paulsonder That's correct on edit privileges. Requirements for editing the global registry still need to be defined.

Is there an icon you could use for the Global registry (e.g. like a world icon?) since won't all of the users and orgs in the owner dropdown have an icon?

In the Test window, it's hard not to interpret Owner as the owner of the canonical, when it's supposed to be defining the namespace for the context of the request. What do you think of making this small change:

• In the registry tool, change the "Owner" label to "Registry Owner"
• In the test panel, change the "Owner" label to "Context" or "Request Context", or even "Namespace"?

Result should say "...resolved using an entry in..." and not "...resolved to..."

[paynejd]

• Draft some helper text to introduce the "Test a Canonical URL"

[paulsonder]

@paynejd Here's an updated version of the testing tool UI.

I trimmed down the text a little and worked on a new Chip to represent the Repository object. I'll provide a full set of those in the Chips ticket so they're available in the DS and linked to the Object map.

[paulsonder]

Hi @jamlung-ri + @snyaggarwal

The latest designs for Canonical URL registry are here.

I experimented with the testing tool in the same page, but ultimately it was a little crowded.

[jamlung-ri]

This is feeling good to me! I'd definitely like to see this implemented in TermBrowser v3 if everyone else feels good with it.

[snyaggarwal]

@paynejd @jamlung-ri @paulsonder Is this ready to be picked up?

[paulsonder]

@paynejd @jamlung-ri @paulsonder Is this ready to be picked up?

It's good from my side...

[paynejd]

@snyaggarwal This is ready to go!

[paynejd]

Canonical URL registry should only cache a repo, not a repo version. This is captured here: #1816

Open questions on Versioning:

• How does the registry behave if a canonical URL changed between repo versions?
• How does the "Test a Canonical URL" tool handle repo versions? e.g. piped version in the test, display of repo version

Possible results, including how to process repo version:

Request Type	Result Type	Resolved to a Repository	Did not resolve to a Repository
http://loinc.org	Namespace Registry Match	“https://loinc.org” resolved to [ Regenstrief Org / LOINC Code System | latest (2.77) ] using an entry in the [ PIH Organization ] Registry	“https://loinc.org” matched an entry in the [ PIH Organization ] Registry but did not resolve to a repository
http://loinc.org|2.60	Namespace Registry Match	“https://loinc.org|2.60” resolved to [ Regenstrief Org / LOINC Code System | 2.60 ] using an entry in the [ PIH Organization ] Registry	“https://loinc.org|2.60” matched an entry in the [ PIH Organization ] Registry but did not resolve to a repository
http://loinc.org	Namespace Repository Match	“https://loinc.org” resolved to [ PIH Organization / LOINC-PIH Code System | latest (2.60) ] by matching a repository in the [ PIH Organization ]	N/A
http://loinc.org|2.60	Namespace Repository Match	“https://loinc.org” resolved to [ PIH Organization / LOINC-PIH Code System | 2.60 ] by matching a repository in the [ PIH Organization ]	N/A
http://loinc.org	Global Registry Match	“https://loinc.org” resolved to  [ Regenstrief Org / LOINC Code System | latest (2.77) ]  using an entry in the Global Registry	“https://loinc.org” matched an entry in the Global Registry but did not resolve to a repository
http://loinc.org|2.60	Global Registry Match	“https://loinc.org|2.60” resolved to  [ Regenstrief Org / LOINC Code System | 2.60 ]  using an entry in the Global Registry	“https://loinc.org|2.60” matched an entry in the Global Registry but did not resolve to a repository
http://loinc.org	No Match	N/A	“https://loinc.org” did not match an entry in the Global Registry or the [ PIH Organization ] Registry and did not resolve to a repository

[paulsonder]

Designs updated to include the new Chip component.

[snyaggarwal]

First version of this is deployed on QA

[paynejd]

"Test a Canonical URL" should use $resolveReference rather than $lookup.

[snyaggarwal]

@paynejd this is deployed on QA v3

[snyaggarwal]

@jamlung-ri @paynejd Any feedback on this or can we close this?

[jamlung-ri]

I don't have any further feedback for this iteration, but I do want to make sure we capture outstanding items in follow-up tickets. I think this can be closed now.

Add a canonical URL: #1827