james-server-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Luc DUZAN (JIRA)" <server-...@james.apache.org>
Subject [jira] [Created] (JAMES-2174) Improve swagger documentation about defineGetQuota()
Date Fri, 06 Oct 2017 14:12:00 GMT
Luc DUZAN created JAMES-2174:

             Summary: 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.

    @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() {
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

This message was sent by Atlassian JIRA

To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org

View raw message