Add qualityDataObjectKey to the inventory pretty names - #748
Merged
Merged
Conversation
sr-dash
force-pushed
the
humanize-quality-data-key
branch
from
August 6, 2026 22:20
78c987d to
45eb503
Compare
The dataset search API now returns qualityDataObjectKey, the object key of the JSON quality data file, alongside the existing PDF qualityReportObjectKey. Give it a human readable name so it is translated in search results and usable as a path interpolation key. Closes DKISTDC#649
Cadair
force-pushed
the
humanize-quality-data-key
branch
from
August 20, 2026 13:25
45eb503 to
e9698f7
Compare
Cadair
enabled auto-merge (squash)
August 20, 2026 13:28
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Fixes #649.
Adds
"qualityDataObjectKey": "Quality Data Filename"toINVENTORY_KEY_MAP, so the key is translated in search results and gets aquality_data_filenamepath interpolation key, matching the existingqualityReportObjectKey->"Quality Report Filename".I checked what the API actually returns for the key before picking the name:
so "Quality Data Filename" seemed like the natural counterpart, but I'm happy to rename it if you'd prefer something that makes the PDF/JSON distinction more explicit.
Extended
test_humanize_loopto round-trip the new key rather than adding a separate test, since it's exactly what that test is for. The fixed keymap intest_path_format_tableis deliberately untouched — it's independent ofINVENTORY_KEY_MAPso adding entries doesn't churn it.Two things I noticed but left out of scope, tell me if you'd like either as a follow-up:
tileCountis also returned by the search API and isn't inINVENTORY_KEY_MAP.DKISTFileManager._download_datasetaddsqualityReportObjectKeyto the Globus transfer file list; it doesn't add the new quality data file. That's a behaviour change rather than a naming one, so I've not touched it.