From acff9afff20e15131fb2ccd519a85721c7b2e002 Mon Sep 17 00:00:00 2001 From: Dmitry Dunaev Date: Tue, 29 Nov 2022 15:02:31 +0300 Subject: [PATCH] [WIFI-11729] Add: README info Signed-off-by: Dmitry Dunaev --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e9c3cec..007ed40 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,11 @@ The uCentralFMS is a micro-service part of the OpenWiFi ecosystem. uCentralFMS i to facilitate the task of upgrade and maintaining the proper firmware for all the devices used in your OpenWiFi solution. You may either [build it](#building) or use the [Docker version](#docker). +## OpenAPI +You may get static page with OpenAPI docs generated from the definition on [GitHub Page](https://telecominfraproject.github.io/wlan-cloud-ucentralfms/). + +Also you may use [Swagger UI](https://petstore.swagger.io/#/) with OpenAPI definition file raw link (i.e. [latest version file](https://raw.githubusercontent.com/Telecominfraproject/wlan-cloud-ucentralfms/main/openapi/owfms.yaml)) to get interactive docs page. + ## Building In order to build the uCentralFMS, you will need to install its dependencies, which includes the following: - cmake @@ -216,4 +221,4 @@ s3.key = ******************************************* s3.retry = 60 s3.bucket.uri = ucentral-ap-firmware.s3.amazonaws.com -``` \ No newline at end of file +```