Skip to content

Documented API update from RFC 0072 #737

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mesemus
Copy link

@mesemus mesemus commented Jan 19, 2025

Description

This PR contains documentation of API changes proposed in RFC 0072.

Checklist

Ticks in all boxes and 🟢 on all GitHub actions status checks are required to merge:

  • I'm aware of the code of conduct.
  • I've created logical separate commits and followed the commit message format.
  • I've targeted the master branch.
  • If this documentation change impacts the current release of InvenioRDM, I will backport it to the production branch following approval or indicate to a maintainer that it should be backported.

Reminder

By using GitHub, you have already agreed to the GitHub’s Terms of Service including that:

  1. You license your contribution under the same terms as the current repository’s license.
  2. You agree that you have the right to license your contribution under the current repository’s license.

@mesemus
Copy link
Author

mesemus commented Jan 19, 2025

Connected pull requests:

RFC 0072
Implementation in invenio-records-resources
S3 multipart implementation
invenio-rdm-records - depends on this PR

...
]
```

Copy link
Contributor

Choose a reason for hiding this comment

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

Could you add in that file size and checksum are optional parameters?

Copy link
Contributor

@tmorrell tmorrell left a comment

Choose a reason for hiding this comment

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

This needs to be included in v13. There is a bit on the permissions that should be checked before merging.

from invenio_administration.generators import Administration

class MyRepositoryPermissionPolicy(RDMRecordPermissionPolicy):
can_draft_create_files = RDMRecordPermissionPolicy.can_draft_transfer_files + [
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure these permissions have been implemented. It works out of the box for me without modifying permissions

Copy link
Author

Choose a reason for hiding this comment

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

I will have a look at it today.

@tmorrell tmorrell added this to v13.0.0 Jun 10, 2025
@tmorrell tmorrell moved this to 👀 In review in v13.0.0 Jun 10, 2025
* See inveniosoftware/rfcs#91 for details

Co-authored-by: Mirek Simek <miroslav.simek@cesnet.cz>
@mesemus mesemus force-pushed the contribution-file-storage branch from ca49043 to 8fefe9e Compare June 11, 2025 11:03
@mesemus mesemus marked this pull request as ready for review June 11, 2025 11:04
@fenekku
Copy link
Collaborator

fenekku commented Jun 11, 2025

Note that in upcoming "Reference" section refactor, File storage is going to be moved around/edited for clarity of audience and purpose. Currently it mixes REST API usage, with explanation of internals, with configuration for site administrators. You can separate those concerns out if you want, otherwise I will if that reorg lands after this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 👀 In review
Development

Successfully merging this pull request may close these issues.

3 participants