Skip to content
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

Set single URL for part of dct_references_s #139

Merged
merged 1 commit into from
Feb 7, 2024

Conversation

ghukill
Copy link
Contributor

@ghukill ghukill commented Feb 7, 2024

Purpose and background context

It was discovered that the Aardvark format expects only a single URL for the dct_references_s key http://schema.org/url, where previously we had set this as a list of objects containing lable and URL like http://schemal.org/downloadUrl.

This changes the final structure from an array of objects:

{
    "http://schema.org/url":[ {complex object here...} ]
}

to a single string:

{
    "http://schema.org/url": "https://geodata.libraries.mit.edu/record/abc123"
}

This also updates the hostname for where this URL points back to geodata.libraries.mit.edu which is the anticipated TIMDEX UI for geo resources.

Includes new or updated dependencies?

NO

Changes expectations for external applications?

YES - Transmogrifier has an associated PR: MITLibraries/transmogrifier#118

What are the relevant tickets?

Developer

  • All new ENV is documented in README
  • All new ENV has been added to staging and production environments
  • All related Jira tickets are linked in commit message(s)
  • Stakeholder approval has been confirmed (or is not needed)

Code Reviewer(s)

  • The commit message is clear and follows our guidelines (not just this PR message)
  • There are appropriate tests covering any new functionality
  • The provided documentation is sufficient for understanding any new functionality introduced
  • Any manual tests have been performed and verified
  • New dependencies are appropriate or there were no changes

Why these changes are being introduced:
It was discovered that the Aardvark format expects only a single URL for the dct_references_s
key 'http://schema.org/url', where previously we had set this as a list of URLs like
'http://schemal.org/downloadUrl'.

This also updates the hostname for where this URL points back to 'geodata.libraries.mit.edu' which
is the anticipated TIMDEX UI for geo resources.

How this addresses that need:
* Sets single URL for 'http://schema.org/url'
* Updates domain name

Side effects of this change:
* Requires an associated PR in Transmogirifer to expect a single value and not an array; forthcoming

Relevant ticket(s):
* https://mitlibraries.atlassian.net/browse/GDT-68
@ghukill ghukill merged commit bdbd426 into main Feb 7, 2024
4 checks passed
@ghukill ghukill deleted the GDT-68-update-external-url branch March 26, 2024 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants