ScilifelabDataCentre / dds_web

A cloud-based system for the delivery of data from SciLifeLab Facilities to their users (e.g. research group).
Other
7 stars 7 forks source link

Dds 1861 - new v3 version to fix endpoints - fix the files endpoints #1505

Closed rv0lt closed 5 months ago

rv0lt commented 7 months ago

Read this before submitting the PR

  1. Always create a Draft PR first
  2. Go through sections 1-5 below, fill them in and check all the boxes
  3. Make sure that the branch is updated; if there's an "Update branch" button at the bottom of the PR, rebase or update branch.
  4. When all boxes are checked, information is filled in, and the branch is updated: mark as Ready For Review and tag reviewers (top right)
  5. Once there is a submitted review, implement the suggestions (if reasonable, otherwise discuss) and request an new review.

If there is a field which you are unsure about, enter the edit mode of this description or go to the PR template; There are invisible comments providing descriptions which may be of help.

1. Description / Summary

Some endpoints were not developed according to the OpenAPI standard, this means that we were not possible to document them properly, furthermore according to new regulations for public organisms, we actually need to have them according to OpenAPI. This PR is the first on a series of them to fix several endpoints. Therefore:

url/api/v1 → Will keep working as always

url/api/v3 → Contains the new version of the endpoints. Keeps all the previous one as well as fixed version for the endpoints related to files.

Subsequent PR will focus on fix the other types of endpoints.


A new file swaggerv3.yaml serves as the documentation for the new version.

New descriptions to clarify future users have also been provided.

2. Jira task / GitHub issue

Link to the github issue or add the Jira task ID here.

3. Type of change

What type of change(s) does the PR contain?

Check the relevant boxes below. For an explanation of the different sections, enter edit mode of this PR description template.

4. Additional information

5. Actions / Scans

Check the boxes when the specified checks have passed.

For information on what the different checks do and how to fix it if they're failing, enter edit mode of this description or go to the PR template.

codecov[bot] commented 7 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 91.67%. Comparing base (1c55639) to head (afbb089). Report is 1 commits behind head on dev.

:exclamation: Current head afbb089 differs from pull request most recent head db50f17. Consider uploading reports for the commit db50f17 to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## dev #1505 +/- ## ========================================== + Coverage 91.48% 91.67% +0.19% ========================================== Files 29 29 Lines 4637 4747 +110 ========================================== + Hits 4242 4352 +110 Misses 395 395 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

rv0lt commented 7 months ago

Description should explain the changes. Any questions that are not clear, I can elaborate further.

Comment: New tasks should be planned to write in a document the changes necessaries to fully adopt the new v3. Such as, modify the version file and adapt the verify_cli_version. Probably is better to wait for Ina to come back before doing the full transition. For now, the two versions can live with the v3 as an experimental one.

rv0lt commented 6 months ago

I added better explanations abt this thing with the s3 keys operations