[PR #1560] WIP: Scalar Open API docs #1643

New issue

Open

opened 2026-05-07 01:03:03 +02:00 by BreizhHardware · 0 comments

BreizhHardware commented

2026-05-07 01:03:03 +02:00

Owner

📋 Pull Request Information

Original PR: https://github.com/binwiederhier/ntfy/pull/1560
Author: @binwiederhier
Created: 1/20/2026
Status: 🔄 Open

Base: main ← Head: scalar-api-docs

📝 Commits (6)

0ae2ca4 Added Openapi spec/swagger UI - added swagger to python requirements.txt
854aa1f Convert from swagger to API docs.
d2e0588 Merge branch 'main' of github.com:binwiederhier/ntfy into gitglubber/main
a06550a Refine open API docs
27bce6f Merge branch 'main' of github.com:binwiederhier/ntfy into scalar-api-docs
3619c80 Documentation

📊 Changes

5 files changed (+50461 additions, -0 deletions)

View changed files

➕ docs/api/index.html (+192 -0)
➕ docs/api/openapi.yaml (+2370 -0)
➕ docs/api/scalar-standalone.js (+35987 -0)
➕ docs/api/scalar-style.css (+11911 -0)
📝 mkdocs.yml (+1 -0)

📄 Description

Supersedes https://github.com/binwiederhier/ntfy/pull/1543

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/binwiederhier/ntfy/pull/1560 **Author:** [@binwiederhier](https://github.com/binwiederhier) **Created:** 1/20/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `scalar-api-docs` --- ### 📝 Commits (6) - [`0ae2ca4`](https://github.com/binwiederhier/ntfy/commit/0ae2ca43bd6e2034d4dcd11e172d19d1c834404c) Added Openapi spec/swagger UI - added swagger to python requirements.txt - [`854aa1f`](https://github.com/binwiederhier/ntfy/commit/854aa1f783a6115c291e4c1c4f255e378e8954bb) Convert from swagger to API docs. - [`d2e0588`](https://github.com/binwiederhier/ntfy/commit/d2e0588037b6d50dbe76683d20e5a4c7e167dfc1) Merge branch 'main' of github.com:binwiederhier/ntfy into gitglubber/main - [`a06550a`](https://github.com/binwiederhier/ntfy/commit/a06550a90fc4bfe1f6d59dc24fed44cbeb02f010) Refine open API docs - [`27bce6f`](https://github.com/binwiederhier/ntfy/commit/27bce6f4d1eb763f89ddca07dd0977f585b359a3) Merge branch 'main' of github.com:binwiederhier/ntfy into scalar-api-docs - [`3619c80`](https://github.com/binwiederhier/ntfy/commit/3619c805447b0145fb9ccff66eb71be4596f87ed) Documentation ### 📊 Changes **5 files changed** (+50461 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `docs/api/index.html` (+192 -0) ➕ `docs/api/openapi.yaml` (+2370 -0) ➕ `docs/api/scalar-standalone.js` (+35987 -0) ➕ `docs/api/scalar-style.css` (+11911 -0) 📝 `mkdocs.yml` (+1 -0) </details> ### 📄 Description Supersedes https://github.com/binwiederhier/ntfy/pull/1543 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>