[PR #4089] [MERGED] add simple descriptions for file API responses #17236

Closed
opened 2025-11-02 12:30:28 -06:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/go-gitea/gitea/pull/4089
Author: @stevegt
Created: 5/30/2018
Status: Merged
Merged: 6/1/2018
Merged by: @lunny

Base: masterHead: fix-api-200s


📝 Commits (3)

  • 3a28581 add simple descriptions for file API responses
  • 16dbfa3 Merge branch 'master' into fix-api-200s
  • 3a0e0ab Merge branch 'master' into fix-api-200s

📊 Changes

2 files changed (+15 additions, -6 deletions)

View changed files

📝 public/swagger.v1.json (+9 -3)
📝 routers/api/v1/repo/file.go (+6 -3)

📄 Description

Swagger needs a description field in each swagger:operation response. 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/4089 **Author:** [@stevegt](https://github.com/stevegt) **Created:** 5/30/2018 **Status:** ✅ Merged **Merged:** 6/1/2018 **Merged by:** [@lunny](https://github.com/lunny) **Base:** `master` ← **Head:** `fix-api-200s` --- ### 📝 Commits (3) - [`3a28581`](https://github.com/go-gitea/gitea/commit/3a285816f9425d0c1f564c14c48af31c4baa55a5) add simple descriptions for file API responses - [`16dbfa3`](https://github.com/go-gitea/gitea/commit/16dbfa350679f9ac2bf7d86021020ca614df6cd8) Merge branch 'master' into fix-api-200s - [`3a0e0ab`](https://github.com/go-gitea/gitea/commit/3a0e0abfe6ce4afddcaada266d77ae733f111b73) Merge branch 'master' into fix-api-200s ### 📊 Changes **2 files changed** (+15 additions, -6 deletions) <details> <summary>View changed files</summary> 📝 `public/swagger.v1.json` (+9 -3) 📝 `routers/api/v1/repo/file.go` (+6 -3) </details> ### 📄 Description * Partial fix for #4010 Swagger needs a description field in each swagger:operation response. 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:28 -06:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/gitea#17236