refactor: Device Service refactor (#1263)

* refactor: Device Service refactor - Phase 1 Signed-off-by: melody <melody@iotechsys.com>
edgexfoundry · Nov 1, 2023 · 6cf65c5 · 6cf65c5
1 parent 92ca15b
commit 6cf65c5
Show file tree

Hide file tree

Showing 52 changed files with 927 additions and 436 deletions.
diff --git a/docs_src/api/devices/Ch-APIDeviceSDK.md b/docs_src/api/devices/Ch-APIDeviceSDK.md
@@ -1,6 +1,6 @@
 # Device Services
 
-The EdgeX Foundry Device Service Software Development Kit (SDK) takes the Developer through the step-by-step process to create an EdgeX Foundry Device Service microservice. See [Device Service SDK](../../microservices/device/sdk/Ch-DeviceSDK.md) for more details on this SDK.
+The EdgeX Foundry Device Service Software Development Kit (SDK) takes the Developer through the step-by-step process to create an EdgeX Foundry Device Service microservice. See [Device Service SDK](../../microservices/device/sdk/Purpose.md) for more details on this SDK.
 
 The Device Service SDK provides a RESTful API that all Device Services inherit from the SDK.
 

diff --git a/docs_src/general/ServiceConfiguration.md b/docs_src/general/ServiceConfiguration.md
@@ -29,7 +29,7 @@ Please refer to the general [Common Configuration documentation](../microservice
 === "Device"
     |Service Name|	Configuration Reference|
     |---|---|
-    |device-service	|[General Device Service Configuration](../microservices/device/Ch-DeviceServices.md#configuration-properties)|
+    |device-service	|[General Device Service Configuration](../microservices/device/Configuration.md)|
     |device-virtual	|[Virtual Device Service Configuration](../microservices/device/services/device-virtual/Ch-VirtualDevice.md#configuration-properties)|
 === "Security"
     |Service Name|	Configuration Reference|

diff --git a/docs_src/getting-started/Ch-GettingStartedCDevelopers.md b/docs_src/getting-started/Ch-GettingStartedCDevelopers.md
@@ -96,4 +96,4 @@ apk add iotech-iot-1.5-dev
 Note: If not using Alpine 3.16, replace v3.16 in the above commands with the correct version.
 
 ## Next Steps
-To explore how to create and build EdgeX device services in C, head to the [Device Services, C SDK guide](Ch-GettingStartedSDK-C.md).
+To explore how to create and build EdgeX device services in C, head to the [Device Services, C SDK guide](../microservices/device/sdk/devicesdk-getting-started/GettingStartedSDK-C.md).
diff --git a/docs_src/getting-started/Ch-GettingStartedGoDevelopers.md b/docs_src/getting-started/Ch-GettingStartedGoDevelopers.md
@@ -181,7 +181,7 @@ See [EdgeX Default Service Ports](../../general/ServicePorts) for a list of the
 Application services and some device services are also built in Go.  To explore how to create and build EdgeX application and devices services in Go, head to SDK documentation covering these EdgeX elements.
 
 - [Application Services and the Application Functions SDK](../microservices/application/sdk/GettingStarted.md)
-- [Device Services in Go](./Ch-GettingStartedSDK-Go.md)
+- [Device Services in Go](../microservices/device/sdk/devicesdk-getting-started/GettingStartedSDK-Go.md)
 
 ## EdgeX Foundry in GoLand
 

diff --git a/docs_src/getting-started/Ch-GettingStartedSDK.md b/docs_src/getting-started/Ch-GettingStartedSDK.md
diff --git a/docs_src/getting-started/index.md b/docs_src/getting-started/index.md
@@ -44,10 +44,10 @@ may also want to obtain the Device Service Software Development Kit (DS
 SDK) and create new device services. The DS SDK creates all the
 scaffolding code for a new EdgeX Foundry device service; allowing you to
 focus on the details of interfacing with the device in its native
-protocol. See [Getting Started with Device SDK](./Ch-GettingStartedSDK.md)
+protocol. See [Getting Started with Device SDK](../microservices/device/sdk/Purpose.md)
 for help on using the DS SDK to create a new device service. Learn more
 about Device Services and the Device Service SDK at
-[Device Services](../microservices/device/Ch-DeviceServices.md).
+[Device Services](../microservices/device/DeviceService.md).
 
 ## Application Service Developer
 

diff --git a/docs_src/getting-started/tools/Ch-GUI.md b/docs_src/getting-started/tools/Ch-GUI.md
@@ -59,7 +59,7 @@ The GUI allows you to
 ### Dashboard
 The Dashboard page (the main page of the GUI) presents you with a set of clickable "tiles" that provide a quick view of the status of your EdgeX instance.  That is, it provides some quick data points about the EdgeX instance and what the GUI is tracking.  Specifically, the tiles in the Dashboard show you:
 
-- the number of [device services](../../microservices/device/Ch-DeviceServices.md) that it is aware of and their status (locked vs unlocked)
+- the number of [device services](../../microservices/device/DeviceService.md) that it is aware of and their status (locked vs unlocked)
 - the number of devices being managed by EdgeX (through the associated device services)
 - the number of [device profiles](../../microservices/core/metadata/details/DeviceProfile.md) registered with core metadata
 - the number of [schedules](../../microservices/support/scheduler/Purpose.md) (or intervals) EdgeX is managing

diff --git a/docs_src/microservices/device/ApiReference.md b/docs_src/microservices/device/ApiReference.md
@@ -0,0 +1,9 @@
+---
+title: Device Service - API Reference
+---
+
+# Device Service - API Reference
+
+The following REST APIs are provided by the Device Services SDK and are inherited by all Device Services.
+
+<swagger-ui src="https://github.com/raw/edgexfoundry/device-sdk-go/{{edgexversion}}/openapi/{{api_version}}/device-sdk.yaml"/>