54 lines
1.7 KiB
Markdown
54 lines
1.7 KiB
Markdown
# Rust API client for agent_client
|
|
|
|
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
|
|
|
|
## Overview
|
|
|
|
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
|
|
|
|
- API version: 0.1.0
|
|
- Package version: 0.1.0
|
|
- Generator version: 7.18.0
|
|
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`
|
|
|
|
## Installation
|
|
|
|
Put the package under your project folder in a directory named `agent_client` and add the following to `Cargo.toml` under `[dependencies]`:
|
|
|
|
```
|
|
agent_client = { path = "./agent_client" }
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *http://localhost*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*NginxAgentApi* | [**status**](docs/NginxAgentApi.md#status) | **GET** /status | Health check endpoint
|
|
*NginxAgentApi* | [**validate**](docs/NginxAgentApi.md#validate) | **POST** /validate |
|
|
*NginxAgentApi* | [**validate_and_reload**](docs/NginxAgentApi.md#validate_and_reload) | **POST** /validate_and_reload |
|
|
*NginxAgentApi* | [**write_config**](docs/NginxAgentApi.md#write_config) | **POST** /write_config |
|
|
|
|
|
|
## Documentation For Models
|
|
|
|
- [StatusResp](docs/StatusResp.md)
|
|
- [ValidateAndReloadBody](docs/ValidateAndReloadBody.md)
|
|
- [ValidateAndReloadResp](docs/ValidateAndReloadResp.md)
|
|
- [ValidateBody](docs/ValidateBody.md)
|
|
- [WriteConfigBody](docs/WriteConfigBody.md)
|
|
|
|
|
|
To get access to the crate's generated documentation, use:
|
|
|
|
```
|
|
cargo doc --open
|
|
```
|
|
|
|
## Author
|
|
|
|
|
|
|