Merge pull request #46 from stroncoso-quobis/doc/repo-nav-pages

Doc/repo nav pages

README.md

@@ -20,8 +20,14 @@ Repository to describe, develop, document and test the WebRTC API family
 * Started: September 2023
 * Location: virtually  
 
+## API Documentation
+
+* Find API reference documentation at folder: [code/API_definitions](code/API_definitions/)
+* Find detailed detailed API explanations at folder: [documentation/API_documentation](documentation/API_documentation)
+
 ## Meetings
 * Meetings are held virtually
+  * Find meeting notes at https://wiki.camaraproject.org/display/CAM/WebRTC+Meeting+Minutes
 * Schedule: Tuesdays 4pm CEST (Madrid, Paris, Berlin, Rome), each 15 days
 * Meeting link: [LFX Zoom](https://zoom-lfx.platform.linuxfoundation.org/meeting/99827941663?password=ac67c375-4795-4389-93b5-bb5ed5ef0977).
 ## Contributorship and mailing list

code/API_definitions/README.MD

@@ -1 +1,46 @@
-Here you can add your definitions and delete this README.MD file
+# WebRTC API definitions
+
+This folder contain the OpenAPI v3 definition of the WebRTC API
+
+## APIs included
+
+* [Registration and Authentication management](BYON-RACM-Service.yaml)
+  * This API definition provides functionality for a REST client, browser or native application to manage Registration and Connectivity (RACM) towards Internet Multimedia Subsystem (IMS) Network.
+    * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/main/code/API_definitions/BYON-RACM-Service.yaml&nocors)
+    * [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/main/code/API_definitions/BYON-RACM-Service.yaml)
+
+* [Notification Channel management](BYON-Notification-Channel.yaml)
+  * This API definition provides functionality for a REST client, browser or native application, to establish notification channel to receive asynchronous notifications from MNO's IMS Network.
+    * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/main/code/API_definitions/BYON-Notification-Channel.yaml&nocors)
+    * [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/main/code/API_definitions/BYON-Notification-Channel.yaml) 
+
+* [CallHandling service](BYON-CallHandling-Service.yaml)
+  * This API definition provides functionality for REST clients, browser or native application, to create and manage 1-1 calling. Both incoming and outgoing.
+    * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/main/code/API_definitions/BYON-CallHandling-Service.yaml&nocors)
+    * [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/main/code/API_definitions/BYON-CallHandling-Service.yaml)
+
+Detailed descriptions, diagrams and more information could be found at [API documentation](../../documentation/API_documentation/) section
+
+## Check APIs online
+
+Use the previous links to check the DEV main version of the API. Copy & paste any raw file to check them:
+
+* ReDoc: https://redocly.github.io/redoc/
+* Swagger: https://editor.swagger.io/
+
+
+## Build HTML from sources
+
+Build an HTML from sources using a local build OpenAPI v3 compatible like Node `redocly/cli`
+
+Execute redocly for each API document, use -o to 
+```
+$ npx @redocly/cli build-docs API_description_file.yaml
+```
+
+Or install the tool globaly and then build it
+```
+$ npm install @redocly/cli -g
+
+$ redocly build-docs API_description_file.yaml
+```

documentation/API_documentation/README.md

@@ -0,0 +1,9 @@
+# Supporting documents
+
+This folder include documentation to support the API definition, API overview description, how to use guides, and other documentation related with the OpenAPI v3 specs of the `API_definitions` folder.
+
+* [UML diagrams](uml-diagrams/)
+  * Check the UML diagrams included for the documented use cases. They include UML activity diagrams that depict a detailed interaction between apps, WebRTC GW and IMS network.
+
+* [WebRTC voice API](webrtc%20voice%20api.md)
+  * Check this document for introduction to the API, and brief expanation of the API itself, use cases and status descriptions.

documentation/API_documentation/FlowsBYON-CallHandling.wsd → documentation/API_documentation/uml-diagrams/FlowsBYON-CallHandling.wsd

@@ -1,4 +1,4 @@
-@startuml BYON Callhandling 0.1.2
+@startuml BYON-Callhandling-0_1_2
 
 title "BYON WEB RTC FLOW - Call handling v0.1.2"
 autonumber "<font color=blue><b>[0]"

documentation/API_documentation/uml-diagrams/README.md

@@ -0,0 +1,20 @@
+# UML diagrams
+
+This folder includes UML files and PNG rederizations of the three main use cases.
+
+- [UML diagrams](#uml-diagrams)
+  - [Notification channel creation](#notification-channel-creation)
+  - [RACM - Registration process](#racm---registration-process)
+  - [Call handling - originating \& terminating](#call-handling---originating--terminating)
+
+## Notification channel creation
+
+![BYON Notification Channel](<BYON NotificationChannel 0.1.2.png>)
+
+## RACM - Registration process
+
+![BYON Registration](<BYON Registration 0.1.2.png>)
+
+## Call handling - originating & terminating
+
+![BYON Call Handling](<BYON Callhandling 0.1.2.png>)

documentation/MeetingMinutes/README.md

@@ -0,0 +1,5 @@
+# Meeting notes
+
+These meetings notes are stored her for archive purposes, find updated Meeting notes at CAMARA main Wiki website
+
+* https://wiki.camaraproject.org/display/CAM/WebRTC+Meeting+Minutes

documentation/README.md

@@ -0,0 +1,12 @@
+# Documentation
+
+This folder include extra documentation about the API beyond the technical OpenAPI v3 API description of the `code` folder
+
+* [MeetingMinutes](MeetingMinutes/)
+  * Check this folder for the original meeting minutes.
+
+* [API_documentation](API_documentation/)
+  * Check this folder for extra documentation to support the API definition, UML activity diagrams, API overview description, how to use guides, and other documentation related.
+
+* [SupportingDocuments](SupportingDocuments/)
+  * Check this folder for other supporting documentation.

documentation/MeetingMinutes/README.MD → documentation/SupportingDocuments/README.md

@@ -1 +1 @@
-This README.MD can be deleted when the first file is added to this directory.
+This README.MD can be deleted when the first file is added to this directory.