PATCH Request on core-metadata failing

[satyam1990]

Hi Team,

My core-metadata version is: 2.1.1 and I am unable to send PATCH request successfully to update an existing devices attribute.

I have a existing device which I can get using core-metadata REST API {{Hostname}}:59881/api/v2/device/name/Temp-Device01:

{
    "apiVersion": "v2",
    "statusCode": 200,
    "device": {
        "created": 1672909375233,
        "modified": 1672909375233,
        "id": "735dba55-432b-468f-b3a4-975b39dfa043",
        "name": "Temp-Device01",
        "description": "Temperature Generator Device",
        "adminState": "UNLOCKED",
        "operatingState": "UP",
        "labels": [
            "temperature",
            "random"
        ],
        "serviceName": "device-template",
        "profileName": "Temp-Device",
        "autoEvents": [
            {
                "interval": "10s",
                "onChange": false,
                "sourceName": "temperature"
            }
        ],
        "protocols": {
            "Other": {
                "Address": "random",
                "Port": "300"
            }
        }
    }
}

Now lets say I need to update description of the device and adminState so I sent below PATCH request to core-metadata using Postman:

PATCH: {{Hostname}}:59881/api/v2/device

Body I have set to RAW : JSON which looks as below:

[
  {
    "apiVersion": "v2",
    "device": [
        {
            "name": "Temp-Device01",
            "description": "Test",
            "adminState": "LOCKED"
        }
    ]
  }
]

I get below response when I sent above PATCH request:

{
    "apiVersion": "v2",
    "message": "*[]requests.UpdateDeviceRequest json decoding failed",
    "statusCode": 400
}

In core-metadata logs I see similar error:
level=ERROR ts=2023-01-05T11:43:40.568884317Z app=core-metadata source=http.go:47 X-Correlation-ID=78017448-921e-4a90-8000-127a70515af3 msg="*[]requests.UpdateDeviceRequest json decoding failed -> Failed to unmarshal request body as JSON. -> json: cannot unmarshal array into Go struct field .Device of type dtos.UpdateDevice"

Then I happened to have a look at this UpdateDevice Struct
As per the struct rules I seem to be doing right, It says "id" only required when "name" not present rest fields are optional only, I even tried giving each and every field as stated in the sturct still I get same 400 Bad Request error.

Could you please help me out on where I could be going wrong.

[satyam1990]

It was my bad I am making incorrect JSON body, device is an object and not an array of objects, by mistake I have made device as array and inside that I put device object.

With below Update it works fine:
PATCH: {{Hostname}}:59881/api/v2/device

Body I have set to RAW : JSON which looks as below:

[
  {
    "apiVersion": "v2",
    "device":
        {
            "name": "Temp-Device01",
            "description": "Test",
            "adminState": "LOCKED",
            "operatingState": "UP"
        }
  }
]

[satyam1990]

And now I know why I made that mistake in EdgeX Foundry documentation 2.1.0 it is mentioned like that:
https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-metadata/2.1.0#/default/patch_device

I am running 2.1.1 so I prefer to use 2.1(jakarta) documentation, maybe better I follow 2.2 documentation from now on.