Merge pull request #50 from lsst-dm/IT-6370/release-field

jhoblitt · web-flow · commit 6efd1c1a4dc4 · 2025-09-02T14:30:15.000-07:00
add version field to RequestStatus client response
diff --git a/conf/conf.go b/conf/conf.go
@@ -24,6 +24,7 @@ type S3ndConf struct {
 	UploadPartsize        *k8sresource.Quantity
 	UploadBwlimit         *k8sresource.Quantity
 	UploadWriteBufferSize *k8sresource.Quantity
+	version               string
 }
 
 func (conf *S3ndConf) ToMap() map[string]string {
@@ -47,10 +48,16 @@ func (conf *S3ndConf) UploadBwlimitBytes() int64 {
 	return util.DivCeil(conf.UploadBwlimit.Value(), 8)
 }
 
+// Version returns the s3nd|api version.
+func (conf *S3ndConf) Version() string {
+	return conf.version
+}
+
 // Parse the environment variables and flags. If a flag is not set, the
 // environment variable is used. Errors are fatal.
 func NewConf(version string) S3ndConf {
 	conf := S3ndConf{}
+	conf.version = version
 
 	// start flags
 	defaultHost, ok := os.LookupEnv("S3ND_HOST")
@@ -116,7 +123,7 @@ func NewConf(version string) S3ndConf {
 	// end flags
 
 	if *versionFlag {
-		fmt.Println(version)
+		fmt.Println(conf.version)
 		os.Exit(0)
 	}
 
diff --git a/docs/docs.go b/docs/docs.go
@@ -175,6 +175,11 @@ const docTemplate = `{
                 },
                 "task": {
                     "$ref": "#/definitions/task"
+                },
+                "version": {
+                    "description": "s3nd|api version",
+                    "type": "string",
+                    "example": "0.0.0"
                 }
             }
         },
@@ -206,6 +211,11 @@ const docTemplate = `{
                             "example": "Gray Garden Slug"
                         }
                     }
+                },
+                "version": {
+                    "description": "s3nd|api version",
+                    "type": "string",
+                    "example": "0.0.0"
                 }
             }
         },
@@ -222,6 +232,11 @@ const docTemplate = `{
                 },
                 "task": {
                     "$ref": "#/definitions/task"
+                },
+                "version": {
+                    "description": "s3nd|api version",
+                    "type": "string",
+                    "example": "0.0.0"
                 }
             }
         },
@@ -238,6 +253,11 @@ const docTemplate = `{
                 },
                 "task": {
                     "$ref": "#/definitions/task"
+                },
+                "version": {
+                    "description": "s3nd|api version",
+                    "type": "string",
+                    "example": "0.0.0"
                 }
             }
         },
@@ -317,6 +337,11 @@ const docTemplate = `{
                             "example": "s3://my-bucket/my-key"
                         }
                     }
+                },
+                "version": {
+                    "description": "s3nd|api version",
+                    "type": "string",
+                    "example": "0.0.0"
                 }
             }
         },
@@ -352,6 +377,11 @@ const docTemplate = `{
                             "example": "s3://my-bucket/my-key"
                         }
                     }
+                },
+                "version": {
+                    "description": "s3nd|api version",
+                    "type": "string",
+                    "example": "0.0.0"
                 }
             }
         },
diff --git a/docs/swagger.json b/docs/swagger.json
@@ -166,6 +166,11 @@
                 },
                 "task": {
                     "$ref": "#/definitions/task"
+                },
+                "version": {
+                    "description": "s3nd|api version",
+                    "type": "string",
+                    "example": "0.0.0"
                 }
             }
         },
@@ -197,6 +202,11 @@
                             "example": "Gray Garden Slug"
                         }
                     }
+                },
+                "version": {
+                    "description": "s3nd|api version",
+                    "type": "string",
+                    "example": "0.0.0"
                 }
             }
         },
@@ -213,6 +223,11 @@
                 },
                 "task": {
                     "$ref": "#/definitions/task"
+                },
+                "version": {
+                    "description": "s3nd|api version",
+                    "type": "string",
+                    "example": "0.0.0"
                 }
             }
         },
@@ -229,6 +244,11 @@
                 },
                 "task": {
                     "$ref": "#/definitions/task"
+                },
+                "version": {
+                    "description": "s3nd|api version",
+                    "type": "string",
+                    "example": "0.0.0"
                 }
             }
         },
@@ -308,6 +328,11 @@
                             "example": "s3://my-bucket/my-key"
                         }
                     }
+                },
+                "version": {
+                    "description": "s3nd|api version",
+                    "type": "string",
+                    "example": "0.0.0"
                 }
             }
         },
@@ -343,6 +368,11 @@
                             "example": "s3://my-bucket/my-key"
                         }
                     }
+                },
+                "version": {
+                    "description": "s3nd|api version",
+                    "type": "string",
+                    "example": "0.0.0"
                 }
             }
         },
diff --git a/docs/swagger.md b/docs/swagger.md
@@ -224,6 +224,7 @@ Status: Gateway Timeout
 | code | integer| `int64` |  | |  | `200` |
 | msg | string| `string` |  | |  | `upload succeeded` |
 | task | [Task](#task)| `Task` |  | |  |  |
+| version | string| `string` |  | | s3nd|api version | `0.0.0` |
 
 
 
@@ -241,6 +242,7 @@ Status: Gateway Timeout
 | code | integer| `int64` |  | |  | `400` |
 | msg | string| `string` |  | |  | `error parsing request: missing field: uri` |
 | task | [RequestStatus400Task](#request-status400-task)| `RequestStatus400Task` |  | |  |  |
+| version | string| `string` |  | | s3nd|api version | `0.0.0` |
 
 
 
@@ -277,6 +279,7 @@ Status: Gateway Timeout
 | code | integer| `int64` |  | |  | `404` |
 | msg | string| `string` |  | |  | `upload failed because the bucket does not exist` |
 | task | [Task](#task)| `Task` |  | |  |  |
+| version | string| `string` |  | | s3nd|api version | `0.0.0` |
 
 
 
@@ -294,6 +297,7 @@ Status: Gateway Timeout
 | code | integer| `int64` |  | |  | `408` |
 | msg | string| `string` |  | |  | `upload queue timeout` |
 | task | [Task](#task)| `Task` |  | |  |  |
+| version | string| `string` |  | | s3nd|api version | `0.0.0` |
 
 
 
@@ -311,6 +315,7 @@ Status: Gateway Timeout
 | code | integer| `int64` |  | |  | `500` |
 | msg | string| `string` |  | |  | `unknown error` |
 | task | [RequestStatus500Task](#request-status500-task)| `RequestStatus500Task` |  | |  |  |
+| version | string| `string` |  | | s3nd|api version | `0.0.0` |
 
 
 
@@ -358,6 +363,7 @@ Status: Gateway Timeout
 | code | integer| `int64` |  | |  | `504` |
 | msg | string| `string` |  | |  | `timeout during upload attempt 2/2` |
 | task | [RequestStatus504Task](#request-status504-task)| `RequestStatus504Task` |  | |  |  |
+| version | string| `string` |  | | s3nd|api version | `0.0.0` |
 
 
 
diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -19,6 +19,10 @@ definitions:
         type: string
       task:
         $ref: '#/definitions/task'
+      version:
+        description: s3nd|api version
+        example: 0.0.0
+        type: string
     type: object
   requestStatus400:
     properties:
@@ -41,6 +45,10 @@ definitions:
             example: Gray Garden Slug
             type: string
         type: object
+      version:
+        description: s3nd|api version
+        example: 0.0.0
+        type: string
     type: object
   requestStatus404:
     properties:
@@ -52,6 +60,10 @@ definitions:
         type: string
       task:
         $ref: '#/definitions/task'
+      version:
+        description: s3nd|api version
+        example: 0.0.0
+        type: string
     type: object
   requestStatus408:
     properties:
@@ -63,6 +75,10 @@ definitions:
         type: string
       task:
         $ref: '#/definitions/task'
+      version:
+        description: s3nd|api version
+        example: 0.0.0
+        type: string
     type: object
   requestStatus500:
     properties:
@@ -122,6 +138,10 @@ definitions:
             example: s3://my-bucket/my-key
             type: string
         type: object
+      version:
+        description: s3nd|api version
+        example: 0.0.0
+        type: string
     type: object
   requestStatus504:
     properties:
@@ -147,6 +167,10 @@ definitions:
             example: s3://my-bucket/my-key
             type: string
         type: object
+      version:
+        description: s3nd|api version
+        example: 0.0.0
+        type: string
     type: object
   task:
     properties:
diff --git a/upload/handler.go b/upload/handler.go
@@ -252,9 +252,10 @@ func (u *RequestURL) UnmarshalText(text []byte) error {
 }
 
 type RequestStatus struct {
-	Code int         `json:"code" example:"200"`
-	Msg  string      `json:"msg,omitempty" example:"upload succeeded"`
-	Task *UploadTask `json:"task,omitempty"`
+	Version string      `json:"version" example:"0.0.0"` // s3nd|api version
+	Code    int         `json:"code" example:"200"`
+	Msg     string      `json:"msg,omitempty" example:"upload succeeded"`
+	Task    *UploadTask `json:"task,omitempty"`
 } //@name requestStatus200
 
 // requestStatusSwag400 is used only for Swagger documentation
@@ -456,9 +457,10 @@ func (h *S3ndHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 	}
 
 	status := RequestStatus{
-		Code: code,
-		Msg:  msg,
-		Task: task,
+		Version: h.conf.Version(),
+		Code:    code,
+		Msg:     msg,
+		Task:    task,
 	}
 
 	logLevel := slog.LevelInfo

Original file line number	Diff line number	Diff line change
@@ -175,6 +175,11 @@ const docTemplate = `{
`175`	`175`	`},`
`176`	`176`	`"task": {`
`177`	`177`	`"$ref": "#/definitions/task"`
	`178`	`+ },`
	`179`	`+ "version": {`
	`180`	`+ "description": "s3nd\|api version",`
	`181`	`+ "type": "string",`
	`182`	`+ "example": "0.0.0"`
`178`	`183`	`}`
`179`	`184`	`}`
`180`	`185`	`},`
@@ -206,6 +211,11 @@ const docTemplate = `{
`206`	`211`	`"example": "Gray Garden Slug"`
`207`	`212`	`}`
`208`	`213`	`}`
	`214`	`+ },`
	`215`	`+ "version": {`
	`216`	`+ "description": "s3nd\|api version",`
	`217`	`+ "type": "string",`
	`218`	`+ "example": "0.0.0"`
`209`	`219`	`}`
`210`	`220`	`}`
`211`	`221`	`},`
@@ -222,6 +232,11 @@ const docTemplate = `{
`222`	`232`	`},`
`223`	`233`	`"task": {`
`224`	`234`	`"$ref": "#/definitions/task"`
	`235`	`+ },`
	`236`	`+ "version": {`
	`237`	`+ "description": "s3nd\|api version",`
	`238`	`+ "type": "string",`
	`239`	`+ "example": "0.0.0"`
`225`	`240`	`}`
`226`	`241`	`}`
`227`	`242`	`},`
@@ -238,6 +253,11 @@ const docTemplate = `{
`238`	`253`	`},`
`239`	`254`	`"task": {`
`240`	`255`	`"$ref": "#/definitions/task"`
	`256`	`+ },`
	`257`	`+ "version": {`
	`258`	`+ "description": "s3nd\|api version",`
	`259`	`+ "type": "string",`
	`260`	`+ "example": "0.0.0"`
`241`	`261`	`}`
`242`	`262`	`}`
`243`	`263`	`},`
@@ -317,6 +337,11 @@ const docTemplate = `{
`317`	`337`	`"example": "s3://my-bucket/my-key"`
`318`	`338`	`}`
`319`	`339`	`}`
	`340`	`+ },`
	`341`	`+ "version": {`
	`342`	`+ "description": "s3nd\|api version",`
	`343`	`+ "type": "string",`
	`344`	`+ "example": "0.0.0"`
`320`	`345`	`}`
`321`	`346`	`}`
`322`	`347`	`},`
@@ -352,6 +377,11 @@ const docTemplate = `{
`352`	`377`	`"example": "s3://my-bucket/my-key"`
`353`	`378`	`}`
`354`	`379`	`}`
	`380`	`+ },`
	`381`	`+ "version": {`
	`382`	`+ "description": "s3nd\|api version",`
	`383`	`+ "type": "string",`
	`384`	`+ "example": "0.0.0"`
`355`	`385`	`}`
`356`	`386`	`}`
`357`	`387`	`},`
Original file line number	Diff line number	Diff line change
`@@ -166,6 +166,11 @@`
`166`	`166`	`},`
`167`	`167`	`"task": {`
`168`	`168`	`"$ref": "#/definitions/task"`
	`169`	`+ },`
	`170`	`+ "version": {`
	`171`	`+ "description": "s3nd\|api version",`
	`172`	`+ "type": "string",`
	`173`	`+ "example": "0.0.0"`
`169`	`174`	`}`
`170`	`175`	`}`
`171`	`176`	`},`
`@@ -197,6 +202,11 @@`
`197`	`202`	`"example": "Gray Garden Slug"`
`198`	`203`	`}`
`199`	`204`	`}`
	`205`	`+ },`
	`206`	`+ "version": {`
	`207`	`+ "description": "s3nd\|api version",`
	`208`	`+ "type": "string",`
	`209`	`+ "example": "0.0.0"`
`200`	`210`	`}`
`201`	`211`	`}`
`202`	`212`	`},`
`@@ -213,6 +223,11 @@`
`213`	`223`	`},`
`214`	`224`	`"task": {`
`215`	`225`	`"$ref": "#/definitions/task"`
	`226`	`+ },`
	`227`	`+ "version": {`
	`228`	`+ "description": "s3nd\|api version",`
	`229`	`+ "type": "string",`
	`230`	`+ "example": "0.0.0"`
`216`	`231`	`}`
`217`	`232`	`}`
`218`	`233`	`},`
`@@ -229,6 +244,11 @@`
`229`	`244`	`},`
`230`	`245`	`"task": {`
`231`	`246`	`"$ref": "#/definitions/task"`
	`247`	`+ },`
	`248`	`+ "version": {`
	`249`	`+ "description": "s3nd\|api version",`
	`250`	`+ "type": "string",`
	`251`	`+ "example": "0.0.0"`
`232`	`252`	`}`
`233`	`253`	`}`
`234`	`254`	`},`
`@@ -308,6 +328,11 @@`
`308`	`328`	`"example": "s3://my-bucket/my-key"`
`309`	`329`	`}`
`310`	`330`	`}`
	`331`	`+ },`
	`332`	`+ "version": {`
	`333`	`+ "description": "s3nd\|api version",`
	`334`	`+ "type": "string",`
	`335`	`+ "example": "0.0.0"`
`311`	`336`	`}`
`312`	`337`	`}`
`313`	`338`	`},`
`@@ -343,6 +368,11 @@`
`343`	`368`	`"example": "s3://my-bucket/my-key"`
`344`	`369`	`}`
`345`	`370`	`}`
	`371`	`+ },`
	`372`	`+ "version": {`
	`373`	`+ "description": "s3nd\|api version",`
	`374`	`+ "type": "string",`
	`375`	`+ "example": "0.0.0"`
`346`	`376`	`}`
`347`	`377`	`}`
`348`	`378`	`},`