Files
swagger2markup/example-spring-boot-mvc/src/docs/asciidoc/example.adoc
2015-02-13 13:30:24 +01:00

154 lines
2.1 KiB
Plaintext

= My Apps API Title
My Apps API Description
Version: 1.0
== Create a quota.
----
PUT /quotas
----
=== Description
:hardbreaks:
Create a quota allows bla bla bla bla
=== Parameters
[format="csv", options="header"]
|===
Name,Located in,Description,Required
body,body,MailStorageQuota,true
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
200,success
201,Created
401,Unauthorized
204,null
403,Forbidden
404,Not Found
|===
=== Consumes
* application/json
=== Produces
* */*
== Get a quotas.
----
GET /quotas/quotas/{quotaId}
----
=== Description
:hardbreaks:
Get a quota allows bla bla bla bla
=== Parameters
[format="csv", options="header"]
|===
Name,Located in,Description,Required
quotaId,path,quotaId,true
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
200,success
401,Unauthorized
403,Forbidden
404,Not Found
|===
=== Consumes
* application/json
=== Produces
* */*
== Delete a quota.
----
DELETE /quotas/quotas/{quotaId}
----
=== Description
:hardbreaks:
Delete a quotas allows bla bla bla bla
=== Parameters
[format="csv", options="header"]
|===
Name,Located in,Description,Required
quotaId,path,quotaId,true
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
200,success
401,Unauthorized
204,No Content
403,Forbidden
|===
=== Consumes
* application/json
=== Produces
* */*
== Update a quota.
----
POST /quotas/quotas/{quotaId}
----
=== Description
:hardbreaks:
Update a quota allows bla bla bla bla
=== Parameters
[format="csv", options="header"]
|===
Name,Located in,Description,Required
quotaId,path,quotaId,true
body,body,MailStorageQuota,true
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
200,success
201,Created
401,Unauthorized
204,null
403,Forbidden
404,Not Found
|===
=== Consumes
* application/json
=== Produces
* */*
== Definitions
=== MailStorageQuota
[format="csv", options="header"]
|===
Name,Type,Required
mailStorageQuotaValue,string,false
quotaValueType,string,false
|===
=== MailStorageQuotaResponse
[format="csv", options="header"]
|===
Name,Type,Required
mailStorageQuota,ref,false
|===