feat: Add API documents for Core Keeper and Support Cron Scheduler

Signed-off-by: Cherry Wang <cherry@iotechsys.com>
edgexfoundry · Jul 31, 2024 · 344f3de · 344f3de
1 parent e57d979
commit 344f3de
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 0 deletions.
diff --git a/docs_src/api/core/Ch-APICoreConfigurationAndRegistry.md b/docs_src/api/core/Ch-APICoreConfigurationAndRegistry.md
@@ -2,6 +2,9 @@
 
 EdgeX uses the 3rd party Consul microservice as the implementations for Configuration and Registry. The RESTful APIs are provided by Consul directly, and several communities supply Consul client libraries for different programming languages, including Go (official), Python, Java, PHP, Scala, Erlang/OTP, Ruby, Node.js, and C\#.
 
+!!! edgey - "EdgeX 3.2"
+    After v3.2, we added a new Configuration and Registry Service, Core Keeper, and the APIs is under [Core Keeper API documents](Ch-APICoreKeeper.md)
+
 For the client libraries of different languages, please refer to the
 list on this page:
 

diff --git a/docs_src/api/core/Ch-APICoreKeeper.md b/docs_src/api/core/Ch-APICoreKeeper.md
@@ -0,0 +1,7 @@
+# Core Keeper
+
+EdgeX Foundry's Core Keeper microservice is used for Configuration and Registry. See [Configuration and Registry Providers](../../microservices/configuration/ConfigurationAndRegistry.md) for more details about Configuration and Registry.
+
+## Swagger
+
+<swagger-ui src="https://raw.githubusercontent.com/edgexfoundry/edgex-go/{{edgexversion}}/openapi/{{api_version}}/core-keeper.yaml"/>
diff --git a/docs_src/api/support/Ch-APISupportCronScheduler.md b/docs_src/api/support/Ch-APISupportCronScheduler.md
@@ -0,0 +1,7 @@
+# Support Cron Scheduler
+
+EdgeX Foundry's Support Cron Scheduler microservice to schedule actions to occur on specific intervals or crontab definition. See Support Cron Scheduler (TBD) for more details about this service.
+
+## Swagger
+
+<swagger-ui src="https://raw.githubusercontent.com/edgexfoundry/edgex-go/{{edgexversion}}/openapi/{{api_version}}/support-cron-scheduler.yaml"/>
diff --git a/docs_src/microservices/configuration/ConfigurationAndRegistry.md b/docs_src/microservices/configuration/ConfigurationAndRegistry.md
@@ -8,6 +8,9 @@
 
  The EdgeX registry and configuration service provides other EdgeX Foundry micro services with information about associated services within EdgeX Foundry (such as location and status) and  configuration properties (i.e. - a repository of initialization and operating values).  Today, EdgeX Foundry uses [Consul by Hashicorp](https://www.consul.io/) as its reference implementation configuration and registry providers.  However, abstractions are in place so that these functions could be provided by an alternate implementation.  In fact, registration and configuration could be provided by different services under the covers.  For more, see the [Configuration Provider](ConfigurationAndRegistry.md#configuration-provider) and [Registry Provider](ConfigurationAndRegistry.md#registry-provider) sections in this page.
 
+!!! edgey - "EdgeX 3.2"
+    After v3.2, we added a new Configuration and Registry Service, Core Keeper.
+
 ## Configuration
 
 Please refer to the following EdgeX Foundry ADRs for details (and design decisions) behind the configuration in EdgeX

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -68,9 +68,11 @@ nav:
         - api/core/Ch-APICoreCommand.md
         - Core Data: microservices/core/data/ApiReference.md
         - api/core/Ch-APICoreMetadata.md
+        - api/core/Ch-APICoreKeeper.md
         - api/core/Ch-APICoreConfigurationAndRegistry.md
         - api/support/Ch-APISupportNotifications.md
         - api/support/Ch-APISupportScheduler.md
+        - api/support/Ch-APISupportCronScheduler.md
         - api/devices/Ch-APIDeviceSDK.md
         - App Services: microservices/application/ApiReference.md
         - api/applications/Ch-APIRulesEngine.md