docs-invenio-rdm icon indicating copy to clipboard operation
docs-invenio-rdm copied to clipboard
verified publisher icon inveniosoftware

Documented API update from RFC 0072

Open mesemus opened this issue 10 months ago • 1 comments

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:

  • [x] I'm aware of the code of conduct.
  • [x] I've created logical separate commits and followed the commit message format.
  • [x] I've targeted the master branch.
  • [x] 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 avatar Jan 19 '25 18:01 mesemus

Connected pull requests:

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

mesemus avatar Jan 19 '25 19:01 mesemus

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.

fenekku avatar Jun 11 '25 12:06 fenekku

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.

@fenekku I'd prefer if you could separate the concerns and move them around as I have not been following the changes to the documentation and would probably put those inconsistently with the rest of the documentation :) Thanks.

mesemus avatar Jun 23 '25 14:06 mesemus

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.

@fenekku I'd prefer if you could separate the concerns and move them around as I have not been following the changes to the documentation and would probably put those inconsistently with the rest of the documentation :) Thanks.

No problem! It's been done now, so you can rebase. The separation is not yet ideal, but keeps content close enough to where it should be. If any issue with the rebase let me know, and I can help.

fenekku avatar Jun 25 '25 18:06 fenekku

No problem! It's been done now, so you can rebase. The separation is not yet ideal, but keeps content close enough to where it should be. If any issue with the rebase let me know, and I can help.

@fenekku Rebased, please have a look if it was done correctly. Thanks.

mesemus avatar Jun 27 '25 10:06 mesemus

I have manually merged this PR, given that we are not allowed to push changes after rebasing and resolving conflicts. See https://github.com/inveniosoftware/docs-invenio-rdm/commit/2e6e6da645f1ee668a75cadf11ce01d1af374f9d

ntarocco avatar Jul 10 '25 15:07 ntarocco