Merge pull request #756 from hahattan/uom

feat: add UoM api route and response

Author: Lenny Goodell

common/constants.go

@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2020-2021 IOTech Ltd
+// Copyright (C) 2020-2022 IOTech Ltd
 //
 // SPDX-License-Identifier: Apache-2.0
 
@@ -100,11 +100,12 @@ const (
 	ApiTransmissionByStatusRoute           = ApiTransmissionRoute + "/" + Status + "/{" + Status + "}"
 	ApiTransmissionByNotificationIdRoute   = ApiTransmissionRoute + "/" + Notification + "/" + Id + "/{" + Id + "}"
 
-	ApiConfigRoute  = ApiBase + "/config"
-	ApiMetricsRoute = ApiBase + "/metrics"
-	ApiPingRoute    = ApiBase + "/ping"
-	ApiVersionRoute = ApiBase + "/version"
-	ApiSecretRoute  = ApiBase + "/secret"
+	ApiConfigRoute         = ApiBase + "/config"
+	ApiMetricsRoute        = ApiBase + "/metrics"
+	ApiPingRoute           = ApiBase + "/ping"
+	ApiVersionRoute        = ApiBase + "/version"
+	ApiSecretRoute         = ApiBase + "/secret"
+	ApiUnitsOfMeasureRoute = ApiBase + "/uom"
 
 	ApiDeviceCallbackRoute      = ApiBase + "/callback/device"
 	ApiDeviceCallbackNameRoute  = ApiBase + "/callback/device/name/{name}"
@@ -284,10 +285,12 @@ const (
 
 // Constants related to the possible content types supported by the APIs
 const (
+	Accept          = "Accept"
 	ContentType     = "Content-Type"
 	ContentLength   = "Content-Length"
 	ContentTypeCBOR = "application/cbor"
 	ContentTypeJSON = "application/json"
+	ContentTypeTOML = "application/toml"
 	ContentTypeYAML = "application/x-yaml"
 	ContentTypeText = "text/plain"
 	ContentTypeXML  = "application/xml"

dtos/responses/uom.go

@@ -0,0 +1,20 @@
+//
+// Copyright (C) 2022 IOTech Ltd
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package responses
+
+import "github.com/edgexfoundry/go-mod-core-contracts/v2/dtos/common"
+
+type UnitsOfMeasureResponse struct {
+	common.BaseResponse `json:",inline"`
+	Uom                 any `json:"uom"`
+}
+
+func NewUnitsOfMeasureResponse(requestId string, message string, statusCode int, uom any) UnitsOfMeasureResponse {
+	return UnitsOfMeasureResponse{
+		BaseResponse: common.NewBaseResponse(requestId, message, statusCode),
+		Uom:          uom,
+	}
+}

dtos/responses/uom_test.go

@@ -0,0 +1,25 @@
+//
+// Copyright (C) 2022 IOTech Ltd
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package responses
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestNewUnitsOfMeasureResponse(t *testing.T) {
+	expectedRequestId := "d61c96fc-f33d-4294-951e-6c2488b42737"
+	expectedStatusCode := 200
+	expectedMessage := "unit test message"
+	expectedUoM := struct{}{}
+	actual := NewUnitsOfMeasureResponse(expectedRequestId, expectedMessage, expectedStatusCode, expectedUoM)
+
+	assert.Equal(t, expectedRequestId, actual.RequestId)
+	assert.Equal(t, expectedStatusCode, actual.StatusCode)
+	assert.Equal(t, expectedMessage, actual.Message)
+	assert.Equal(t, expectedUoM, actual.Uom)
+}