README Updated (#6)

* OpenAPI integration work in progress

* API Gateway updates

* API Gateway support - beta release

* README updated

* README updated

* README updated

* README updated

* README updated

* README updated

* Declaration schema updated, Developer portal alpha release

* Postman collection updated

* Devportal alpha release commit

* Devportal alpha release commit

* Added Developer Portal support

* README updated

* README updated

* README updated

* README updated

* README updated

Author: fabriziofiorucci

README.md

@@ -29,38 +29,95 @@ Use cases include:
 ## Architecture
 
 ```mermaid
-graph TD
-DEVOPS([DevOps]) -- REST API --> CICD
-User([User]) -- REST API --> NCG
-CICD(CI/CD Pipeline) -- REST API --> NCG[[NGINX Declarative API]]
-NCG -- Staged Configs --> NIM(NGINX Instance Manager)
-NCG -- REST API --> Generic(Generic REST API endpoint)
-NCG -- AutoSync / GitOps --> CICD
-NIM -- REST API --> NGINX(NGINX Plus) & NGINXOSS(NGINX OSS)
-NCG -- ConfigMap --> K8S(Kubernetes)
-REDIS[[Redis backend]] --> NCG
-NCG --> REDIS
+---
+title: NGINX Declarative API internal architecture
+---
+stateDiagram-v2
+    DevOps: User
+    Client: REST Client
+    Pipeline: CI/CD Pipeline
+    NIM: NGINX Instance Manager
+    AGENT: NGINX Agent
+    NGINX: NGINX
+    INPUT: Input
+    SOT: Source of Truth
+    NDAPI: NGINX Declarative API Core
+    DEVP: Developer Portal Service
+    OUTPUT: Output
+    REDIS: Redis
+    POST: Generic POST endpoint
+    CONFIGMAP: Kubernetes ConfigMap
+    PLAINTEXT: Plaintext
+    BASE64: Base64-encoded
+
+    DevOps --> Pipeline
+    Pipeline --> INPUT
+    Client --> INPUT
+    INPUT --> NDAPI
+    NDAPI --> OUTPUT
+    NDAPI --> SOT
+    SOT --> NDAPI
+    NDAPI --> REDIS
+    REDIS --> NDAPI
+    OUTPUT --> BASE64
+    OUTPUT --> POST
+    OUTPUT --> CONFIGMAP
+    OUTPUT --> PLAINTEXT
+    OUTPUT --> NIM
+    NDAPI --> DEVP
+    DEVP --> NDAPI
+    NIM --> AGENT
+    AGENT --> NGINX
 ```
 
-## GitOps
+## GitOps Autosync Mode
 
 ```mermaid
 sequenceDiagram
 
-title GitOps with NGINX Instance Manager
+title GitOps autosync operations
 
-User ->> Source of truth: Commit object updates
-NGINX Declarative API ->> Source of truth: Check for updates
-Source of truth ->> NGINX Declarative API: Latest timestamp
+participant CI/CD Pipeline
+participant Source of Truth
+participant NGINX Declarative API Core
+participant Redis
+participant Developer Portal Service
+participant NGINX Instance Manager
+participant NGINX
 
-NGINX Declarative API->> NGINX Declarative API: If updates available
-NGINX Declarative API->> Source of truth: Pull updated objects
-Source of truth ->> NGINX Declarative API : Updated objects
+box NGINX Declarative API
+    participant NGINX Declarative API Core
+    participant Developer Portal Service
+    participant Redis
+end
 
-NGINX Declarative API->> NGINX Declarative API: Build staged config
-NGINX Declarative API->> NGINX Instance Manager: POST staged config to instance group
+CI/CD Pipeline ->> Source of Truth: Commit object updates
 
+critical Run every "synctime" seconds
+
+NGINX Declarative API Core ->>+ Source of Truth: Check for referenced objects updates
+Source of Truth ->>- NGINX Declarative API Core: Latest timestamp
+
+Note over NGINX Declarative API Core, Redis: data synchronization
+
+option If updates available
+NGINX Declarative API Core ->>+ Source of Truth: Pull updated objects
+Source of Truth ->>- NGINX Declarative API Core : Updated objects
+
+critical Build Staged Config
+critical If Developer Portal enabled
+    NGINX Declarative API Core ->>+ Developer Portal Service: DevPortal generation request
+    Developer Portal Service ->>- NGINX Declarative API Core: DevPortal definition
+end
+end
+
+NGINX Declarative API Core ->>+ NGINX Instance Manager: Publish staged config to instance group
 NGINX Instance Manager ->> NGINX: Publish config to NGINX instances
+NGINX Instance Manager ->>- NGINX Declarative API Core: Publish outcome
+
+Note over NGINX Declarative API Core, Redis: data synchronization
+
+end
 ```
 
 ## Input formats

USAGE-v3.md

@@ -1,7 +1,7 @@
 # Usage for API v3
 
 Version 3 API requires:
-- NGINX Instance Manager 2.10.0+
+- NGINX Instance Manager 2.14+
 - NGINX Plus R30+
 
 If NGINX App Protect declarations are used:
@@ -430,4 +430,4 @@ A declaration example (to be POSTed to /v3/config) is:
         }
     }
 }
-```
+```