diff --git a/server/apiv1/api.go b/server/apiv1/api.go index 7a4212d..260d6db 100644 --- a/server/apiv1/api.go +++ b/server/apiv1/api.go @@ -34,13 +34,13 @@ func GetMessages(w http.ResponseWriter, r *http.Request) { // Parameters: // + name: start // in: query - // description: pagination offset + // description: Pagination offset // required: false // type: integer // default: 0 // + name: limit // in: query - // description: limit results + // description: Limit results // required: false // type: integer // default: 50 @@ -88,12 +88,12 @@ func Search(w http.ResponseWriter, r *http.Request) { // Parameters: // + name: query // in: query - // description: search query + // description: Search query // required: true // type: string // + name: limit // in: query - // description: limit results + // description: Limit results // required: false // type: integer // default: 50 @@ -147,7 +147,7 @@ func GetMessage(w http.ResponseWriter, r *http.Request) { // Parameters: // + name: ID // in: path - // description: message id + // description: Message ID // required: true // type: string // @@ -188,12 +188,12 @@ func DownloadAttachment(w http.ResponseWriter, r *http.Request) { // Parameters: // + name: ID // in: path - // description: message id + // description: Message ID // required: true // type: string // + name: PartID // in: path - // description: attachment part id + // description: Attachment part ID // required: true // type: string // @@ -237,7 +237,7 @@ func GetHeaders(w http.ResponseWriter, r *http.Request) { // Parameters: // + name: ID // in: path - // description: message id + // description: Message ID // required: true // type: string // @@ -284,7 +284,7 @@ func DownloadRaw(w http.ResponseWriter, r *http.Request) { // Parameters: // + name: ID // in: path - // description: message id + // description: Message ID // required: true // type: string // @@ -330,7 +330,7 @@ func DeleteMessages(w http.ResponseWriter, r *http.Request) { // Parameters: // + name: ids // in: body - // description: Message ids to delete + // description: Message IDs to delete // required: false // type: DeleteRequest // @@ -381,7 +381,7 @@ func SetReadStatus(w http.ResponseWriter, r *http.Request) { // Parameters: // + name: ids // in: body - // description: Message ids to update + // description: Message IDs to update // required: false // type: SetReadStatusRequest // @@ -459,7 +459,7 @@ func SetTags(w http.ResponseWriter, r *http.Request) { // Parameters: // + name: ids // in: body - // description: Message ids to update + // description: Message IDs to update // required: true // type: SetTagsRequest // @@ -515,10 +515,10 @@ func ReleaseMessage(w http.ResponseWriter, r *http.Request) { // Parameters: // + name: ID // in: path - // description: message id + // description: Message ID // required: true // type: string - // + name: To + // + name: to // in: body // description: Array of email addresses to release message to // required: true diff --git a/server/ui/api/v1/swagger.json b/server/ui/api/v1/swagger.json index 29b159a..e38cfbe 100644 --- a/server/ui/api/v1/swagger.json +++ b/server/ui/api/v1/swagger.json @@ -66,7 +66,7 @@ "parameters": [ { "type": "string", - "description": "message id", + "description": "Message ID", "name": "ID", "in": "path", "required": true @@ -103,7 +103,7 @@ "parameters": [ { "type": "string", - "description": "message id", + "description": "Message ID", "name": "ID", "in": "path", "required": true @@ -142,14 +142,14 @@ "parameters": [ { "type": "string", - "description": "message id", + "description": "Message ID", "name": "ID", "in": "path", "required": true }, { "type": "string", - "description": "attachment part id", + "description": "Attachment part ID", "name": "PartID", "in": "path", "required": true @@ -224,7 +224,7 @@ "parameters": [ { "type": "string", - "description": "message id", + "description": "Message ID", "name": "ID", "in": "path", "required": true @@ -261,14 +261,14 @@ "parameters": [ { "type": "string", - "description": "message id", + "description": "Message ID", "name": "ID", "in": "path", "required": true }, { "description": "Array of email addresses to release message to", - "name": "To", + "name": "to", "in": "body", "required": true, "schema": { @@ -307,14 +307,14 @@ { "type": "integer", "default": 0, - "description": "pagination offset", + "description": "Pagination offset", "name": "start", "in": "query" }, { "type": "integer", "default": 50, - "description": "limit results", + "description": "Limit results", "name": "limit", "in": "query" } @@ -347,11 +347,11 @@ "operationId": "SetReadStatus", "parameters": [ { - "description": "Message ids to update", + "description": "Message IDs to update", "name": "ids", "in": "body", "schema": { - "description": "Message ids to update", + "description": "Message IDs to update", "type": "object", "$ref": "#/definitions/SetReadStatusRequest" } @@ -385,11 +385,11 @@ "operationId": "Delete", "parameters": [ { - "description": "Message ids to delete", + "description": "Message IDs to delete", "name": "ids", "in": "body", "schema": { - "description": "Message ids to delete", + "description": "Message IDs to delete", "type": "object", "$ref": "#/definitions/DeleteRequest" } @@ -423,7 +423,7 @@ "parameters": [ { "type": "string", - "description": "search query", + "description": "Search query", "name": "query", "in": "query", "required": true @@ -431,7 +431,7 @@ { "type": "integer", "default": 50, - "description": "limit results", + "description": "Limit results", "name": "limit", "in": "query" } @@ -466,12 +466,12 @@ "operationId": "SetTags", "parameters": [ { - "description": "Message ids to update", + "description": "Message IDs to update", "name": "ids", "in": "body", "required": true, "schema": { - "description": "Message ids to update", + "description": "Message IDs to update", "type": "object", "$ref": "#/definitions/SetTagsRequest" } @@ -568,23 +568,23 @@ "type": "object", "properties": { "ContentID": { - "description": "content id", + "description": "Content ID", "type": "string" }, "ContentType": { - "description": "content type", + "description": "Content type", "type": "string" }, "FileName": { - "description": "file name", + "description": "File name", "type": "string" }, "PartID": { - "description": "attachment part id", + "description": "Attachment part ID", "type": "string" }, "Size": { - "description": "size in bytes", + "description": "Size in bytes", "type": "integer", "format": "int64" } @@ -645,7 +645,7 @@ "type": "string" }, "ID": { - "description": "Unique message database id", + "description": "Database ID", "type": "string" }, "Inline": { @@ -667,7 +667,7 @@ } }, "ReturnPath": { - "description": "ReturnPath is the Return-Path", + "description": "Return-Path", "type": "string" }, "Size": { @@ -744,7 +744,7 @@ "$ref": "#/definitions/Address" }, "ID": { - "description": "Unique message database id", + "description": "Database ID", "type": "string" }, "Read": {