FINERACT-1105 Swagger now generates a valid spec file #1270
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
xurror
requested changes
Aug 23, 2020
There was a problem hiding this comment.
Hey @Grandolf49 , can you squash the commits into 1? Now need to have up to three commit messages for this PR.
|
Yeah sure! I'll squash. |
FINERACT-1105 Added description to response 200 FINERACT-1105 Valid Spec File generated FINERACT-1105 Valid Open API Spec File generated FINERACT-1105 Added description to response 200 FINERACT-1105 Valid Spec File generated
6 tasks
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
FINERACT-1105
It is essential that Swagger Gradle Plugin generates a valid spec file so that Swagger Codegen is able to generate a valid client library. Earlier, swagger was generating an invalid spec file due to some missing elements in the source code. This PR fixes the issue. Some APIs were missing Path Parameter. So I have added it in the appropriate methods. Still exploring if this can be avoided.
This is an example of a valid spec file generated by swagger: fineract-valid-spec.yaml
Test it using https://validator.swagger.io/
This is the earlier spec file: fineract.yaml
Checklist
Please make sure these boxes are checked before submitting your pull request - thanks!
Commit message starts with the issue number from https://issues.apache.org/jira/projects/FINERACT/. Ex: FINERACT-646 Pockets API.
Coding conventions at https://cwiki.apache.org/confluence/display/FINERACT/Coding+Conventions have been followed.
API documentation at fineract-provider/src/main/resources/static/api-docs/apiLive.htm has been updated with details of any API changes.
Integration tests have been created/updated for verifying the changes made.
All Integrations tests are passing with the new commits.
Submission is not a "code dump". (Large changes can be made "in repository" via a branch. Ask on the list.)
Our guidelines for code reviews is at https://cwiki.apache.org/confluence/display/FINERACT/Code+Review+Guide