Skip to content
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

OpenAPI Definition Files for REST API #2795

Merged
merged 3 commits into from
Jan 9, 2020

Conversation

lorthirk
Copy link

This PR add the OpenAPI definition files to Kapua.

Related Issue
No related issues

Description of the solution adopted
With this PR Swagger definition files will no longer automatically generated at runtime by inspecting JAX-RS annotations; standard OpenAPI 3.0 definitions have been written instead, that matches the current interface of the REST API.

Any side note on the changes made
As a result, Swagger annotations have also been removed from the code base. Again, the swagger.json file will no longer be automatically generated at runtime. The internal Swagger UI now points to the new file.

@lorthirk lorthirk requested a review from Coduz December 12, 2019 15:36
@lorthirk lorthirk changed the title Feature open api files OpenAPI Definition Files for REST API Dec 12, 2019
Claudio Mezzasalma added 3 commits December 12, 2019 16:55
Signed-off-by: Claudio Mezzasalma <claudio.mezzasalma@eurotech.com>
Signed-off-by: Claudio Mezzasalma <claudio.mezzasalma@eurotech.com>
Signed-off-by: Claudio Mezzasalma <claudio.mezzasalma@eurotech.com>
@lorthirk lorthirk force-pushed the feature-openApiFiles branch from 6f4b097 to 9653ac4 Compare December 12, 2019 15:55
@codecov
Copy link

codecov bot commented Dec 12, 2019

Codecov Report

Merging #2795 into develop will decrease coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@              Coverage Diff              @@
##             develop    #2795      +/-   ##
=============================================
- Coverage      57.46%   57.44%   -0.02%     
+ Complexity      3395     3069     -326     
=============================================
  Files           1074     1074              
  Lines          30505    30505              
  Branches        2436     2436              
=============================================
- Hits           17531    17525       -6     
- Misses         11804    11809       +5     
- Partials        1170     1171       +1
Impacted Files Coverage Δ Complexity Δ
.../notification/ManagementOperationNotification.java 0% <ø> (ø) 0 <0> (ø) ⬇️
...kapua/service/authorization/access/AccessRole.java 0% <ø> (ø) 0 <0> (ø) ⬇️
...pua/service/device/registry/event/DeviceEvent.java 0% <ø> (ø) 0 <0> (ø) ⬇️
...apua/service/certificate/info/CertificateInfo.java 0% <ø> (ø) 0 <0> (ø) ⬇️
...n/java/org/eclipse/kapua/message/KapuaPayload.java 100% <ø> (ø) 0 <0> (ø) ⬇️
.../eclipse/kapua/service/device/registry/Device.java 0% <ø> (ø) 0 <0> (ø) ⬇️
...apua/service/authentication/token/AccessToken.java 0% <ø> (ø) 0 <0> (ø) ⬇️
...kapua/service/authorization/access/AccessInfo.java 0% <ø> (ø) 0 <0> (ø) ⬇️
...e/device/registry/connection/DeviceConnection.java 0% <ø> (ø) 0 <0> (ø) ⬇️
...service/authorization/access/AccessPermission.java 0% <ø> (ø) 0 <0> (ø) ⬇️
... and 7 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 344daa0...9653ac4. Read the comment docs.

@Coduz Coduz added Build and test This PR contains a new dependency that required declaration in the release B&T list Documentation Doc... What?? Joke! We will write some! REST API We hope to REST everyday labels Jan 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Build and test This PR contains a new dependency that required declaration in the release B&T list Documentation Doc... What?? Joke! We will write some! REST API We hope to REST everyday
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants