From a06550a90fc4bfe1f6d59dc24fed44cbeb02f010 Mon Sep 17 00:00:00 2001 From: binwiederhier Date: Tue, 20 Jan 2026 17:13:50 -0500 Subject: [PATCH] Refine open API docs --- docs/api.md | 44 - docs/api/{scalar.html => index.html} | 132 +- docs/api/openapi.yaml | 1248 +- docs/api/scalar-standalone.js | 35987 +++++++++++++++++++++++++ docs/api/scalar-style.css | 11911 ++++++++ mkdocs.yml | 3 +- 6 files changed, 48437 insertions(+), 888 deletions(-) delete mode 100644 docs/api.md rename docs/api/{scalar.html => index.html} (52%) create mode 100644 docs/api/scalar-standalone.js create mode 100644 docs/api/scalar-style.css diff --git a/docs/api.md b/docs/api.md deleted file mode 100644 index 8d8f4864..00000000 --- a/docs/api.md +++ /dev/null @@ -1,44 +0,0 @@ -# API Reference - -This page contains the interactive API documentation for ntfy. You can try out the API endpoints directly from this page. - -## Using the API Documentation - -### Server Selection - -The API reference includes a server selector dropdown at the top of the page. By default, it's configured to use the **public ntfy.sh server**. - -To use your own ntfy instance, edit `docs/api/openapi.yaml` and add your server URL to the `servers` section: - -```yaml -servers: - - url: https://ntfy.sh - description: Public ntfy server - - url: https://your-ntfy-instance.com - description: Your custom server -``` - -After editing the file, rebuild the docs with `mkdocs build`. - -### Authentication - -Click the **Authorize** button (lock icon) in the API reference to add your access token. Use the format `Bearer ` or `Basic `. - -### Try It Out - -Click **Try it out** on any endpoint to test it directly. Parameters will be empty by default - enter your own values to test. - ---- - - - -If you are not redirected automatically, [click here to view the API Reference](api/scalar.html). \ No newline at end of file diff --git a/docs/api/scalar.html b/docs/api/index.html similarity index 52% rename from docs/api/scalar.html rename to docs/api/index.html index b44069e4..6c28a816 100644 --- a/docs/api/scalar.html +++ b/docs/api/index.html @@ -4,7 +4,7 @@ ntfy API Reference - +