AbsaOSS / enceladus

Dynamic Conformance Engine
Apache License 2.0
29 stars 14 forks source link

Bugfix/2132 swagger wrong params #2157

Closed dk1844 closed 1 year ago

dk1844 commented 1 year ago

This PR aims to solve issue #2132.

A few Swagger-documentation issues has been fixed, specifically:

V2 API /edit multiendpoint

Unwanted @AuthenticationPrincipal fields were present

auth-principal-fields-removed

Closes #2132

miroslavpojer commented 1 year ago

During review of API end point I have identified this end-point "/api/mappingTable/updateDefaults ==> updateDefaults" where required parameter is named "upd". I would propose rename it to "updateDefault"

Zejnilovic commented 1 year ago
  • [x] code reviewed
  • [x] pulled
  • [x] built - all tests
  • [x] check of API end points

During review of API end point I have identified this end-point "/api/mappingTable/updateDefaults ==> updateDefaults" where required parameter is named "upd". I would propose rename it to "updateDefault"

Fixing docs is fine, but I am against updating the deprecated v2 API.

sonarcloud[bot] commented 1 year ago

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

dk1844 commented 1 year ago

Fixing docs is fine, but I am against updating the deprecated v2 API.

Here, it makes no difference in compatibility, because it is the name of the "body" (in HTTP, this is not named anyway). Normally, I would agree with @Zejnilovic that changing old API is rather unwanted, here, we can afford it.

It should actually only fix the doc AFAIK.