mirror of
https://github.com/KumoCorp/kumomta.git
synced 2026-11-17 16:07:41 +00:00
The documentation generators now stamp each page they emit with an @generated comment so that tooling can tell generated pages apart from hand-written ones. Update the table-of-contents generator to skip YAML front matter when picking a page title, since the marker is now stored there.
34 lines
759 B
Markdown
34 lines
759 B
Markdown
---
|
|
# @generated by jsonschematodocs from docs/reference/proxy-server.openapi.json
|
|
tags:
|
|
- status
|
|
---
|
|
# GET /proxy/status
|
|
|
|
|
|
!!! info
|
|
This page was generated by extracting information from a JSON Schema
|
|
data file for the API. It may be missing some information, or otherwise
|
|
suggest approximate or placeholder values based on information in the
|
|
schema file; this is due to limitations on how that data is extracted
|
|
from the underlying Rust code and into the JSON Schema, and then again
|
|
from there and into these docs.
|
|
|
|
Simple health check endpoint for the proxy.
|
|
Returns basic status information.
|
|
|
|
## Responses
|
|
### Status 200
|
|
Proxy is healthy
|
|
|
|
|
|
`Content-Type: text/plain`
|
|
|
|
|
|
This is a string value.
|
|
|
|
### Examples
|
|
```json
|
|
"string"
|
|
```
|