go/mailpit
1
0
Fork 0
mirror of https://github.com/axllent/mailpit.git synced 2025-05-23 22:40:15 +02:00
Code Issues Releases Activity

Remove swagger parameter examples (invalid format)

Browse Source
This commit is contained in:
Ralph Slooten 2024-11-09 16:51:23 +13:00
parent 657cada916
commit a7fac05209
8 changed files with 0 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
server/apiv1/message.go
View File

@ -17,7 +17,6 @@ type getMessageParams struct {
// //
// in: path // in: path
// required: true // required: true
// example: 4oRBnPtCXgAqZniRhzLNmS
ID string ID string
} }
@ -73,7 +72,6 @@ type getHeadersParams struct {
// //
// in: path // in: path
// required: true // required: true
// example: 4oRBnPtCXgAqZniRhzLNmS
ID string ID string
} }
@ -140,14 +138,12 @@ type attachmentParams struct {
// //
// in: path // in: path
// required: true // required: true
// example: 4oRBnPtCXgAqZniRhzLNmS
ID string ID string
// Attachment part ID // Attachment part ID
// //
// in: path // in: path
// required: true // required: true
// example: 2
PartID string PartID string
} }
@ -199,7 +195,6 @@ type downloadRawParams struct {
// //
// in: path // in: path
// required: true // required: true
// example: 4oRBnPtCXgAqZniRhzLNmS
ID string ID string
} }

6
server/apiv1/messages.go
View File

@ -17,7 +17,6 @@ type getMessagesParams struct {
// required: false // required: false
// default: 0 // default: 0
// type: integer // type: integer
// example: 100
Start int `json:"start"` Start int `json:"start"`
// Limit number of results // Limit number of results
@ -27,7 +26,6 @@ type getMessagesParams struct {
// required: false // required: false
// default: 50 // default: 50
// type: integer // type: integer
// example: 50
Limit int `json:"limit"` Limit int `json:"limit"`
} }
@ -261,7 +259,6 @@ type searchParams struct {
// in: query // in: query
// required: true // required: true
// type: string // type: string
// example: search words
Query string `json:"query"` Query string `json:"query"`
// Pagination offset // Pagination offset
@ -269,7 +266,6 @@ type searchParams struct {
// in: query // in: query
// required: false // required: false
// type integer // type integer
// example: 100
Start string `json:"start"` Start string `json:"start"`
// Limit results // Limit results
@ -277,7 +273,6 @@ type searchParams struct {
// in: query // in: query
// required: false // required: false
// type integer // type integer
// example: 50
Limit string `json:"limit"` Limit string `json:"limit"`
// [Timezone identifier](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) used only for `before:` & `after:` searches (eg: "Pacific/Auckland"). // [Timezone identifier](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) used only for `before:` & `after:` searches (eg: "Pacific/Auckland").
@ -344,7 +339,6 @@ type deleteSearchParams struct {
// in: query // in: query
// required: true // required: true
// type: string // type: string
// example: search words
Query string `json:"query"` Query string `json:"query"`
// [Timezone identifier](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) used only for `before:` & `after:` searches (eg: "Pacific/Auckland"). // [Timezone identifier](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) used only for `before:` & `after:` searches (eg: "Pacific/Auckland").

4
server/apiv1/other.go
View File

@ -22,7 +22,6 @@ type htmlCheckParams struct {
// in: path // in: path
// description: Message database ID or "latest" // description: Message database ID or "latest"
// required: true // required: true
// example: 4oRBnPtCXgAqZniRhzLNmS
ID string ID string
} }
@ -100,7 +99,6 @@ type linkCheckParams struct {
// //
// in: path // in: path
// required: true // required: true
// example: 4oRBnPtCXgAqZniRhzLNmS
ID string ID string
// Follow redirects // Follow redirects
@ -108,7 +106,6 @@ type linkCheckParams struct {
// in: query // in: query
// required: false // required: false
// default: false // default: false
// example: false
Follow string `json:"follow"` Follow string `json:"follow"`
} }
@ -179,7 +176,6 @@ type spamAssassinCheckParams struct {
// //
// in: path // in: path
// required: true // required: true
// example: 4oRBnPtCXgAqZniRhzLNmS
ID string ID string
} }

1
server/apiv1/release.go
View File

@ -24,7 +24,6 @@ type releaseMessageParams struct {
// in: path // in: path
// description: Message database ID // description: Message database ID
// required: true // required: true
// example: 4oRBnPtCXgAqZniRhzLNmS
ID string ID string
// in: body // in: body

2
server/apiv1/tags.go
View File

@ -105,7 +105,6 @@ type renameTagParams struct {
// in: path // in: path
// required: true // required: true
// type: string // type: string
// example: Old name
Tag string Tag string
// in: body // in: body
@ -168,7 +167,6 @@ type deleteTagParams struct {
// //
// in: path // in: path
// required: true // required: true
// example: My tag
Tag string Tag string
} }

2
server/apiv1/testing.go
View File

@ -17,7 +17,6 @@ type getMessageHTMLParams struct {
// //
// in: path // in: path
// required: true // required: true
// example: 4oRBnPtCXgAqZniRhzLNmS
ID string ID string
} }
@ -80,7 +79,6 @@ type getMessageTextParams struct {
// //
// in: path // in: path
// required: true // required: true
// example: 4oRBnPtCXgAqZniRhzLNmS
ID string ID string
} }

2
server/apiv1/thumbnails.go
View File

@ -28,14 +28,12 @@ type thumbnailParams struct {
// //
// in: path // in: path
// required: true // required: true
// example: 4oRBnPtCXgAqZniRhzLNmS
ID string ID string
// Attachment part ID // Attachment part ID
// //
// in: path // in: path
// required: true // required: true
// example: 2
PartID string PartID string
} }

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

@ -66,7 +66,6 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"example": "4oRBnPtCXgAqZniRhzLNmS",
"description": "Message database ID or \"latest\"", "description": "Message database ID or \"latest\"",
"name": "ID", "name": "ID",
"in": "path", "in": "path",
@ -107,7 +106,6 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"example": "4oRBnPtCXgAqZniRhzLNmS",
"description": "Message database ID or \"latest\"", "description": "Message database ID or \"latest\"",
"name": "ID", "name": "ID",
"in": "path", "in": "path",
@ -148,7 +146,6 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"example": "4oRBnPtCXgAqZniRhzLNmS",
"description": "Message database ID or \"latest\"", "description": "Message database ID or \"latest\"",
"name": "ID", "name": "ID",
"in": "path", "in": "path",
@ -189,7 +186,6 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"example": "4oRBnPtCXgAqZniRhzLNmS",
"description": "Message database ID or \"latest\"", "description": "Message database ID or \"latest\"",
"name": "ID", "name": "ID",
"in": "path", "in": "path",
@ -198,7 +194,6 @@
{ {
"type": "string", "type": "string",
"default": "false", "default": "false",
"example": "false",
"x-go-name": "Follow", "x-go-name": "Follow",
"description": "Follow redirects", "description": "Follow redirects",
"name": "follow", "name": "follow",
@ -241,7 +236,6 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"example": "4oRBnPtCXgAqZniRhzLNmS",
"description": "Message database ID or \"latest\"", "description": "Message database ID or \"latest\"",
"name": "ID", "name": "ID",
"in": "path", "in": "path",
@ -249,7 +243,6 @@
}, },
{ {
"type": "string", "type": "string",
"example": "2",
"description": "Attachment part ID", "description": "Attachment part ID",
"name": "PartID", "name": "PartID",
"in": "path", "in": "path",
@ -287,7 +280,6 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"example": "4oRBnPtCXgAqZniRhzLNmS",
"description": "Message database ID or \"latest\"", "description": "Message database ID or \"latest\"",
"name": "ID", "name": "ID",
"in": "path", "in": "path",
@ -295,7 +287,6 @@
}, },
{ {
"type": "string", "type": "string",
"example": "2",
"description": "Attachment part ID", "description": "Attachment part ID",
"name": "PartID", "name": "PartID",
"in": "path", "in": "path",
@ -330,7 +321,6 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"example": "4oRBnPtCXgAqZniRhzLNmS",
"description": "Message database ID or \"latest\"", "description": "Message database ID or \"latest\"",
"name": "ID", "name": "ID",
"in": "path", "in": "path",
@ -371,7 +361,6 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"example": "4oRBnPtCXgAqZniRhzLNmS",
"description": "Message database ID", "description": "Message database ID",
"name": "ID", "name": "ID",
"in": "path", "in": "path",
@ -432,7 +421,6 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"example": "4oRBnPtCXgAqZniRhzLNmS",
"description": "Message database ID or \"latest\"", "description": "Message database ID or \"latest\"",
"name": "ID", "name": "ID",
"in": "path", "in": "path",
@ -475,7 +463,6 @@
"type": "integer", "type": "integer",
"format": "int64", "format": "int64",
"default": 0, "default": 0,
"example": 100,
"x-go-name": "Start", "x-go-name": "Start",
"description": "Pagination offset", "description": "Pagination offset",
"name": "start", "name": "start",
@ -485,7 +472,6 @@
"type": "integer", "type": "integer",
"format": "int64", "format": "int64",
"default": 50, "default": 50,
"example": 50,
"x-go-name": "Limit", "x-go-name": "Limit",
"description": "Limit number of results", "description": "Limit number of results",
"name": "limit", "name": "limit",
@ -623,7 +609,6 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"example": "search words",
"x-go-name": "Query", "x-go-name": "Query",
"description": "Search query", "description": "Search query",
"name": "query", "name": "query",
@ -632,7 +617,6 @@
}, },
{ {
"type": "string", "type": "string",
"example": "100",
"x-go-name": "Start", "x-go-name": "Start",
"description": "Pagination offset", "description": "Pagination offset",
"name": "start", "name": "start",
@ -640,7 +624,6 @@
}, },
{ {
"type": "string", "type": "string",
"example": "50",
"x-go-name": "Limit", "x-go-name": "Limit",
"description": "Limit results", "description": "Limit results",
"name": "limit", "name": "limit",
@ -680,7 +663,6 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"example": "search words",
"x-go-name": "Query", "x-go-name": "Query",
"description": "Search query", "description": "Search query",
"name": "query", "name": "query",
@ -848,7 +830,6 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"example": "Old name",
"description": "The url-encoded tag name to rename", "description": "The url-encoded tag name to rename",
"name": "Tag", "name": "Tag",
"in": "path", "in": "path",
@ -898,7 +879,6 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"example": "My tag",
"description": "The url-encoded tag name to delete", "description": "The url-encoded tag name to delete",
"name": "Tag", "name": "Tag",
"in": "path", "in": "path",
@ -958,7 +938,6 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"example": "4oRBnPtCXgAqZniRhzLNmS",
"description": "Message database ID or \"latest\"", "description": "Message database ID or \"latest\"",
"name": "ID", "name": "ID",
"in": "path", "in": "path",
@ -996,7 +975,6 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"example": "4oRBnPtCXgAqZniRhzLNmS",
"description": "Message database ID or \"latest\"", "description": "Message database ID or \"latest\"",
"name": "ID", "name": "ID",
"in": "path", "in": "path",