[
https://issues.apache.org/jira/browse/JAMES-2174?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Luc DUZAN updated JAMES-2174:
-----------------------------
Description:
Here is the current state of the documentation for GET /quota of the webadmin
API.
{code:java}
@GET
@ApiOperation(value = "Reading count and size at the same time")
@ApiResponses(value = {
@ApiResponse(code = 200, message = "OK", response = QuotaDTO.class),
@ApiResponse(code = 500, message = "Internal server error -
Something went bad on the server side.")
})
public void defineGetQuota() {
{code}
in org.apache.james.webadmin.routes.GlobalQuotaRoutes.
This current documentation is not precise enough on what the server reply if
there is no limitation for "count" and/or "size".
The documentation should specify that if there is no limitation the returned
value will be -1.
was:
Here is the current state of the documentation for ``GET /quota`` of the
webadmin API.
{code:java}
@GET
@ApiOperation(value = "Reading count and size at the same time")
@ApiResponses(value = {
@ApiResponse(code = 200, message = "OK", response = QuotaDTO.class),
@ApiResponse(code = 500, message = "Internal server error -
Something went bad on the server side.")
})
public void defineGetQuota() {
{code}
in org.apache.james.webadmin.routes.GlobalQuotaRoutes.
This current documentation is not precise enough on what the server reply if
there is no limitation for "count" and/or "size".
The documentation should specify that if there is no limitation the returned
value will be -1.
> Improve swagger documentation about defineGetQuota()
> ----------------------------------------------------
>
> Key: JAMES-2174
> URL: https://issues.apache.org/jira/browse/JAMES-2174
> Project: James Server
> Issue Type: Improvement
> Components: webadmin
> Reporter: Luc DUZAN
>
> Here is the current state of the documentation for GET /quota of the webadmin
> API.
> {code:java}
> @GET
> @ApiOperation(value = "Reading count and size at the same time")
> @ApiResponses(value = {
> @ApiResponse(code = 200, message = "OK", response =
> QuotaDTO.class),
> @ApiResponse(code = 500, message = "Internal server error -
> Something went bad on the server side.")
> })
> public void defineGetQuota() {
> {code}
> in org.apache.james.webadmin.routes.GlobalQuotaRoutes.
> This current documentation is not precise enough on what the server reply if
> there is no limitation for "count" and/or "size".
> The documentation should specify that if there is no limitation the returned
> value will be -1.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
