kangbreder commented on a change in pull request #629: Swagger documentation
gsoc2019
URL: https://github.com/apache/fineract/pull/629#discussion_r317543610
##########
File path:
fineract-provider/src/main/java/org/apache/fineract/portfolio/floatingrates/api/FloatingRatesApiResource.java
##########
@@ -45,7 +45,11 @@
@Path("/floatingrates")
@Component
@Scope("singleton")
-@Api(value = "Floating Rates", description = "It lets you create, list,
retrieve and upload the floating rates")
+@Api(tags = {"Floating Rates"})
+@SwaggerDefinition(tags = {
+ @Tag(name = "Floating Rates", description = "It lets you
create, list, retrieve and upload the floating rates")
Review comment:
From swagger's API documentation, here is the way to add description
@Api(tags = {"Swagger Resource"})
@SwaggerDefinition(tags = {
@Tag(name = "Swagger Resource", description = "Write description here")
})
public class ... {
}
does that mean i will have to unindent? I have not checked if that will work
but right now, that description properly appears on the UI
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
