[PR #4087] [MERGED] add simple descriptions for swagger validate #17235

New Issue

GiteaMirror · 2025-11-02T12:30:27-06:00

GiteaMirror commented

2025-11-02 12:30:27 -06:00

📋 Pull Request Information

Original PR: https://github.com/go-gitea/gitea/pull/4087
Author: @stevegt
Created: 5/30/2018
Status: ✅ Merged
Merged: 5/31/2018
Merged by: @lunny

Base: master ← Head: swagger-descriptions

📝 Commits (2)

ee67d05 add simple descriptions for swagger validate
f615e8a Merge branch 'master' into swagger-descriptions

📊 Changes

8 files changed (+82 additions, -0 deletions)

View changed files

📝 public/swagger.v1.json (+41 -0)
📝 routers/api/v1/swagger/issue.go (+10 -0)
📝 routers/api/v1/swagger/key.go (+6 -0)
📝 routers/api/v1/swagger/misc.go (+1 -0)
📝 routers/api/v1/swagger/options.go (+1 -0)
📝 routers/api/v1/swagger/org.go (+4 -0)
📝 routers/api/v1/swagger/repo.go (+16 -0)
📝 routers/api/v1/swagger/user.go (+3 -0)

📄 Description

Partial fix for API: GET/SET/DEL attachment on comment (#4010)

Swagger needs a comment line above each swagger:response comment -- it
uses these to populate the description: fields. Adding minimal text
for now on the way to getting swagger validate to pass. Many standard
swagger client libraries will not work with gitea until validate passes,
so prioritizing that over better descriptions for now.

Signed-off-by: Steve Traugott stevegt@t7a.org

_{🔄 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-gitea/gitea/pull/4087 **Author:** [@stevegt](https://github.com/stevegt) **Created:** 5/30/2018 **Status:** ✅ Merged **Merged:** 5/31/2018 **Merged by:** [@lunny](https://github.com/lunny) **Base:** `master` ← **Head:** `swagger-descriptions` --- ### 📝 Commits (2) - [`ee67d05`](https://github.com/go-gitea/gitea/commit/ee67d054268afa72f382185440f8903c885bef44) add simple descriptions for swagger validate - [`f615e8a`](https://github.com/go-gitea/gitea/commit/f615e8a6a8e3b9f2a0205ca46cb36e50931628a1) Merge branch 'master' into swagger-descriptions ### 📊 Changes **8 files changed** (+82 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `public/swagger.v1.json` (+41 -0) 📝 `routers/api/v1/swagger/issue.go` (+10 -0) 📝 `routers/api/v1/swagger/key.go` (+6 -0) 📝 `routers/api/v1/swagger/misc.go` (+1 -0) 📝 `routers/api/v1/swagger/options.go` (+1 -0) 📝 `routers/api/v1/swagger/org.go` (+4 -0) 📝 `routers/api/v1/swagger/repo.go` (+16 -0) 📝 `routers/api/v1/swagger/user.go` (+3 -0) </details> ### 📄 Description * Partial fix for #4010 Swagger needs a comment line above each swagger:response comment -- it uses these to populate the description: fields. Adding minimal text for now on the way to getting swagger validate to pass. Many standard swagger client libraries will not work with gitea until validate passes, so prioritizing that over better descriptions for now. Signed-off-by: Steve Traugott <stevegt@t7a.org> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the pull-request label 2025-11-02 12:30:27 -06:00

GiteaMirror closed this issue

2025-11-02 12:30:27 -06:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/gitea#17235