github-starred/gitea
2
0
Fork 0
mirror of https://github.com/go-gitea/gitea.git synced 2026-03-12 18:48:08 -05:00
Code Issues 2.6k Packages Projects Releases 100 Wiki Activity

[PR #1402] [MERGED] Generate swagger json #15893

New Issue
Closed
opened 2025-11-02 11:57:05 -06:00 by GiteaMirror · 0 comments
GiteaMirror commented 2025-11-02 11:57:05 -06:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/go-gitea/gitea/pull/1402
Author: @sapk
Created: 3/28/2017
Status: ✅ Merged
Merged: 5/2/2017
Merged by: @bkcsoft

Base: master ← Head: generate-swagger

📝 Commits (4)

📊 Changes

42 files changed (+2358 additions, -63 deletions)

View changed files

📝 Makefile (+11 -0)
📝 models/repo_list.go (+20 -9)
📝 modules/context/api.go (+31 -3)
➕ public/assets/swagger-ui/favicon-16x16.png (+0 -0)
➕ public/assets/swagger-ui/favicon-32x32.png (+0 -0)
➕ public/assets/swagger-ui/index.html (+93 -0)
➕ public/assets/swagger-ui/oauth2-redirect.html (+83 -0)
➕ public/assets/swagger-ui/swagger-ui-bundle.js (+105 -0)
➕ public/assets/swagger-ui/swagger-ui-bundle.js.map (+1 -0)
➕ public/assets/swagger-ui/swagger-ui-standalone-preset.js (+8 -0)
➕ public/assets/swagger-ui/swagger-ui-standalone-preset.js.map (+1 -0)
➕ public/assets/swagger-ui/swagger-ui.css (+2 -0)
➕ public/assets/swagger-ui/swagger-ui.css.map (+1 -0)
➕ public/assets/swagger-ui/swagger-ui.js (+15 -0)
➕ public/assets/swagger-ui/swagger-ui.js.map (+1 -0)
➕ public/swagger.v1.json (+1290 -0)
📝 routers/api/v1/api.go (+25 -0)
📝 routers/api/v1/misc/markdown.go (+23 -2)
📝 routers/api/v1/misc/version.go (+12 -0)
📝 routers/api/v1/repo/hook.go (+42 -3)

...and 22 more files

📄 Description

Use https://github.com/go-swagger/go-swagger with go generate to (auto-)build public/swagger.json

Related : #194 go-gitea/go-sdk#53

I will fill missing API descriptions. For the responses descriptions, tags must be add to sdk repo (so in a other PR).

You can test rendering at http://editor.swagger.io and copy-paste swagger.json.

Documented API :
  • GET /version (getVersion)
  • POST /markdown (renderMarkdown)
  • POST /markdown/raw (renderMarkdownRaw)
  • GET /users/search (userSearch)
  • GET /users/:username (userGet)
  • GET /user (userGetCurrent)
  • GET /users/:username/tokens (userGetTokens)
  • POST /users/:username/tokens (userCreateToken)
  • GET /users/:username/repos (userListRepos)
  • GET /user/repos (userCurrentListRepos)
  • GET /user/keys userCurrentListKeys
  • GET /users/:username/keys userListKeys
  • GET /user/keys/:id userCurrentGetKey
  • POST /user/keys userCurrentPostKey
  • DELETE /user/keys/:id userCurrentDeleteKey
  • GET /user/gpg_keys userCurrentListGPGKeys
  • GET /users/:username/gpg_keys userListGPGKeys
  • GET /user/gpg_keys/:id userCurrentGetGPGKey
  • POST /user/gpg_keys userCurrentPostGPGKey
  • DELETE /user/gpg_keys/:id userCurrentDeleteGPGKey
  • GET /user/followers userCurrentListFollowers
  • GET /users/:username/followers userListFollowers
  • GET /user/following userCurrentListFollowing
  • GET /users/:username/following userListFollowing
  • GET /user/following/:username userCurrentCheckFollowing
  • GET /users/:username/following/:target userCheckFollowing
  • PUT /user/following/:username userCurrentPutFollow
  • DELETE /user/following/:username userCurrentDeleteFollow
  • GET /users/:username/starred userListStarred
  • GET /user/starred userCurrentListStarred
  • GET /user/starred/:username/:reponame userCurrentCheckStarring
  • PUT /user/starred/:username/:reponame userCurrentPutStar
  • DELETE /user/starred/:username/:reponame userCurrentDeleteStar
  • GET /users/:username/subscriptions userListSubscriptions
  • GET /user/subscriptions userCurrentListSubscriptions
  • GET /repos/:username/:reponame/subscription userCurrentCheckSubscription
  • PUT /repos/:username/:reponame/subscription userCurrentPutSubscription
  • DELETE /repos/:username/:reponame/subscription userCurrentDeleteSubscription
  • POST /org/:org/repos createOrgRepo
  • ..

🔄 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/1402 **Author:** [@sapk](https://github.com/sapk) **Created:** 3/28/2017 **Status:** ✅ Merged **Merged:** 5/2/2017 **Merged by:** [@bkcsoft](https://github.com/bkcsoft) **Base:** `master` ← **Head:** `generate-swagger` --- ### 📝 Commits (4) - [`a1a7581`](https://github.com/go-gitea/gitea/commit/a1a758168be7bb81aa9d6efcab83925d23441c66) Testing Swagger generation - [`7b895fe`](https://github.com/go-gitea/gitea/commit/7b895fecc1b0b45de8fc63b1b7afe70582de361e) Fully working base - [`044f055`](https://github.com/go-gitea/gitea/commit/044f055a44c43be2230c733fe6e53b28f1764bfa) Remove old link to gogs api docs - [`e39985f`](https://github.com/go-gitea/gitea/commit/e39985f3103b38597372632c4cd5209daa8e3bbe) Going back to code.gitea.io/sdk/gitea since go-gitea/go-sdk#53 is merged ### 📊 Changes **42 files changed** (+2358 additions, -63 deletions) <details> <summary>View changed files</summary> 📝 `Makefile` (+11 -0) 📝 `models/repo_list.go` (+20 -9) 📝 `modules/context/api.go` (+31 -3) ➕ `public/assets/swagger-ui/favicon-16x16.png` (+0 -0) ➕ `public/assets/swagger-ui/favicon-32x32.png` (+0 -0) ➕ `public/assets/swagger-ui/index.html` (+93 -0) ➕ `public/assets/swagger-ui/oauth2-redirect.html` (+83 -0) ➕ `public/assets/swagger-ui/swagger-ui-bundle.js` (+105 -0) ➕ `public/assets/swagger-ui/swagger-ui-bundle.js.map` (+1 -0) ➕ `public/assets/swagger-ui/swagger-ui-standalone-preset.js` (+8 -0) ➕ `public/assets/swagger-ui/swagger-ui-standalone-preset.js.map` (+1 -0) ➕ `public/assets/swagger-ui/swagger-ui.css` (+2 -0) ➕ `public/assets/swagger-ui/swagger-ui.css.map` (+1 -0) ➕ `public/assets/swagger-ui/swagger-ui.js` (+15 -0) ➕ `public/assets/swagger-ui/swagger-ui.js.map` (+1 -0) ➕ `public/swagger.v1.json` (+1290 -0) 📝 `routers/api/v1/api.go` (+25 -0) 📝 `routers/api/v1/misc/markdown.go` (+23 -2) 📝 `routers/api/v1/misc/version.go` (+12 -0) 📝 `routers/api/v1/repo/hook.go` (+42 -3) _...and 22 more files_ </details> ### 📄 Description Use https://github.com/go-swagger/go-swagger with go generate to (auto-)build public/swagger.json Related : #194 go-gitea/go-sdk#53 I will fill missing API descriptions. For the responses descriptions, tags must be add to sdk repo (so in a other PR). You can test rendering at http://editor.swagger.io and copy-paste swagger.json. <details> <summary>Documented API : </summary> - [X] GET /version (getVersion) - [x] POST /markdown (renderMarkdown) - [x] POST /markdown/raw (renderMarkdownRaw) - [x] GET /users/search (userSearch) - [x] GET /users/:username (userGet) - [x] GET /user (userGetCurrent) - [x] GET /users/:username/tokens (userGetTokens) - [x] POST /users/:username/tokens (userCreateToken) - [x] GET /users/:username/repos (userListRepos) - [x] GET /user/repos (userCurrentListRepos) - [x] GET /user/keys userCurrentListKeys - [x] GET /users/:username/keys userListKeys - [x] GET /user/keys/:id userCurrentGetKey - [x] POST /user/keys userCurrentPostKey - [x] DELETE /user/keys/:id userCurrentDeleteKey - [x] GET /user/gpg_keys userCurrentListGPGKeys - [x] GET /users/:username/gpg_keys userListGPGKeys - [x] GET /user/gpg_keys/:id userCurrentGetGPGKey - [x] POST /user/gpg_keys userCurrentPostGPGKey - [x] DELETE /user/gpg_keys/:id userCurrentDeleteGPGKey - [x] GET /user/followers userCurrentListFollowers - [x] GET /users/:username/followers userListFollowers - [x] GET /user/following userCurrentListFollowing - [x] GET /users/:username/following userListFollowing - [x] GET /user/following/:username userCurrentCheckFollowing - [x] GET /users/:username/following/:target userCheckFollowing - [x] PUT /user/following/:username userCurrentPutFollow - [x] DELETE /user/following/:username userCurrentDeleteFollow - [x] GET /users/:username/starred userListStarred - [x] GET /user/starred userCurrentListStarred - [x] GET /user/starred/:username/:reponame userCurrentCheckStarring - [x] PUT /user/starred/:username/:reponame userCurrentPutStar - [x] DELETE /user/starred/:username/:reponame userCurrentDeleteStar - [x] GET /users/:username/subscriptions userListSubscriptions - [x] GET /user/subscriptions userCurrentListSubscriptions - [x] GET /repos/:username/:reponame/subscription userCurrentCheckSubscription - [x] PUT /repos/:username/:reponame/subscription userCurrentPutSubscription - [x] DELETE /repos/:username/:reponame/subscription userCurrentDeleteSubscription - [x] POST /org/:org/repos createOrgRepo - .. </details> --- <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 11:57:05 -06:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
$20
$250
$50
$500
backport/done
💎 Bounty
docs-update-needed
good first issue
hacktoberfest
issue/bounty
issue/confirmed
issue/critical
issue/duplicate
issue/needs-feedback
issue/not-a-bug
issue/regression
issue/stale
issue/workaround
lgtm/need 2
modifies/api
modifies/translation
outdated/backport/v1.18
outdated/theme/markdown
outdated/theme/timetracker
performance/bigrepo
performance/cpu
performance/memory
performance/speed
pr/breaking
proposal/accepted
proposal/rejected
pr/wip
pull-request
Mirrored from GitHub Pull Request
 reviewed/wontfix
💰 Rewarded
skip-changelog
status/blocked
topic/accessibility
topic/api
topic/authentication
topic/build
topic/code-linting
topic/commit-signing
topic/content-rendering
topic/deployment
topic/distribution
topic/federation
topic/gitea-actions
topic/issues
topic/lfs
topic/mobile
topic/moderation
topic/packages
topic/pr
topic/projects
topic/repo
topic/repo-migration
topic/security
topic/theme
topic/ui
topic/ui-interaction
topic/ux
topic/webhooks
topic/wiki
type/bug
type/deprecation
type/docs
type/enhancement
type/feature
type/miscellaneous
type/proposal
type/question
type/refactoring
type/summary
type/testing
type/upstream
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/gitea#15893
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?