[PR #1543] [CLOSED] Added OpenAPI spec /Swagger integration into mkdocs. #1639

New issue

Closed

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

BreizhHardware commented

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

Owner

📋 Pull Request Information

Original PR: https://github.com/binwiederhier/ntfy/pull/1543
Author: @gitglubber
Created: 1/12/2026
Status: ❌ Closed

Base: main ← Head: main

📝 Commits (2)

0ae2ca4 Added Openapi spec/swagger UI - added swagger to python requirements.txt
854aa1f Convert from swagger to API docs.

📊 Changes

4 files changed (+2903 additions, -0 deletions)

View changed files

➕ docs/api.md (+44 -0)
➕ docs/api/openapi.yaml (+2597 -0)
➕ docs/api/scalar.html (+260 -0)
📝 mkdocs.yml (+2 -0)

📄 Description

This adds a documented swagger API page to the ntfy mkdocs pages under "API Reference".

I added ALL to the spec to be thorough - some of them are insignificant and wont properly function in the Swagger page (i.e. the HEAD queries) but they are there for the sake of transparency.

_{🔄 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/1543 **Author:** [@gitglubber](https://github.com/gitglubber) **Created:** 1/12/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `main` --- ### 📝 Commits (2) - [`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. ### 📊 Changes **4 files changed** (+2903 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `docs/api.md` (+44 -0) ➕ `docs/api/openapi.yaml` (+2597 -0) ➕ `docs/api/scalar.html` (+260 -0) 📝 `mkdocs.yml` (+2 -0) </details> ### 📄 Description This adds a documented swagger API page to the ntfy mkdocs pages under "API Reference". I added **ALL** to the spec to be thorough - some of them are insignificant and wont properly function in the Swagger page (i.e. the HEAD queries) but they are there for the sake of transparency. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>