go/mailpit
1
0
Fork 0
mirror of https://github.com/axllent/mailpit.git synced 2025-07-15 01:25:10 +02:00
Code Issues Releases Activity

Swagger: Update swagger documentation

Browse Source 
See #188
This commit is contained in:
Ralph Slooten
2023-10-15 19:24:06 +13:00
parent eeac32d09b
commit cded4d25fc
4 changed files with 254 additions and 228 deletions
Download Patch File Download Diff File Expand all files Collapse all files

81
server/apiv1/api.go
View File

@ -144,11 +144,11 @@ func Search(w http.ResponseWriter, r *http.Request) {
// DeleteSearch will delete all messages matching a search // DeleteSearch will delete all messages matching a search
func DeleteSearch(w http.ResponseWriter, r *http.Request) { func DeleteSearch(w http.ResponseWriter, r *http.Request) {
// swagger:route DELETE /api/v1/search messages MessagesSummary // swagger:route DELETE /api/v1/search messages DeleteSearch
// //
// # Delete messages by search // # Delete messages by search
// //
// Deletes messages matching a search. // Delete all messages matching a search.
// //
// Produces: // Produces:
// - application/json // - application/json
@ -196,7 +196,7 @@ func GetMessage(w http.ResponseWriter, r *http.Request) {
// Parameters: // Parameters:
// + name: ID // + name: ID
// in: path // in: path
// description: Database ID // description: Message database ID
// required: true // required: true
// type: string // type: string
// //
@ -237,7 +237,7 @@ func DownloadAttachment(w http.ResponseWriter, r *http.Request) {
// Parameters: // Parameters:
// + name: ID // + name: ID
// in: path // in: path
// description: Database ID // description: Message database ID
// required: true // required: true
// type: string // type: string
// + name: PartID // + name: PartID
@ -362,11 +362,11 @@ func DownloadRaw(w http.ResponseWriter, r *http.Request) {
// DeleteMessages (method: DELETE) deletes all messages matching IDS. // DeleteMessages (method: DELETE) deletes all messages matching IDS.
func DeleteMessages(w http.ResponseWriter, r *http.Request) { func DeleteMessages(w http.ResponseWriter, r *http.Request) {
// swagger:route DELETE /api/v1/messages messages Delete // swagger:route DELETE /api/v1/messages messages DeleteMessages
// //
// # Delete messages // # Delete messages
// //
// If no IDs are provided then all messages are deleted. // Delete individual or all messages. If no IDs are provided then all messages are deleted.
// //
// Consumes: // Consumes:
// - application/json // - application/json
@ -376,13 +376,6 @@ func DeleteMessages(w http.ResponseWriter, r *http.Request) {
// //
// Schemes: http, https // Schemes: http, https
// //
// Parameters:
// + name: ids
// in: body
// description: Database IDs to delete
// required: false
// type: DeleteRequest
//
// Responses: // Responses:
// 200: OKResponse // 200: OKResponse
// default: ErrorResponse // default: ErrorResponse
@ -406,7 +399,7 @@ func DeleteMessages(w http.ResponseWriter, r *http.Request) {
} }
} }
w.Header().Add("Content-Type", "application/json") w.Header().Add("Content-Type", "application/plain")
_, _ = w.Write([]byte("ok")) _, _ = w.Write([]byte("ok"))
} }
@ -427,13 +420,6 @@ func SetReadStatus(w http.ResponseWriter, r *http.Request) {
// //
// Schemes: http, https // Schemes: http, https
// //
// Parameters:
// + name: ids
// in: body
// description: Database IDs to update
// required: false
// type: SetReadStatusRequest
//
// Responses: // Responses:
// 200: OKResponse // 200: OKResponse
// default: ErrorResponse // default: ErrorResponse
@ -491,7 +477,7 @@ func SetReadStatus(w http.ResponseWriter, r *http.Request) {
// GetTags (method: GET) will get all tags currently in use // GetTags (method: GET) will get all tags currently in use
func GetTags(w http.ResponseWriter, _ *http.Request) { func GetTags(w http.ResponseWriter, _ *http.Request) {
// swagger:route GET /api/v1/tags tags SetTags // swagger:route GET /api/v1/tags tags GetTags
// //
// # Get all current tags // # Get all current tags
// //
@ -524,7 +510,7 @@ func SetTags(w http.ResponseWriter, r *http.Request) {
// //
// # Set message tags // # Set message tags
// //
// To remove all tags from a message, pass an empty tags array. // This will overwrite any existing tags for selected message database IDs. To remove all tags from a message, pass an empty tags array.
// //
// Consumes: // Consumes:
// - application/json // - application/json
@ -534,13 +520,6 @@ func SetTags(w http.ResponseWriter, r *http.Request) {
// //
// Schemes: http, https // Schemes: http, https
// //
// Parameters:
// + name: ids
// in: body
// description: Database IDs to update
// required: true
// type: SetTagsRequest
//
// Responses: // Responses:
// 200: OKResponse // 200: OKResponse
// default: ErrorResponse // default: ErrorResponse
@ -576,11 +555,11 @@ func SetTags(w http.ResponseWriter, r *http.Request) {
// ReleaseMessage (method: POST) will release a message via a pre-configured external SMTP server. // ReleaseMessage (method: POST) will release a message via a pre-configured external SMTP server.
// If no IDs are provided then all messages are updated. // If no IDs are provided then all messages are updated.
func ReleaseMessage(w http.ResponseWriter, r *http.Request) { func ReleaseMessage(w http.ResponseWriter, r *http.Request) {
// swagger:route POST /api/v1/message/{ID}/release message Release // swagger:route POST /api/v1/message/{ID}/release message ReleaseMessage
// //
// # Release message // # Release message
// //
// Release a message via a pre-configured external SMTP server.. // Release a message via a pre-configured external SMTP server. This is only enabled if message relaying has been configured.
// //
// Consumes: // Consumes:
// - application/json // - application/json
@ -590,18 +569,6 @@ func ReleaseMessage(w http.ResponseWriter, r *http.Request) {
// //
// Schemes: http, https // Schemes: http, https
// //
// Parameters:
// + name: ID
// in: path
// description: Database ID
// required: true
// type: string
// + name: to
// in: body
// description: Array of email addresses to release message to
// required: true
// type: ReleaseMessageRequest
//
// Responses: // Responses:
// 200: OKResponse // 200: OKResponse
// default: ErrorResponse // default: ErrorResponse
@ -618,7 +585,7 @@ func ReleaseMessage(w http.ResponseWriter, r *http.Request) {
decoder := json.NewDecoder(r.Body) decoder := json.NewDecoder(r.Body)
data := releaseMessageRequest{} data := releaseMessageRequestBody{}
if err := decoder.Decode(&data); err != nil { if err := decoder.Decode(&data); err != nil {
httpError(w, err.Error()) httpError(w, err.Error())
@ -702,7 +669,7 @@ func ReleaseMessage(w http.ResponseWriter, r *http.Request) {
// HTMLCheck returns a summary of the HTML client support // HTMLCheck returns a summary of the HTML client support
func HTMLCheck(w http.ResponseWriter, r *http.Request) { func HTMLCheck(w http.ResponseWriter, r *http.Request) {
// swagger:route GET /api/v1/message/{ID}/html-check Other HTMLCheckResponse // swagger:route GET /api/v1/message/{ID}/html-check Other HTMLCheck
// //
// # HTML check (beta) // # HTML check (beta)
// //
@ -716,13 +683,6 @@ func HTMLCheck(w http.ResponseWriter, r *http.Request) {
// //
// Schemes: http, https // Schemes: http, https
// //
// Parameters:
// + name: ID
// in: path
// description: Database ID
// required: true
// type: string
//
// Responses: // Responses:
// 200: HTMLCheckResponse // 200: HTMLCheckResponse
// default: ErrorResponse // default: ErrorResponse
@ -754,7 +714,7 @@ func HTMLCheck(w http.ResponseWriter, r *http.Request) {
// LinkCheck returns a summary of links in the email // LinkCheck returns a summary of links in the email
func LinkCheck(w http.ResponseWriter, r *http.Request) { func LinkCheck(w http.ResponseWriter, r *http.Request) {
// swagger:route GET /api/v1/message/{ID}/link-check Other LinkCheckResponse // swagger:route GET /api/v1/message/{ID}/link-check Other LinkCheck
// //
// # Link check (beta) // # Link check (beta)
// //
@ -768,19 +728,6 @@ func LinkCheck(w http.ResponseWriter, r *http.Request) {
// //
// Schemes: http, https // Schemes: http, https
// //
// Parameters:
// + name: ID
// in: path
// description: Database ID
// required: true
// type: string
// + name: follow
// in: query
// description: Follow redirects
// required: false
// type: boolean
// default: false
//
// Responses: // Responses:
// 200: LinkCheckResponse // 200: LinkCheckResponse
// default: ErrorResponse // default: ErrorResponse

5
server/apiv1/structs.go
View File

@ -22,9 +22,6 @@ type MessagesSummary struct {
// Total number of messages matching current query // Total number of messages matching current query
MessagesCount int `json:"messages_count"` MessagesCount int `json:"messages_count"`
// // Number of results returned on current page
// Count int `json:"count"`
// Pagination offset // Pagination offset
Start int `json:"start"` Start int `json:"start"`
@ -32,7 +29,7 @@ type MessagesSummary struct {
Tags []string `json:"tags"` Tags []string `json:"tags"`
// Messages summary // Messages summary
// in:body // in: body
Messages []storage.MessageSummary `json:"messages"` Messages []storage.MessageSummary `json:"messages"`
} }

138
server/apiv1/swagger.go
View File

@ -6,6 +6,8 @@ package apiv1
// swagger:response InfoResponse // swagger:response InfoResponse
type infoResponse struct { type infoResponse struct {
// Application information // Application information
//
// in: body
Body appInformation Body appInformation
} }
@ -13,6 +15,8 @@ type infoResponse struct {
// swagger:response WebUIConfigurationResponse // swagger:response WebUIConfigurationResponse
type webUIConfigurationResponse struct { type webUIConfigurationResponse struct {
// Web UI configuration settings // Web UI configuration settings
//
// in: body
Body webUIConfiguration Body webUIConfiguration
} }
@ -28,81 +32,137 @@ type messagesSummaryResponse struct {
// swagger:model MessageHeaders // swagger:model MessageHeaders
type messageHeaders map[string][]string type messageHeaders map[string][]string
// swagger:parameters DeleteMessages
type deleteMessagesParams struct {
// in: body
Body *deleteMessagesRequestBody
}
// Delete request // Delete request
// swagger:model DeleteRequest // swagger:model DeleteRequest
type deleteRequest struct { type deleteMessagesRequestBody struct {
// ids // Array of message database IDs
// in:body //
// required: false
// example: ["5dec4247-812e-4b77-9101-e25ad406e9ea", "8ac66bbc-2d9a-4c41-ad99-00aa75fa674e"]
IDs []string `json:"ids"` IDs []string `json:"ids"`
} }
// swagger:parameters SetReadStatus
type setReadStatusParams struct {
// in: body
Body *setReadStatusRequestBody
}
// Set read status request // Set read status request
// swagger:model SetReadStatusRequest // swagger:model setReadStatusRequestBody
type setReadStatusRequest struct { type setReadStatusRequestBody struct {
// Read status // Read status
//
// required: false
// default: false
// example: true
Read bool `json:"read"` Read bool `json:"read"`
// ids // Array of message database IDs
// in:body //
// required: false
// example: ["5dec4247-812e-4b77-9101-e25ad406e9ea", "8ac66bbc-2d9a-4c41-ad99-00aa75fa674e"]
IDs []string `json:"ids"` IDs []string `json:"ids"`
} }
// swagger:parameters SetTags
type setTagsParams struct {
// in: body
Body *setTagsRequestBody
}
// Set tags request // Set tags request
// swagger:model SetTagsRequest // swagger:model setTagsRequestBody
type setTagsRequest struct { type setTagsRequestBody struct {
// Tags // Array of tag names to set
// in:body //
// required: true
// example: ["Tag 1", "Tag 2"]
Tags []string `json:"tags"` Tags []string `json:"tags"`
// IDs // Array of message database IDs
// in:body //
// required: true
// example: ["5dec4247-812e-4b77-9101-e25ad406e9ea", "8ac66bbc-2d9a-4c41-ad99-00aa75fa674e"]
IDs []string `json:"ids"` IDs []string `json:"ids"`
} }
// swagger:parameters ReleaseMessage
type releaseMessageParams struct {
// Message database ID
//
// in: path
// description: Message database ID
// required: true
ID string
// in: body
Body *releaseMessageRequestBody
}
// Release request // Release request
// swagger:model ReleaseMessageRequest // swagger:model releaseMessageRequestBody
type releaseMessageRequest struct { type releaseMessageRequestBody struct {
// To // Array of email addresses to relay the message to
// in:body //
// required: true
// example: ["user1@example.com", "user2@example.com"]
To []string `json:"to"` To []string `json:"to"`
} }
// swagger:parameters HTMLCheck
type htmlCheckParams struct {
// Message database ID
//
// in: path
// description: Message database ID
// required: true
ID string
}
// swagger:parameters LinkCheck
type linkCheckParams struct {
// Message database ID
//
// in: path
// description: Message database ID
// required: true
ID string
// Follow redirects
//
// in: query
// description: Follow redirects
// required: false
// default: false
Follow string `json:"follow"`
}
// Binary data response inherits the attachment's content type // Binary data response inherits the attachment's content type
// swagger:response BinaryResponse // swagger:response BinaryResponse
type binaryResponse struct { type binaryResponse string
// in: body
Body string
}
// Plain text response // Plain text response
// swagger:response TextResponse // swagger:response TextResponse
type textResponse struct { type textResponse string
// in: body
Body string
}
// HTML response // HTML response
// swagger:response HTMLResponse // swagger:response HTMLResponse
type htmlResponse struct { type htmlResponse string
// in: body
Body string
}
// Error response // Error response
// swagger:response ErrorResponse // swagger:response ErrorResponse
type errorResponse struct { type errorResponse string
// The error message
// in: body
Body string
}
// Plain text "ok" response // Plain text "ok" response
// swagger:response OKResponse // swagger:response OKResponse
type okResponse struct { type okResponse string
// Default response
// in: body
Body string
}
// Plain JSON array response // Plain JSON array response
// swagger:response ArrayResponse // swagger:response ArrayResponse

258
server/ui/api/v1/swagger.json
View File

@ -66,7 +66,7 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "Database ID", "description": "Message database ID",
"name": "ID", "name": "ID",
"in": "path", "in": "path",
"required": true "required": true
@ -136,11 +136,11 @@
"Other" "Other"
], ],
"summary": "HTML check (beta)", "summary": "HTML check (beta)",
"operationId": "HTMLCheckResponse", "operationId": "HTMLCheck",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "Database ID", "description": "Message database ID",
"name": "ID", "name": "ID",
"in": "path", "in": "path",
"required": true "required": true
@ -173,18 +173,19 @@
"Other" "Other"
], ],
"summary": "Link check (beta)", "summary": "Link check (beta)",
"operationId": "LinkCheckResponse", "operationId": "LinkCheck",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "Database ID", "description": "Message database ID",
"name": "ID", "name": "ID",
"in": "path", "in": "path",
"required": true "required": true
}, },
{ {
"type": "boolean", "type": "string",
"default": false, "default": "false",
"x-go-name": "Follow",
"description": "Follow redirects", "description": "Follow redirects",
"name": "follow", "name": "follow",
"in": "query" "in": "query"
@ -223,7 +224,7 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "Database ID", "description": "Message database ID",
"name": "ID", "name": "ID",
"in": "path", "in": "path",
"required": true "required": true
@ -323,7 +324,7 @@
}, },
"/api/v1/message/{ID}/release": { "/api/v1/message/{ID}/release": {
"post": { "post": {
"description": "Release a message via a pre-configured external SMTP server..", "description": "Release a message via a pre-configured external SMTP server. This is only enabled if message relaying has been configured.",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@ -338,24 +339,20 @@
"message" "message"
], ],
"summary": "Release message", "summary": "Release message",
"operationId": "Release", "operationId": "ReleaseMessage",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "Database ID", "description": "Message database ID",
"name": "ID", "name": "ID",
"in": "path", "in": "path",
"required": true "required": true
}, },
{ {
"description": "Array of email addresses to release message to", "name": "Body",
"name": "to",
"in": "body", "in": "body",
"required": true,
"schema": { "schema": {
"description": "Array of email addresses to release message to", "$ref": "#/definitions/releaseMessageRequestBody"
"type": "object",
"$ref": "#/definitions/ReleaseMessageRequest"
} }
} }
], ],
@ -428,13 +425,10 @@
"operationId": "SetReadStatus", "operationId": "SetReadStatus",
"parameters": [ "parameters": [
{ {
"description": "Database IDs to update", "name": "Body",
"name": "ids",
"in": "body", "in": "body",
"schema": { "schema": {
"description": "Database IDs to update", "$ref": "#/definitions/setReadStatusRequestBody"
"type": "object",
"$ref": "#/definitions/SetReadStatusRequest"
} }
} }
], ],
@ -448,7 +442,7 @@
} }
}, },
"delete": { "delete": {
"description": "If no IDs are provided then all messages are deleted.", "description": "Delete individual or all messages. If no IDs are provided then all messages are deleted.",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@ -463,15 +457,12 @@
"messages" "messages"
], ],
"summary": "Delete messages", "summary": "Delete messages",
"operationId": "Delete", "operationId": "DeleteMessages",
"parameters": [ "parameters": [
{ {
"description": "Database IDs to delete", "name": "Body",
"name": "ids",
"in": "body", "in": "body",
"schema": { "schema": {
"description": "Database IDs to delete",
"type": "object",
"$ref": "#/definitions/DeleteRequest" "$ref": "#/definitions/DeleteRequest"
} }
} }
@ -534,7 +525,7 @@
} }
}, },
"delete": { "delete": {
"description": "Deletes messages matching a search.", "description": "Delete all messages matching a search.",
"produces": [ "produces": [
"application/json" "application/json"
], ],
@ -546,7 +537,7 @@
"messages" "messages"
], ],
"summary": "Delete messages by search", "summary": "Delete messages by search",
"operationId": "MessagesSummary", "operationId": "DeleteSearch",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@ -580,7 +571,7 @@
"tags" "tags"
], ],
"summary": "Get all current tags", "summary": "Get all current tags",
"operationId": "SetTags", "operationId": "GetTags",
"responses": { "responses": {
"200": { "200": {
"$ref": "#/responses/ArrayResponse" "$ref": "#/responses/ArrayResponse"
@ -591,7 +582,7 @@
} }
}, },
"put": { "put": {
"description": "To remove all tags from a message, pass an empty tags array.", "description": "This will overwrite any existing tags for selected message database IDs. To remove all tags from a message, pass an empty tags array.",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@ -609,14 +600,10 @@
"operationId": "SetTags", "operationId": "SetTags",
"parameters": [ "parameters": [
{ {
"description": "Database IDs to update", "name": "Body",
"name": "ids",
"in": "body", "in": "body",
"required": true,
"schema": { "schema": {
"description": "Database IDs to update", "$ref": "#/definitions/setTagsRequestBody"
"type": "object",
"$ref": "#/definitions/SetTagsRequest"
} }
} }
], ],
@ -807,15 +794,19 @@
"type": "object", "type": "object",
"properties": { "properties": {
"ids": { "ids": {
"description": "ids\nin:body", "description": "Array of message database IDs",
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
}, },
"x-go-name": "IDs" "x-go-name": "IDs",
"example": [
"5dec4247-812e-4b77-9101-e25ad406e9ea",
"8ac66bbc-2d9a-4c41-ad99-00aa75fa674e"
]
} }
}, },
"x-go-name": "deleteRequest", "x-go-name": "deleteMessagesRequestBody",
"x-go-package": "github.com/axllent/mailpit/server/apiv1" "x-go-package": "github.com/axllent/mailpit/server/apiv1"
}, },
"HTMLCheckResponse": { "HTMLCheckResponse": {
@ -1188,6 +1179,10 @@
"type": "integer", "type": "integer",
"format": "int64" "format": "int64"
}, },
"Snippet": {
"description": "Message snippet includes up to 250 characters",
"type": "string"
},
"Subject": { "Subject": {
"description": "Email subject", "description": "Email subject",
"type": "string" "type": "string"
@ -1214,7 +1209,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"messages": { "messages": {
"description": "Messages summary\nin:body", "description": "Messages summary\nin: body",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/MessageSummary" "$ref": "#/definitions/MessageSummary"
@ -1256,67 +1251,6 @@
}, },
"x-go-package": "github.com/axllent/mailpit/server/apiv1" "x-go-package": "github.com/axllent/mailpit/server/apiv1"
}, },
"ReleaseMessageRequest": {
"description": "Release request",
"type": "object",
"properties": {
"to": {
"description": "To\nin:body",
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "To"
}
},
"x-go-name": "releaseMessageRequest",
"x-go-package": "github.com/axllent/mailpit/server/apiv1"
},
"SetReadStatusRequest": {
"description": "Set read status request",
"type": "object",
"properties": {
"ids": {
"description": "ids\nin:body",
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "IDs"
},
"read": {
"description": "Read status",
"type": "boolean",
"x-go-name": "Read"
}
},
"x-go-name": "setReadStatusRequest",
"x-go-package": "github.com/axllent/mailpit/server/apiv1"
},
"SetTagsRequest": {
"description": "Set tags request",
"type": "object",
"properties": {
"ids": {
"description": "IDs\nin:body",
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "IDs"
},
"tags": {
"description": "Tags\nin:body",
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "Tags"
}
},
"x-go-name": "setTagsRequest",
"x-go-package": "github.com/axllent/mailpit/server/apiv1"
},
"WebUIConfiguration": { "WebUIConfiguration": {
"description": "Response includes global web UI settings", "description": "Response includes global web UI settings",
"type": "object", "type": "object",
@ -1350,6 +1284,89 @@
}, },
"x-go-name": "webUIConfiguration", "x-go-name": "webUIConfiguration",
"x-go-package": "github.com/axllent/mailpit/server/apiv1" "x-go-package": "github.com/axllent/mailpit/server/apiv1"
},
"releaseMessageRequestBody": {
"description": "Release request",
"type": "object",
"required": [
"to"
],
"properties": {
"to": {
"description": "Array of email addresses to relay the message to",
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "To",
"example": [
"user1@example.com",
"user2@example.com"
]
}
},
"x-go-package": "github.com/axllent/mailpit/server/apiv1"
},
"setReadStatusRequestBody": {
"description": "Set read status request",
"type": "object",
"properties": {
"ids": {
"description": "Array of message database IDs",
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "IDs",
"example": [
"5dec4247-812e-4b77-9101-e25ad406e9ea",
"8ac66bbc-2d9a-4c41-ad99-00aa75fa674e"
]
},
"read": {
"description": "Read status",
"type": "boolean",
"default": false,
"x-go-name": "Read",
"example": true
}
},
"x-go-package": "github.com/axllent/mailpit/server/apiv1"
},
"setTagsRequestBody": {
"description": "Set tags request",
"type": "object",
"required": [
"tags",
"ids"
],
"properties": {
"ids": {
"description": "Array of message database IDs",
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "IDs",
"example": [
"5dec4247-812e-4b77-9101-e25ad406e9ea",
"8ac66bbc-2d9a-4c41-ad99-00aa75fa674e"
]
},
"tags": {
"description": "Array of tag names to set",
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "Tags",
"example": [
"Tag 1",
"Tag 2"
]
}
},
"x-go-package": "github.com/axllent/mailpit/server/apiv1"
} }
}, },
"responses": { "responses": {
@ -1363,23 +1380,27 @@
} }
}, },
"BinaryResponse": { "BinaryResponse": {
"description": "Binary data response inherits the attachment's content type" "description": "Binary data response inherits the attachment's content type",
"schema": {
"type": "string"
}
}, },
"ErrorResponse": { "ErrorResponse": {
"description": "Error response" "description": "Error response",
"schema": {
"type": "string"
}
}, },
"HTMLResponse": { "HTMLResponse": {
"description": "HTML response" "description": "HTML response",
"schema": {
"type": "string"
}
}, },
"InfoResponse": { "InfoResponse": {
"description": "Application information", "description": "Application information",
"schema": { "schema": {
"$ref": "#/definitions/AppInformation" "$ref": "#/definitions/AppInformation"
},
"headers": {
"Body": {
"description": "Application information"
}
} }
}, },
"MessagesSummaryResponse": { "MessagesSummaryResponse": {
@ -1389,20 +1410,21 @@
} }
}, },
"OKResponse": { "OKResponse": {
"description": "Plain text \"ok\" response" "description": "Plain text \"ok\" response",
"schema": {
"type": "string"
}
}, },
"TextResponse": { "TextResponse": {
"description": "Plain text response" "description": "Plain text response",
"schema": {
"type": "string"
}
}, },
"WebUIConfigurationResponse": { "WebUIConfigurationResponse": {
"description": "Web UI configuration", "description": "Web UI configuration",
"schema": { "schema": {
"$ref": "#/definitions/WebUIConfiguration" "$ref": "#/definitions/WebUIConfiguration"
},
"headers": {
"Body": {
"description": "Web UI configuration settings"
}
} }
} }
} }