go/mailpit
1
0
Fork 0
mirror of https://github.com/axllent/mailpit.git synced 2025-04-21 12:17:05 +02:00
Code Issues Releases Activity

Swagger: Update swagger docs

Browse Source
This commit is contained in:
Ralph Slooten 2023-07-12 17:22:48 +12:00
parent ac0e7163dd
commit 56982798dc
2 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
server/apiv1/webui.go
View File

@ -32,6 +32,7 @@ func WebUIConfig(w http.ResponseWriter, r *http.Request) {
// # Get web UI configuration // # Get web UI configuration
// //
// Returns configuration settings for the web UI. // Returns configuration settings for the web UI.
// Intended for web UI only!
// //
// Produces: // Produces:
// - application/json // - application/json

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

@ -489,7 +489,7 @@
}, },
"/api/v1/webui": { "/api/v1/webui": {
"get": { "get": {
"description": "Returns configuration settings for the web UI.", "description": "Returns configuration settings for the web UI.\nIntended for web UI only!",
"produces": [ "produces": [
"application/json" "application/json"
], ],
@ -789,12 +789,6 @@
"description": "MessagesSummary is a summary of a list of messages", "description": "MessagesSummary is a summary of a list of messages",
"type": "object", "type": "object",
"properties": { "properties": {
"count": {
"description": "Number of results returned",
"type": "integer",
"format": "int64",
"x-go-name": "Count"
},
"messages": { "messages": {
"description": "Messages summary\nin:body", "description": "Messages summary\nin:body",
"type": "array", "type": "array",
@ -803,6 +797,12 @@
}, },
"x-go-name": "Messages" "x-go-name": "Messages"
}, },
"messages_count": {
"description": "Total number of messages matching current query",
"type": "integer",
"format": "int64",
"x-go-name": "MessagesCount"
},
"start": { "start": {
"description": "Pagination offset", "description": "Pagination offset",
"type": "integer", "type": "integer",
@ -926,10 +926,10 @@
}, },
"responses": { "responses": {
"BinaryResponse": { "BinaryResponse": {
"description": "Binary data reponse inherits the attachment's content type" "description": "Binary data response inherits the attachment's content type"
}, },
"ErrorResponse": { "ErrorResponse": {
"description": "Error reponse" "description": "Error response"
}, },
"InfoResponse": { "InfoResponse": {
"description": "Application information", "description": "Application information",
@ -949,7 +949,7 @@
} }
}, },
"OKResponse": { "OKResponse": {
"description": "Plain text \"ok\" reponse" "description": "Plain text \"ok\" response"
}, },
"TextResponse": { "TextResponse": {
"description": "Plain text response" "description": "Plain text response"