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

refactor(filemanager): misc simpler and clearer API #492

Merged
merged 3 commits into from
Aug 18, 2024

Conversation

mmalenic
Copy link
Member

Some more misc changed, related to #462

Changes

  • JSON patch now supports append only, so "add", "test", or "copy" only if an existing key is not being overwritten.
  • The outer "attributes" on patch requests is not required.
  • date has been renamed to eventTime for more clarity. /cc @williamputraintan

I'm holding off on implementing the shortened attributes query string feature, e.g. portal_run_id=... rather than attributes[portal_run_id]=... as described in #462. This is slightly more complex as it involves capturing unknown parameters in the API. I'm not sure if this is the best idea, because it has the potential to conflict with existing parameters.

@mmalenic mmalenic requested review from brainstorm and victorskl and removed request for brainstorm August 16, 2024 05:38
@mmalenic mmalenic self-assigned this Aug 16, 2024
@mmalenic mmalenic added filemanager an issue relating to the filemanager pipeline Workflow/Pipeline Manager refactor and removed pipeline Workflow/Pipeline Manager labels Aug 16, 2024
@mmalenic mmalenic linked an issue Aug 16, 2024 that may be closed by this pull request
Copy link
Member

@victorskl victorskl left a comment

Choose a reason for hiding this comment

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

LGTM.

Noted well about the challenge with the query parameter impl. We can brainstorm together more.

Copy link
Member

@brainstorm brainstorm left a comment

Choose a reason for hiding this comment

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

Makes sense to not drop attributes[] prefix, I suspected it would clash with some other namespace and it seems it indeed does? :-/

@mmalenic mmalenic merged commit 428a3e9 into main Aug 18, 2024
5 checks passed
@mmalenic mmalenic deleted the refactor/simpler-attributes branch August 18, 2024 23:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
filemanager an issue relating to the filemanager refactor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

filemanager: consider making the attribute API more user-friendly
3 participants