Added the initial version of the OpenAPI specification.
This commit is contained in:
22
README.md
22
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
|
is intended as a universal building block for any web architecture regardless
|
||||||
of its complexity, from enterprise-scale deployments to your pet's homepage.
|
of its complexity, from enterprise-scale deployments to your pet's homepage.
|
||||||
|
|
||||||
Its native RESTful JSON API enables dynamic updates with zero interruptions
|
Its native [RESTful JSON API][#openapi-specification] enables dynamic
|
||||||
and flexible configuration, while its out-of-the-box productivity reliably
|
updates with zero interruptions and flexible configuration, while its
|
||||||
scales to production-grade workloads. We achieve that with a complex,
|
out-of-the-box productivity reliably scales to production-grade workloads. We
|
||||||
asynchronous, multithreading architecture comprising multiple processes to
|
achieve that with a complex, asynchronous, multithreading architecture
|
||||||
ensure security and robustness while getting the most out of today's computing
|
comprising multiple processes to ensure security and robustness while getting
|
||||||
platforms.
|
the most out of today's computing platforms.
|
||||||
|
|
||||||
|
|
||||||
## Quick Installation
|
## Quick Installation
|
||||||
@@ -156,6 +156,16 @@ Unit's output should contain both snippets, neatly organized:
|
|||||||
For full details of configuration management, see the
|
For full details of configuration management, see the
|
||||||
[docs](https://unit.nginx.org/configuration/#configuration-management).
|
[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
|
## Community
|
||||||
|
|
||||||
|
|||||||
6334
docs/unit-openapi.yaml
Normal file
6334
docs/unit-openapi.yaml
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user