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

Change non-standard return data format of ProjectIrodsFileListAPIView #2040

Closed
4 tasks done
mikkonie opened this issue Nov 25, 2024 · 1 comment
Closed
4 tasks done
Assignees
Labels
app: samplesheets Issue in the samplesheets app breaking Breaking change, to be implemented and documented with care feature Requested feature or enhancement
Milestone

Comments

@mikkonie
Copy link
Contributor

mikkonie commented Nov 25, 2024

The format of the return data is currently inexplicably an irods_data object with the actual list contained within. This goes against SODAR Core and SODAR conventions and also would make it confusing once we implement pagination (see #1996).

This is technically a breaking change, but as we can make breaking changes before introducing new versioning in v1.0, it can be done.

Existing clients need to be updated to expect a pure list.

Tasks

  • Update return data in view
  • Update tests
  • Update docstring with full description of return data
  • Update docs (including release notes for breaking API change)
@mikkonie mikkonie added breaking Breaking change, to be implemented and documented with care feature Requested feature or enhancement app: samplesheets Issue in the samplesheets app labels Nov 25, 2024
@mikkonie mikkonie added this to the v1.0.0 milestone Nov 25, 2024
@mikkonie mikkonie self-assigned this Nov 25, 2024
@mikkonie
Copy link
Contributor Author

Done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
app: samplesheets Issue in the samplesheets app breaking Breaking change, to be implemented and documented with care feature Requested feature or enhancement
Projects
None yet
Development

No branches or pull requests

1 participant