Merge pull request #13 from lsst-dm/IT-5635/export-versioninfo

export VersionInfo type

Author: jhoblitt

docs/docs.go

@@ -109,14 +109,29 @@ const docTemplate = `{
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "$ref": "#/definitions/versionInfo"
+                            "$ref": "#/definitions/VersionInfo"
                         }
                     }
                 }
             }
         }
     },
     "definitions": {
+        "VersionInfo": {
+            "type": "object",
+            "properties": {
+                "config": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "string"
+                    }
+                },
+                "version": {
+                    "type": "string",
+                    "example": "0.0.0"
+                }
+            }
+        },
         "requestStatus200": {
             "type": "object",
             "properties": {
@@ -283,21 +298,6 @@ const docTemplate = `{
                     "example": "s3://my-bucket/my-key"
                 }
             }
-        },
-        "versionInfo": {
-            "type": "object",
-            "properties": {
-                "config": {
-                    "type": "object",
-                    "additionalProperties": {
-                        "type": "string"
-                    }
-                },
-                "version": {
-                    "type": "string",
-                    "example": "0.0.0"
-                }
-            }
         }
     }
 }`

docs/swagger.json

@@ -100,14 +100,29 @@
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "$ref": "#/definitions/versionInfo"
+                            "$ref": "#/definitions/VersionInfo"
                         }
                     }
                 }
             }
         }
     },
     "definitions": {
+        "VersionInfo": {
+            "type": "object",
+            "properties": {
+                "config": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "string"
+                    }
+                },
+                "version": {
+                    "type": "string",
+                    "example": "0.0.0"
+                }
+            }
+        },
         "requestStatus200": {
             "type": "object",
             "properties": {
@@ -274,21 +289,6 @@
                     "example": "s3://my-bucket/my-key"
                 }
             }
-        },
-        "versionInfo": {
-            "type": "object",
-            "properties": {
-                "config": {
-                    "type": "object",
-                    "additionalProperties": {
-                        "type": "string"
-                    }
-                },
-                "version": {
-                    "type": "string",
-                    "example": "0.0.0"
-                }
-            }
         }
     }
 }

docs/swagger.md

@@ -161,6 +161,22 @@ Status: Gateway Timeout
 
 ## Models
 
+### <span id="version-info"></span> VersionInfo
+
+
+  
+
+
+
+**Properties**
+
+| Name | Type | Go type | Required | Default | Description | Example |
+|------|------|---------|:--------:| ------- |-------------|---------|
+| config | map of string| `map[string]string` |  | |  |  |
+| version | string| `string` |  | |  | `0.0.0` |
+
+
+
 ### <span id="request-status200"></span> requestStatus200
 
 
@@ -313,19 +329,3 @@ Status: Gateway Timeout
 | uri | string| `string` |  | |  | `s3://my-bucket/my-key` |
 
 
-
-### <span id="version-info"></span> versionInfo
-
-
-  
-
-
-
-**Properties**
-
-| Name | Type | Go type | Required | Default | Description | Example |
-|------|------|---------|:--------:| ------- |-------------|---------|
-| config | map of string| `map[string]string` |  | |  |  |
-| version | string| `string` |  | |  | `0.0.0` |
-
-

docs/swagger.yaml

@@ -1,4 +1,14 @@
 definitions:
+  VersionInfo:
+    properties:
+      config:
+        additionalProperties:
+          type: string
+        type: object
+      version:
+        example: 0.0.0
+        type: string
+    type: object
   requestStatus200:
     properties:
       code:
@@ -119,16 +129,6 @@ definitions:
         example: s3://my-bucket/my-key
         type: string
     type: object
-  versionInfo:
-    properties:
-      config:
-        additionalProperties:
-          type: string
-        type: object
-      version:
-        example: 0.0.0
-        type: string
-    type: object
 info:
   contact:
     name: Support
@@ -196,7 +196,7 @@ paths:
         "200":
           description: OK
           schema:
-            $ref: '#/definitions/versionInfo'
+            $ref: '#/definitions/VersionInfo'
       summary: report service version and configuration
       tags:
       - version

version/handler.go

@@ -11,10 +11,10 @@ type VersionHandler struct {
 	conf *conf.S3ndConf
 }
 
-type versionInfo struct {
+type VersionInfo struct {
 	Version string            `json:"version" example:"0.0.0"`
 	Config  map[string]string `json:"config,omitempty"`
-} // @name versionInfo
+} // @name VersionInfo
 
 func NewHandler(conf *conf.S3ndConf) *VersionHandler {
 	return &VersionHandler{conf: conf}
@@ -23,10 +23,10 @@ func NewHandler(conf *conf.S3ndConf) *VersionHandler {
 // @summary      report service version and configuration
 // @tags         version
 // @produce      json
-// @success      200  {object}  versionInfo
+// @success      200  {object}  VersionInfo
 // @router       /version [get]
 func (h *VersionHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
-	info := &versionInfo{
+	info := &VersionInfo{
 		Version: Version,
 		Config:  h.conf.ToMap(),
 	}