[PR #666] [MERGED] Swagger improvements #721

New issue

Closed

opened 2026-02-25 23:35:15 +03:00 by kerem · 0 comments

kerem commented

2026-02-25 23:35:15 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/go-shiori/shiori/pull/666
Author: @fmartingr
Created: 7/21/2023
Status: ✅ Merged
Merged: 8/12/2023
Merged by: @fmartingr

Base: master ← Head: fmartingr/issue665

📝 Commits (10+)

1e357b3 refactor: swagger docs into a folder
e455728 added scripts for the swaggger tasks
f882608 check version and fmt
5d20fc3 CI
f9638d9 formatted swag comments
5b9fb50 using custom delims
33caaf3 revert custom delims
acf73d4 swag 1.16.1
1588fc5 update swagger docs
ceadffd avoid make swagger output

📊 Changes

12 files changed (+160 additions, -59 deletions)

View changed files

➕ .github/workflows/_swagger-check.yml (+21 -0)
📝 .github/workflows/pull_request.yml (+3 -1)
📝 Makefile (+20 -3)
📝 docs/Contribute.md (+1 -1)
📝 docs/swagger/docs.go (+14 -6)
📝 docs/swagger/swagger.json (+13 -5)
📝 docs/swagger/swagger.yaml (+11 -5)
📝 internal/http/routes/api/v1/auth.go (+25 -22)
📝 internal/http/routes/api/v1/tags.go (+15 -15)
📝 internal/http/routes/swagger.go (+1 -1)
➕ scripts/swagger.sh (+4 -0)
➕ scripts/swagger_check.sh (+32 -0)

📄 Description

Swagger documentation in its own folder
Added QoL Makefile action to check if the swagger docs is outdated
Added QoL Makefile action to format swag comments
Added Github Workflow to check if the swagger documentation is formatted and updated

Fixes #665

_{🔄 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/go-shiori/shiori/pull/666 **Author:** [@fmartingr](https://github.com/fmartingr) **Created:** 7/21/2023 **Status:** ✅ Merged **Merged:** 8/12/2023 **Merged by:** [@fmartingr](https://github.com/fmartingr) **Base:** `master` ← **Head:** `fmartingr/issue665` --- ### 📝 Commits (10+) - [`1e357b3`](https://github.com/go-shiori/shiori/commit/1e357b3937548d1d42247b65d84bbe71a02742a6) refactor: swagger docs into a folder - [`e455728`](https://github.com/go-shiori/shiori/commit/e45572816fbf4170278b66bc31fb9a5c82de9905) added scripts for the swaggger tasks - [`f882608`](https://github.com/go-shiori/shiori/commit/f882608d3d24c639e6093654a9e249e6bc5ca104) check version and fmt - [`5d20fc3`](https://github.com/go-shiori/shiori/commit/5d20fc39537232bbb756f579429d70c607d60650) CI - [`f9638d9`](https://github.com/go-shiori/shiori/commit/f9638d910e117051f07404083aba4ec577efba81) formatted swag comments - [`5b9fb50`](https://github.com/go-shiori/shiori/commit/5b9fb50be3e4380c80cc9e6d5648947302e32b52) using custom delims - [`33caaf3`](https://github.com/go-shiori/shiori/commit/33caaf37fa47ad2cd4283ec07192e397331dc2ce) revert custom delims - [`acf73d4`](https://github.com/go-shiori/shiori/commit/acf73d414f99db7ac5f4d1034b48f7b8b2578a86) swag 1.16.1 - [`1588fc5`](https://github.com/go-shiori/shiori/commit/1588fc514aea29a310e490f38cbc8c70a2af4ff9) update swagger docs - [`ceadffd`](https://github.com/go-shiori/shiori/commit/ceadffd2639a562fbafda33203358cd40edcbe1c) avoid make swagger output ### 📊 Changes **12 files changed** (+160 additions, -59 deletions) <details> <summary>View changed files</summary> ➕ `.github/workflows/_swagger-check.yml` (+21 -0) 📝 `.github/workflows/pull_request.yml` (+3 -1) 📝 `Makefile` (+20 -3) 📝 `docs/Contribute.md` (+1 -1) 📝 `docs/swagger/docs.go` (+14 -6) 📝 `docs/swagger/swagger.json` (+13 -5) 📝 `docs/swagger/swagger.yaml` (+11 -5) 📝 `internal/http/routes/api/v1/auth.go` (+25 -22) 📝 `internal/http/routes/api/v1/tags.go` (+15 -15) 📝 `internal/http/routes/swagger.go` (+1 -1) ➕ `scripts/swagger.sh` (+4 -0) ➕ `scripts/swagger_check.sh` (+32 -0) </details> ### 📄 Description - Swagger documentation in its own folder - Added QoL Makefile action to check if the swagger docs is outdated - Added QoL Makefile action to format swag comments - Added Github Workflow to check if the swagger documentation is formatted and updated Fixes #665 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>