eric/mailpit
1
0
Fork 0
mirror of https://github.com/axllent/mailpit.git synced 2026-06-28 06:56:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Swagger: Update swagger field descriptions

Browse Source
This commit is contained in:
Ralph Slooten
2023-05-04 21:26:27 +12:00
parent 6dca57ba9b
commit 225a1e2e2a
2 changed files with 39 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -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": {