summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorArtem Konev <artem.konev@nginx.com>2023-05-10 20:57:42 +0100
committerArtem Konev <artem.konev@nginx.com>2023-05-10 20:57:42 +0100
commit51de0db7f565afa8f808100e4c88ebd654ec2268 (patch)
tree71de1157f14080516cbb2f939d959eba19966a3b /README.md
parentfaf97dc06058de1c929af33a68adb34d3932b374 (diff)
downloadunit-51de0db7f565afa8f808100e4c88ebd654ec2268.tar.gz
unit-51de0db7f565afa8f808100e4c88ebd654ec2268.tar.bz2
Added the initial version of the OpenAPI specification.
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 16 insertions, 6 deletions
diff --git a/README.md b/README.md
index abe6ffba..8bceb40c 100644
--- a/README.md
+++ b/README.md
@@ -15,12 +15,12 @@ coherent solution with a focus on performance, low latency, and scalability. It
is intended as a universal building block for any web architecture regardless
of its complexity, from enterprise-scale deployments to your pet's homepage.
-Its native RESTful JSON API enables dynamic updates with zero interruptions
-and flexible configuration, while its out-of-the-box productivity reliably
-scales to production-grade workloads. We achieve that with a complex,
-asynchronous, multithreading architecture comprising multiple processes to
-ensure security and robustness while getting the most out of today's computing
-platforms.
+Its native [RESTful JSON API][#openapi-specification] enables dynamic
+updates with zero interruptions and flexible configuration, while its
+out-of-the-box productivity reliably scales to production-grade workloads. We
+achieve that with a complex, asynchronous, multithreading architecture
+comprising multiple processes to ensure security and robustness while getting
+the most out of today's computing platforms.
## Quick Installation
@@ -156,6 +156,16 @@ Unit's output should contain both snippets, neatly organized:
For full details of configuration management, see the
[docs](https://unit.nginx.org/configuration/#configuration-management).
+## OpenAPI Specification
+
+Our [OpenAPI specification](docs/openapi.yaml) aims to simplify configuring and
+integrating NGINX Unit deployments and provide an authoritative source of
+knowledge about the control API.
+
+Although the specification is still in the early beta stage, it is a promising
+step forward for the NGINX Unit community. While working on it, we kindly ask
+you to experiment and provide feedback to help improve its functionality and
+usability.
## Community