[message pusher] - add swagger

2024-04-23 15:25:53 +08:00
parent 16541183ef
commit 9d09c793ad
11 changed files with 605 additions and 22 deletions
--- a/message_pusher/docs/swagger.json
+++ b/message_pusher/docs/swagger.json
@@ -0,0 +1,160 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "description": "This is a sample server celler server.",
+    "title": "Swagger Example API",
+    "termsOfService": "http://swagger.io/terms/",
+    "contact": {
+      "name": "API Support",
+      "url": "http://www.swagger.io/support",
+      "email": "support@swagger.io"
+    },
+    "license": {
+      "name": "Apache 2.0",
+      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
+    },
+    "version": "1.0"
+  },
+  "host": "localhost:8080",
+  "paths": {
+    "/cmii/update": {
+      "post": {
+        "description": "response to cmii update notification",
+        "consumes": [
+          "application/json"
+        ],
+        "produces": [
+          "application/json"
+        ],
+        "tags": [
+          "CmiiUpdate"
+        ],
+        "summary": "ping example",
+        "parameters": [
+          {
+            "description": "请求体",
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/cmii.MessageBody"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "schema": {
+              "$ref": "#/definitions/pusher.Message"
+            }
+          }
+        }
+      }
+    }
+  },
+  "definitions": {
+    "cmii.MessageBody": {
+      "type": "object",
+      "properties": {
+        "appName": {
+          "type": "string"
+        },
+        "deployStatus": {
+          "type": "boolean"
+        },
+        "fromTag": {
+          "type": "string"
+        },
+        "namespace": {
+          "type": "string"
+        },
+        "replicas": {
+          "type": "string"
+        },
+        "toTag": {
+          "type": "string"
+        }
+      }
+    },
+    "pusher.Attachment": {
+      "type": "object",
+      "properties": {
+        "expires": {
+          "type": "integer"
+        },
+        "name": {
+          "type": "string"
+        },
+        "size": {
+          "type": "integer"
+        },
+        "type": {
+          "type": "string"
+        },
+        "url": {
+          "type": "string"
+        }
+      }
+    },
+    "pusher.Message": {
+      "type": "object",
+      "properties": {
+        "attachment": {
+          "$ref": "#/definitions/pusher.Attachment"
+        },
+        "click": {
+          "type": "string"
+        },
+        "event": {
+          "type": "string"
+        },
+        "icon": {
+          "type": "string"
+        },
+        "id": {
+          "type": "string"
+        },
+        "message": {
+          "type": "string"
+        },
+        "priority": {
+          "type": "integer"
+        },
+        "raw": {
+          "type": "string"
+        },
+        "subscriptionID": {
+          "type": "string"
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "time": {
+          "type": "integer"
+        },
+        "title": {
+          "type": "string"
+        },
+        "topic": {
+          "type": "string"
+        },
+        "topicURL": {
+          "description": "Additional fields",
+          "type": "string"
+        }
+      }
+    }
+  },
+  "securityDefinitions": {
+    "BasicAuth": {
+      "type": "basic"
+    }
+  },
+  "externalDocs": {
+    "description": "OpenAPI",
+    "url": "https://swagger.io/resources/open-api/"
+  }
+}