GITBOOK-2: Start describe models

Pavlusha311245 · gitbook-bot · commit 44a74628d95b · 2023-07-14T15:46:32.000Z
diff --git a/docs/README.md b/docs/README.md
@@ -1,21 +1,25 @@
+---
+coverY: 0
+---
+
 # Welcome!
 
 ## About project
 
 This project allows developers to interact with the Nginx Unit web server through php classes
 
-## Want to jump right in?
+## Want to start?
 
-Feeling like an eager beaver? Jump in to the quick start docs and get making your first request:
+You can easy start work with SDK with Quick start guide below:
 
-{% content-ref url="quick-start.md" %}
-[quick-start.md](quick-start.md)
+{% content-ref url="quick-start-in-development.md" %}
+[quick-start-in-development.md](quick-start-in-development.md)
 {% endcontent-ref %}
 
-## Want to deep dive?
+## Want to learn SDK deeper?
 
-Dive a little deeper and start exploring our API reference to get an idea of everything that's possible with the API:
+Dive a deeper and start exploring our SDK API reference:
 
-{% content-ref url="reference/api-reference.md" %}
-[api-reference.md](reference/api-reference.md)
+{% content-ref url="reference/api-reference/" %}
+[api-reference](reference/api-reference/)
 {% endcontent-ref %}
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -1,8 +1,15 @@
 # Table of contents
 
 * [Welcome!](README.md)
-* [Quick Start](quick-start.md)
+* [Quick Start (In development)](quick-start-in-development.md)
 
 ## Reference
 
-* [API Reference](reference/api-reference.md)
+* [API Reference](reference/api-reference/README.md)
+  * [Unit](reference/api-reference/unit.md)
+  * [Statistics](reference/api-reference/statistics.md)
+  * [Config (In development)](reference/api-reference/config-in-development.md)
+  * [Certificates (In development)](reference/api-reference/certificates-in-development.md)
+  * [Listeners (In development)](reference/api-reference/listeners-in-development.md)
+  * [Routes (In development)](reference/api-reference/routes-in-development.md)
+  * [Applications (In development)](reference/api-reference/applications-in-development.md)
diff --git a/docs/quick-start-in-development.md b/docs/quick-start-in-development.md
@@ -0,0 +1,2 @@
+# Quick Start (In development)
+
diff --git a/docs/quick-start.md b/docs/quick-start.md
diff --git a/docs/reference/api-reference/README.md b/docs/reference/api-reference/README.md
diff --git a/docs/reference/api-reference/applications-in-development.md b/docs/reference/api-reference/applications-in-development.md
@@ -0,0 +1,2 @@
+# Applications (In development)
+
diff --git a/docs/reference/api-reference/certificates-in-development.md b/docs/reference/api-reference/certificates-in-development.md
@@ -0,0 +1,2 @@
+# Certificates (In development)
+
diff --git a/docs/reference/api-reference/config-in-development.md b/docs/reference/api-reference/config-in-development.md
@@ -0,0 +1,2 @@
+# Config (In development)
+
diff --git a/docs/reference/api-reference/listeners-in-development.md b/docs/reference/api-reference/listeners-in-development.md
@@ -0,0 +1,2 @@
+# Listeners (In development)
+
diff --git a/docs/reference/api-reference/routes-in-development.md b/docs/reference/api-reference/routes-in-development.md
@@ -0,0 +1,2 @@
+# Routes (In development)
+
diff --git a/docs/reference/api-reference/statistics.md b/docs/reference/api-reference/statistics.md
@@ -0,0 +1,39 @@
+---
+description: This class returns statistics from Nginx Unit
+---
+
+# Statistics
+
+## Properties:
+
+### $\_connections (Private)
+
+Contains array of values
+
+### $\_requests (Private)
+
+Contains array of values
+
+### $\_applications (Private)
+
+Contains array of values
+
+## Methods:
+
+### `getConnections()`
+
+Lists per-instance connection statistics
+
+_Return type: Array_
+
+### `getRequests()`
+
+Lists per-instance request statistics
+
+_Return type: Array_
+
+### `getApplications()`
+
+Each option item lists per-app process and request statistics
+
+_Return type: Array_
diff --git a/docs/reference/api-reference/unit.md b/docs/reference/api-reference/unit.md
@@ -0,0 +1,13 @@
+# Unit
+
+## Methods:
+
+### `getConfig()`
+
+### `getStatistics()`
+
+### `getCertificates()`
+
+### `getSocket()`
+
+### `getAddress()`

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# Applications (In development)`
	`2`	`+`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# Certificates (In development)`
	`2`	`+`