PMM-4052 Fix order of fields in Swagger. (#443)

Gopkg.toml

@@ -6,6 +6,7 @@ required = [
   "github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger",
   "github.com/go-swagger/go-swagger/cmd/swagger",
   "github.com/BurntSushi/go-sumtype",
+  "github.com/Percona-Lab/swagger-order",
 
   # require key dependencies explicitly to make dep work
   "github.com/golang/protobuf/proto",
@@ -44,7 +45,8 @@ required = [
   version = "=1.11.1"
 [[constraint]]
   name = "github.com/go-swagger/go-swagger"
-  version = "=0.20.1"
+  source = "github.com/Percona-Lab/go-swagger"
+  version = "=0.20.1-percona2" # TODO switch to upstream as soon as https://github.com/go-swagger/go-swagger/pull/2074 is released.
 [[constraint]]
   name = "github.com/sirupsen/logrus"
   version = "=1.4.2"

api/Makefile

@@ -19,6 +19,7 @@ gen: clean            ## Generate files.
 					../vendor/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway \
 					../vendor/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger \
 					../vendor/github.com/go-swagger/go-swagger/cmd/swagger \
+					../vendor/github.com/Percona-Lab/swagger-order \
 					../vendor/github.com/BurntSushi/go-sumtype
 
 	# generated by ./prototool break descriptor-set . -o v2.0.0.descriptor
@@ -28,7 +29,7 @@ gen: clean            ## Generate files.
 
 	for API in agentlocalpb serverpb inventorypb managementpb qanpb ; do \
 		set -x ; \
-		swagger mixin $$API/json/header.json $$API/*.swagger.json --output=$$API/json/$$API.json ; \
+		swagger mixin $$API/json/header.json $$API/*.swagger.json --output=$$API/json/$$API.json --keep-spec-order; \
 		swagger flatten --with-flatten=expand --with-flatten=remove-unused $$API/json/$$API.json --output=$$API/json/$$API.json ; \
 		swagger validate $$API/json/$$API.json ; \
 		swagger generate client --with-flatten=expand --with-flatten=remove-unused --spec=$$API/json/$$API.json --target=$$API/json \
@@ -50,6 +51,8 @@ gen: clean            ## Generate files.
 		qanpb/json/qanpb.json
 	swagger validate swagger/swagger.json
 
+	swagger-order --output=swagger/swagger.json swagger/swagger.json
+
 	make clean_swagger
 	go fmt ../...
 	go-sumtype ../...

api/agentlocalpb/json/agentlocalpb.json

@@ -81,7 +81,8 @@
                 "get_network_info": {
                   "description": "Returns network info (latency and clock_drift) if true.",
                   "type": "boolean",
-                  "format": "boolean"
+                  "format": "boolean",
+                  "x-order": 0
                 }
               }
             }
@@ -94,7 +95,8 @@
               "type": "object",
               "properties": {
                 "agent_id": {
-                  "type": "string"
+                  "type": "string",
+                  "x-order": 0
                 },
                 "agents_info": {
                   "type": "array",
@@ -103,7 +105,8 @@
                     "type": "object",
                     "properties": {
                       "agent_id": {
-                        "type": "string"
+                        "type": "string",
+                        "x-order": 0
                       },
                       "agent_type": {
                         "description": "AgentType describes supported Agent types.",
@@ -137,44 +140,53 @@
                         ]
                       }
                     }
-                  }
+                  },
+                  "x-order": 3
                 },
                 "config_filepath": {
                   "description": "Config file path if pmm-agent was started with one.",
-                  "type": "string"
+                  "type": "string",
+                  "x-order": 4
                 },
                 "runs_on_node_id": {
-                  "type": "string"
+                  "type": "string",
+                  "x-order": 1
                 },
                 "server_info": {
                   "description": "ServerInfo contains information about the PMM Server.",
                   "type": "object",
                   "properties": {
                     "clock_drift": {
                       "description": "Clock drift from PMM Server (if agent is connected).",
-                      "type": "string"
+                      "type": "string",
+                      "x-order": 5
                     },
                     "connected": {
                       "description": "True if pmm-agent is currently connected to the server.",
                       "type": "boolean",
-                      "format": "boolean"
+                      "format": "boolean",
+                      "x-order": 2
                     },
                     "insecure_tls": {
                       "description": "PMM Server's TLS certificate validation should be skipped if true.",
                       "type": "boolean",
-                      "format": "boolean"
+                      "format": "boolean",
+                      "x-order": 1
                     },
                     "latency": {
                       "description": "Ping time from pmm-agent to pmm-managed (if agent is connected).",
-                      "type": "string"
+                      "type": "string",
+                      "x-order": 4
                     },
                     "url": {
                       "description": "PMM Server URL in a form https://HOST:PORT/.",
-                      "type": "string"
+                      "type": "string",
+                      "x-order": 0
                     },
                     "version": {
                       "description": "PMM Server version (if agent is connected).",
-                      "type": "string"
+                      "type": "string",
+                      "x-order": 3
                     }
                   }
                 }