update swagger

Author: JamesReate

docs/docs.go

@@ -393,10 +393,7 @@ const docTemplate = `{
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "type": "object",
-                            "additionalProperties": {
-                                "type": "string"
-                            }
+                            "$ref": "#/definitions/github_com_DIMO-Network_device-definitions-api_internal_core_queries.GetVINProfileResponse"
                         }
                     },
                     "400": {
@@ -615,6 +612,26 @@ const docTemplate = `{
                 }
             }
         },
+        "github_com_DIMO-Network_device-definitions-api_internal_core_queries.GetVINProfileResponse": {
+            "type": "object",
+            "properties": {
+                "powertrainType": {
+                    "type": "string"
+                },
+                "profileRaw": {
+                    "type": "array",
+                    "items": {
+                        "type": "integer"
+                    }
+                },
+                "vendor": {
+                    "type": "string"
+                },
+                "vin": {
+                    "type": "string"
+                }
+            }
+        },
         "internal_api_handlers.DecodeVINRequest": {
             "type": "object",
             "properties": {

docs/swagger.json

@@ -384,10 +384,7 @@
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "type": "object",
-                            "additionalProperties": {
-                                "type": "string"
-                            }
+                            "$ref": "#/definitions/github_com_DIMO-Network_device-definitions-api_internal_core_queries.GetVINProfileResponse"
                         }
                     },
                     "400": {
@@ -606,6 +603,26 @@
                 }
             }
         },
+        "github_com_DIMO-Network_device-definitions-api_internal_core_queries.GetVINProfileResponse": {
+            "type": "object",
+            "properties": {
+                "powertrainType": {
+                    "type": "string"
+                },
+                "profileRaw": {
+                    "type": "array",
+                    "items": {
+                        "type": "integer"
+                    }
+                },
+                "vendor": {
+                    "type": "string"
+                },
+                "vin": {
+                    "type": "string"
+                }
+            }
+        },
         "internal_api_handlers.DecodeVINRequest": {
             "type": "object",
             "properties": {

docs/swagger.yaml

@@ -131,6 +131,19 @@ definitions:
       year:
         type: integer
     type: object
+  github_com_DIMO-Network_device-definitions-api_internal_core_queries.GetVINProfileResponse:
+    properties:
+      powertrainType:
+        type: string
+      profileRaw:
+        items:
+          type: integer
+        type: array
+      vendor:
+        type: string
+      vin:
+        type: string
+    type: object
   internal_api_handlers.DecodeVINRequest:
     properties:
       countryCode:
@@ -404,9 +417,7 @@ paths:
         "200":
           description: OK
           schema:
-            additionalProperties:
-              type: string
-            type: object
+            $ref: '#/definitions/github_com_DIMO-Network_device-definitions-api_internal_core_queries.GetVINProfileResponse'
         "400":
           description: Bad Request
         "404":

internal/api/handlers/device_definition_handler.go

@@ -102,7 +102,7 @@ func GetDeviceDefinitionByID(m mediator.Mediator) fiber.Handler {
 // @Tags device-definitions
 // @Param  vin path string true "17 character usa based VIN eg. WBA12345678901234"
 // @Produce json
-// @Success 200 {object} map[]string{}
+// @Success 200 {object} queries.GetVINProfileResponse
 // @Failure 404
 // @Failure 400
 // @Failure 500