Remove swagger parameter examples (invalid format)

axllent · Nov 9, 2024 · a7fac05 · a7fac05
1 parent 657cada
commit a7fac05
Show file tree

Hide file tree

Showing 8 changed files with 0 additions and 44 deletions.
diff --git a/server/apiv1/message.go b/server/apiv1/message.go
@@ -17,7 +17,6 @@ type getMessageParams struct {
 	//
 	// in: path
 	// required: true
-	// example: 4oRBnPtCXgAqZniRhzLNmS
 	ID string
 }
 
@@ -73,7 +72,6 @@ type getHeadersParams struct {
 	//
 	// in: path
 	// required: true
-	// example: 4oRBnPtCXgAqZniRhzLNmS
 	ID string
 }
 
@@ -140,14 +138,12 @@ type attachmentParams struct {
 	//
 	// in: path
 	// required: true
-	// example: 4oRBnPtCXgAqZniRhzLNmS
 	ID string
 
 	// Attachment part ID
 	//
 	// in: path
 	// required: true
-	// example: 2
 	PartID string
 }
 
@@ -199,7 +195,6 @@ type downloadRawParams struct {
 	//
 	// in: path
 	// required: true
-	// example: 4oRBnPtCXgAqZniRhzLNmS
 	ID string
 }
 

diff --git a/server/apiv1/messages.go b/server/apiv1/messages.go
@@ -17,7 +17,6 @@ type getMessagesParams struct {
 	// required: false
 	// default: 0
 	// type: integer
-	// example: 100
 	Start int `json:"start"`
 
 	// Limit number of results
@@ -27,7 +26,6 @@ type getMessagesParams struct {
 	// required: false
 	// default: 50
 	// type: integer
-	// example: 50
 	Limit int `json:"limit"`
 }
 
@@ -261,23 +259,20 @@ type searchParams struct {
 	// in: query
 	// required: true
 	// type: string
-	// example: search words
 	Query string `json:"query"`
 
 	// Pagination offset
 	//
 	// in: query
 	// required: false
 	// type integer
-	// example: 100
 	Start string `json:"start"`
 
 	// Limit results
 	//
 	// in: query
 	// required: false
 	// type integer
-	// example: 50
 	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").
@@ -344,7 +339,6 @@ type deleteSearchParams struct {
 	// in: query
 	// required: true
 	// type: string
-	// example: search words
 	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").

diff --git a/server/apiv1/other.go b/server/apiv1/other.go
@@ -22,7 +22,6 @@ type htmlCheckParams struct {
 	// in: path
 	// description: Message database ID or "latest"
 	// required: true
-	// example: 4oRBnPtCXgAqZniRhzLNmS
 	ID string
 }
 
@@ -100,15 +99,13 @@ type linkCheckParams struct {
 	//
 	// in: path
 	// required: true
-	// example: 4oRBnPtCXgAqZniRhzLNmS
 	ID string
 
 	// Follow redirects
 	//
 	// in: query
 	// required: false
 	// default: false
-	// example: false
 	Follow string `json:"follow"`
 }
 
@@ -179,7 +176,6 @@ type spamAssassinCheckParams struct {
 	//
 	// in: path
 	// required: true
-	// example: 4oRBnPtCXgAqZniRhzLNmS
 	ID string
 }
 

diff --git a/server/apiv1/release.go b/server/apiv1/release.go
@@ -24,7 +24,6 @@ type releaseMessageParams struct {
 	// in: path
 	// description: Message database ID
 	// required: true
-	// example: 4oRBnPtCXgAqZniRhzLNmS
 	ID string
 
 	// in: body

diff --git a/server/apiv1/tags.go b/server/apiv1/tags.go
@@ -105,7 +105,6 @@ type renameTagParams struct {
 	// in: path
 	// required: true
 	// type: string
-	// example: Old name
 	Tag string
 
 	// in: body
@@ -168,7 +167,6 @@ type deleteTagParams struct {
 	//
 	// in: path
 	// required: true
-	// example: My tag
 	Tag string
 }
 

diff --git a/server/apiv1/testing.go b/server/apiv1/testing.go
@@ -17,7 +17,6 @@ type getMessageHTMLParams struct {
 	//
 	// in: path
 	// required: true
-	// example: 4oRBnPtCXgAqZniRhzLNmS
 	ID string
 }
 
@@ -80,7 +79,6 @@ type getMessageTextParams struct {
 	//
 	// in: path
 	// required: true
-	// example: 4oRBnPtCXgAqZniRhzLNmS
 	ID string
 }
 

diff --git a/server/apiv1/thumbnails.go b/server/apiv1/thumbnails.go
@@ -28,14 +28,12 @@ type thumbnailParams struct {
 	//
 	// in: path
 	// required: true
-	// example: 4oRBnPtCXgAqZniRhzLNmS
 	ID string
 
 	// Attachment part ID
 	//
 	// in: path
 	// required: true
-	// example: 2
 	PartID string
 }
 

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