docs: /docs -> /openapi.json

Author: synackd

cmd/cloud-init-server/handlers.go

@@ -53,7 +53,7 @@ func parseData(r *http.Request) (cistore.GroupData, error) {
 //	@Produce	json
 //	@Success	200	{object}	string
 //	@Failure	500	{object}	nil
-//	@Router		/cloud-init/docs [get]
+//	@Router		/cloud-init/openapi.json [get]
 func DocsHandler(w http.ResponseWriter, r *http.Request) {
 	doc, err := swag.ReadDoc()
 	if err != nil {

cmd/cloud-init-server/main.go

@@ -193,7 +193,7 @@ func main() {
 
 func initCiClientRouter(router chi.Router, handler *CiHandler, wgInterfaceManager *wgtunnel.InterfaceManager) {
 	// Add cloud-init endpoints to router
-	router.Get("/docs", DocsHandler)
+	router.Get("/openapi.json", DocsHandler)
 	router.With(wireGuardMiddleware).Get("/user-data", UserDataHandler)
 	router.With(wireGuardMiddleware).Get("/meta-data", MetaDataHandler(handler.sm, handler.store))
 	router.With(wireGuardMiddleware).Get("/vendor-data", VendorDataHandler(handler.sm, handler.store))

docs/docs.go

@@ -383,45 +383,45 @@ const docTemplate = `{
                 }
             }
         },
-        "/cloud-init/docs": {
+        "/cloud-init/meta-data": {
             "get": {
+                "description": "Get meta-data for requesting node based on the requesting IP.\n\nIf the impersonation API is enabled, an ID can be provided in\nthe URL path using ` + "`" + `/admin/impersonation` + "`" + `. In this case, the\nmeta-data will be retrieved for the requested ID.",
                 "produces": [
-                    "application/json"
+                    "application/x-yaml"
                 ],
-                "summary": "Return JSON-formatted OpenAPI documentation",
+                "summary": "Get meta-data for requesting node",
                 "responses": {
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "type": "string"
+                            "$ref": "#/definitions/main.MetaData"
                         }
                     },
+                    "404": {
+                        "description": "Not Found"
+                    },
+                    "422": {
+                        "description": "Unprocessable Entity"
+                    },
                     "500": {
                         "description": "Internal Server Error"
                     }
                 }
             }
         },
-        "/cloud-init/meta-data": {
+        "/cloud-init/openapi.json": {
             "get": {
-                "description": "Get meta-data for requesting node based on the requesting IP.\n\nIf the impersonation API is enabled, an ID can be provided in\nthe URL path using ` + "`" + `/admin/impersonation` + "`" + `. In this case, the\nmeta-data will be retrieved for the requested ID.",
                 "produces": [
-                    "application/x-yaml"
+                    "application/json"
                 ],
-                "summary": "Get meta-data for requesting node",
+                "summary": "Return JSON-formatted OpenAPI documentation",
                 "responses": {
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "$ref": "#/definitions/main.MetaData"
+                            "type": "string"
                         }
                     },
-                    "404": {
-                        "description": "Not Found"
-                    },
-                    "422": {
-                        "description": "Unprocessable Entity"
-                    },
                     "500": {
                         "description": "Internal Server Error"
                     }

docs/swagger.json

@@ -375,45 +375,45 @@
                 }
             }
         },
-        "/cloud-init/docs": {
+        "/cloud-init/meta-data": {
             "get": {
+                "description": "Get meta-data for requesting node based on the requesting IP.\n\nIf the impersonation API is enabled, an ID can be provided in\nthe URL path using `/admin/impersonation`. In this case, the\nmeta-data will be retrieved for the requested ID.",
                 "produces": [
-                    "application/json"
+                    "application/x-yaml"
                 ],
-                "summary": "Return JSON-formatted OpenAPI documentation",
+                "summary": "Get meta-data for requesting node",
                 "responses": {
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "type": "string"
+                            "$ref": "#/definitions/main.MetaData"
                         }
                     },
+                    "404": {
+                        "description": "Not Found"
+                    },
+                    "422": {
+                        "description": "Unprocessable Entity"
+                    },
                     "500": {
                         "description": "Internal Server Error"
                     }
                 }
             }
         },
-        "/cloud-init/meta-data": {
+        "/cloud-init/openapi.json": {
             "get": {
-                "description": "Get meta-data for requesting node based on the requesting IP.\n\nIf the impersonation API is enabled, an ID can be provided in\nthe URL path using `/admin/impersonation`. In this case, the\nmeta-data will be retrieved for the requested ID.",
                 "produces": [
-                    "application/x-yaml"
+                    "application/json"
                 ],
-                "summary": "Get meta-data for requesting node",
+                "summary": "Return JSON-formatted OpenAPI documentation",
                 "responses": {
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "$ref": "#/definitions/main.MetaData"
+                            "type": "string"
                         }
                     },
-                    "404": {
-                        "description": "Not Found"
-                    },
-                    "422": {
-                        "description": "Unprocessable Entity"
-                    },
                     "500": {
                         "description": "Internal Server Error"
                     }

docs/swagger.yaml

@@ -480,18 +480,6 @@ paths:
       tags:
       - admin
       - instance-data
-  /cloud-init/docs:
-    get:
-      produces:
-      - application/json
-      responses:
-        "200":
-          description: OK
-          schema:
-            type: string
-        "500":
-          description: Internal Server Error
-      summary: Return JSON-formatted OpenAPI documentation
   /cloud-init/meta-data:
     get:
       description: |-
@@ -514,6 +502,18 @@ paths:
         "500":
           description: Internal Server Error
       summary: Get meta-data for requesting node
+  /cloud-init/openapi.json:
+    get:
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            type: string
+        "500":
+          description: Internal Server Error
+      summary: Return JSON-formatted OpenAPI documentation
   /cloud-init/phone-home/{id}:
     post:
       description: |-