-
Notifications
You must be signed in to change notification settings - Fork 8
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
Dds 1861 - new v3 version to fix endpoints - fix the files endpoints #1505
Dds 1861 - new v3 version to fix endpoints - fix the files endpoints #1505
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
SnykCode found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ 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 ☔ View full report in Codecov by Sentry. |
…-the-OpenApi-standard
…-the-OpenApi-standard
…-the-OpenApi-standard
I added better explanations abt this thing with the s3 keys operations |
Co-authored-by: Valentin Georgiev <[email protected]>
Co-authored-by: Valentin Georgiev <[email protected]>
Co-authored-by: Valentin Georgiev <[email protected]>
Co-authored-by: Valentin Georgiev <[email protected]>
Co-authored-by: Valentin Georgiev <[email protected]>
Co-authored-by: Valentin Georgiev <[email protected]>
This reverts commit 0961f1d.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
line 1285 in swagger.yaml and line 1246 in swaggerv3.yaml:
operationId: allUnits
should not be the same as for /unit/info/all
just noticed that it is the same for the get method of /motd
All operationId
should be checked (I guess they don't relate to anything in the code, just unique tags for swagger)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry that I forgot the usage explanation last time, it is good but I added some formatting and clarification suggestions.
Also, it needs to go into swaggerv3.yaml too.
I hope this is the last thing and we can get rid of it :)
Co-authored-by: Valentin Georgiev <[email protected]>
Co-authored-by: Valentin Georgiev <[email protected]>
…-the-OpenApi-standard
Read this before submitting the PR
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.
The new tests for this version 3 have been placed, under tests/tests_v3. They are duplicated of the old ones, but with the requests fixed. When the old version is finally removed, this files can be just replaced and the coverage will maintain.
The two documentation versions are now hosted in /api/documentation/v3/ or /api/documentation/v1/
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
master
branch: _If checked, read the release instructions5. 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.