https://telecominfraproject.atlassian.net/browse/WIFI-12068

Signed-off-by: stephb9959 <stephane.bourque@gmail.com>

README.md

@@ -9,6 +9,10 @@ OWPROV manages groups of access points through the use of entities and vanues. O
 defined using an OpenAPI definition and uses the ucentral communication protocol to interact with Access Points. To use
 the OWPROV, you either need to [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-owprov/).
+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-owprov/main/openapi/owprov.yaml)) to get interactive docs page.
+
 ## Building
 To build the microservice from source, please follow the instructions in [here](./BUILDING.md)
 
@@ -54,6 +58,45 @@ You may modify the following fields in the POST
 - You may include an array of devices UUIDs
 - Topology and design cannot be set
 
+#### Expected directory layout
+From the directory where your cloned source is, you will need to create the `certs`, `logs`, and `uploads` directories.
+```bash
+mkdir certs
+mkdir certs/cas
+mkdir logs
+mkdir uploads
+```
+You should now have the following:
+```text
+--+-- certs
+  |   +--- cas
+  +-- cmake
+  +-- cmake-build
+  +-- logs
+  +-- src
+  +-- test_scripts
+  +-- openapi
+  +-- uploads
+  +-- owsec.properties
+```
+
+### Certificate
+The OWFMS uses a certificate to provide security for the REST API Certificate to secure the Northbound API.
+
+#### The `certs` directory
+For all deployments, you will need the following `certs` directory, populated with the proper files.
+
+```text
+certs ---+--- restapi-ca.pem
+         +--- restapi-cert.pem
+         +--- restapi-key.pem
+```
+
+## Firewall Considerations
+| Port  | Description                                    | Configurable |
+|:------|:-----------------------------------------------|:------------:|
+| 16004 | Default port for REST API Access to the OWPROV |     yes      |
+
 ### Environment variables
 The following environment variables should be set from the root directory of the service. They tell the OWGW process where to find
 the configuration and the root directory.
@@ -67,11 +110,6 @@ You can run the shell script `set_env.sh` from the microservice root.
 The configuration is kept in a file called `owprov.properties`. To understand the content of this file,
 please look [here](https://github.com/Telecominfraproject/wlan-cloud-owprov/blob/main/CONFIGURATION.md)
 
-## Firewall Considerations
-| Port  | Description                                    | Configurable |
-|:------|:-----------------------------------------------|:------------:|
-| 16004 | Default port for REST API Access to the OWPROV |     yes      |
-
 ## Kafka topics
 Toe read more about Kafka, follow the [document](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/main/KAFKA.md)
 

build

@@ -1 +1 @@
-15
+16