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

Add URI to TOC API #3471

Merged
merged 3 commits into from Jun 27, 2023
Merged

Conversation

dbutenhof
Copy link
Member

@dbutenhof dbutenhof commented Jun 24, 2023

PBENCH-624

We're not quite ready to rebuild the /datasets/{dataset}/contents API on the cache manager. (I actually tried; it's not all there, and currently would need to be built via a full tarball unpack each time we build a CacheManager instance, while the changes to persist it via SQL or Redis, which I'd like to do soon, seemed too big a lift right now.)

However, we have planned for some time to supplement the TOC information with a uri element for each file and subdirectory; this much smaller change makes the code match the API documentation.

@dbutenhof dbutenhof added Server Dashboard Of and relating to the Dashboard GUI API Of and relating to application programming interfaces to services and functions labels Jun 24, 2023
@dbutenhof dbutenhof self-assigned this Jun 24, 2023
@dbutenhof dbutenhof marked this pull request as ready for review June 24, 2023 12:10
webbnh
webbnh previously approved these changes Jun 26, 2023
Copy link
Member

@webbnh webbnh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks OK to me. Just a couple of small comments/questions.

dashboard/src/actions/tableOfContentActions.js Outdated Show resolved Hide resolved
lib/pbench/server/api/resources/__init__.py Show resolved Hide resolved
PBENCH-624

We're not quite ready to rebuild the `/datasets/{dataset}/contents` API on the
cache manager. (I actually tried; it's not all there, and currently would need
to be built via a full tarball unpack each time we build a `CacheManager`
instance, while the changes to persist it via SQL or Redis, which I'd like to
do soon, seemed too big a lift right now.)

However, we have planned for some time to supplement the TOC information with
a uri element for each file and subdirectory; this much smaller change makes the
code match the API documentation.
With these changes, it's possible to navigate down the directory hierarchy.
Navigating backwards on the "breadcrumb" line (still) doesn't quite work, but
I now believe that my URI change in the API hasn't made anything worse than it
was before.
Copy link
Member

@webbnh webbnh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@dbutenhof dbutenhof merged commit bfdc613 into distributed-system-analysis:main Jun 27, 2023
4 checks passed
@dbutenhof dbutenhof deleted the toces branch June 27, 2023 18:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Of and relating to application programming interfaces to services and functions Dashboard Of and relating to the Dashboard GUI Server
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants