Topics

Decision Notice Core APIs

Trevor.Conn@...
 

Hi all – I wanted to make you aware of some decisions we made this morning in the Core WG call. This is in regard to changes to the core-command and core-metadata APIs that will be made prior to the Edinburgh code freeze. There are more details and context in today’s notes which have been posted here:

https://wiki.edgexfoundry.org/display/FA/Core+Working+Group

 

In short, the accepted changes are as follows. The rationale is provided in the document above. If you fore-see a problem with this or have a legitimate use case that would be adversely affected by the removal of a given endpoint, please speak up ASAP.

 

Core-command

Removal of the following endpoints

PUT /device/{id} (Used to set admin/operating State on device)

                •Duplicate with the following metadata routes

                                oPUT /device/{id}/adminstate/{adminState}

                                oPUT /device/{id}/opstate/{opState}

PUT /device/name/{name}(Used to set admin/operating State on device)

                •Duplicate with the following metadata routes

                                oPUT /device/name/{name}/adminstate/{adminState}

                                oPUT /device/name/{name}/opstate/{opState}

 

Core-metadata

Removal of the following endpoints

POST & PUT /command (adds or updates a command)

DELETE /command/id/{id}(deletes a command by its ID)

These endpoints today have no real effect because whenever we return a list of commands for a device, those commands come from the DeviceProfile and not the Commands collection.

 

Trevor Conn

Technical Staff Engineer

Core Working Group Chair of EdgeX Foundry

Dell Technologies | IoT DellTech

Trevor.Conn@...

Round Rock, TX USA