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] [Updated] (JAMES-2174) Improve swagger documentation about defineGetQuota()
Date Fri, 06 Oct 2017 14:13:00 GMT

     [ 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 {noformat}GET /quota{noformat} 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 {noformat}GET /quota{noformat} 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: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org


Mime
View raw message