move endpoint to /user. Add swagger documentations and proper respons…

…e type.

modules/structs/admin_user.go

@@ -21,14 +21,6 @@ type CreateUserOption struct {
  SendNotify bool `json:"send_notify"`
 }
 
-// CreateOauthApplicationOption create user options
-type CreateOauthApplicationOption struct {
- // required: true
- Name string `json:"name" binding:"Required"`
- // required: true
- RedirectURIs []string `json:"redirect-uri" binding:"Required"`
-}
-
 // EditUserOption edit user options
 type EditUserOption struct {
  SourceID int64 `json:"source_id"`

modules/structs/user_app.go

@@ -32,3 +32,19 @@ type AccessTokenList []*AccessToken
 type CreateAccessTokenOption struct {
  Name string `json:"name" binding:"Required"`
 }
+
+// CreateOAuth2ApplicationOptions holds options to create an oauth2 application
+// swagger:parameters userCreateOAuth2Application
+type CreateOAuth2ApplicationOptions struct {
+ Name string `json:"name" binding:"Required"`
+ RedirectURIs []string `json:"redirect-uris" binding:"Required"`
+}
+
+// OAuth2Application represents an OAuth2 application.
+// swagger:response OAuth2Application
+type OAuth2Application struct {
+ Name string `json:"name"`
+ ClientID string `json:"client-id"`
+ ClientSecret string `json:"client-secret"`
+ RedirectURIs []string `json:"redirect-uris"`
+}

routers/api/v1/api.go

@@ -576,6 +576,9 @@ func RegisterRoutes(m *macaron.Macaron) {
  m.Combo("/:id").Get(user.GetPublicKey).
  Delete(user.DeletePublicKey)
  })
+ m.Group("/applications", func() {
+ m.Post("/oauth2", bind(api.CreateOAuth2ApplicationOptions{}), user.CreateOauth2Application)
+ }, reqToken())
 
  m.Group("/gpg_keys", func() {
  m.Combo("").Get(user.ListMyGPGKeys).
@@ -882,10 +885,6 @@ func RegisterRoutes(m *macaron.Macaron) {
  })
  }, orgAssignment(false, true), reqToken(), reqTeamMembership())
 
- m.Group("/applications", func() {
- m.Post("/oauth2", bind(api.CreateOauthApplicationOption{}), user.CreateOauth2Application)
- }, reqToken())
-
  m.Any("/*", func(ctx *context.APIContext) {
  ctx.NotFound()
  })

routers/api/v1/swagger/app.go

@@ -0,0 +1,12 @@
+package swagger
+
+import (
+ api "code.gitea.io/gitea/modules/structs"
+)
+
+// OAuth2Application
+// swagger:response OAuth2Application
+type swaggerResponseOAuth2Application struct {
+ // in:body
+ Body api.OAuth2Application `json:"body"`
+}

routers/api/v1/user/app.go

@@ -135,3 +135,38 @@ func DeleteAccessToken(ctx *context.APIContext) {
 
  ctx.Status(http.StatusNoContent)
 }
+
+// CreateOauth2Application is the handler to create a new OAuth2 Application for the authenticated user
+func CreateOauth2Application(ctx *context.APIContext, data api.CreateOAuth2ApplicationOptions) {
+ // swagger:operation POST /user/applications/oauth2 userCreateOAuth2Application
+ // ---
+ // summary: creates a new OAuth2 application
+ // produces:
+ // - application/json
+ // parameters:
+ // responses:
+ // "200":
+ // "$ref": "#/responses/OAuth2Application"
+ app, err := models.CreateOAuth2Application(models.CreateOAuth2ApplicationOptions{
+ Name: data.Name,
+ UserID: ctx.User.ID,
+ RedirectURIs: data.RedirectURIs,
+ })
+ if err != nil {
+ ctx.Error(http.StatusBadRequest, "", "error creating oauth2 application")
+ return
+ }
+ secret, err := app.GenerateClientSecret()
+ if err != nil {
+ ctx.Error(http.StatusBadRequest, "", "error creating application secret")
+ return
+ }
+ app.ClientSecret = secret
+
+ ctx.JSON(http.StatusOK, api.OAuth2Application{
+ Name: app.Name,
+ ClientID: app.ClientID,
+ ClientSecret: app.ClientSecret,
+ RedirectURIs: app.RedirectURIs,
+ })
+}

routers/api/v1/user/user.go

@@ -166,24 +166,3 @@ func GetUserHeatmapData(ctx *context.APIContext) {
  }
  ctx.JSON(http.StatusOK, heatmap)
 }
-
-// CreateOauth2Application is the handler to create a new OAuth2 Application for the authenticated user
-func CreateOauth2Application(ctx *context.APIContext, data api.CreateOauthApplicationOption) {
- app, err := models.CreateOAuth2Application(models.CreateOAuth2ApplicationOptions{
- Name: data.Name,
- UserID: ctx.User.ID,
- RedirectURIs: data.RedirectURIs,
- })
- if err != nil {
- ctx.Error(http.StatusBadRequest, "", "error creating oauth2 application")
- return
- }
- secret, err := app.GenerateClientSecret()
- if err != nil {
- ctx.Error(http.StatusBadRequest, "", "error creating application secret")
- return
- }
- app.ClientSecret = secret
-
- ctx.JSON(http.StatusOK, app)
-}

templates/swagger/v1_json.tmpl

@@ -8059,6 +8059,20 @@
  }
  }
  },
+ "/user/applications/oauth2": {
+ "post": {
+ "produces": [
+ "application/json"
+ ],
+ "summary": "creates a new OAuth2 application",
+ "operationId": "userCreateOAuth2Application",
+ "responses": {
+ "200": {
+ "$ref": "#/responses/OAuth2Application"
+ }
+ }
+ }
+ },
  "/user/emails": {
  "get": {
  "produces": [
@@ -12186,6 +12200,32 @@
  },
  "x-go-package": "code.gitea.io/gitea/modules/structs"
  },
+ "OAuth2Application": {
+ "type": "object",
+ "title": "OAuth2Application represents an OAuth2 application.",
+ "properties": {
+ "client-id": {
+ "type": "string",
+ "x-go-name": "ClientID"
+ },
+ "client-secret": {
+ "type": "string",
+ "x-go-name": "ClientSecret"
+ },
+ "name": {
+ "type": "string",
+ "x-go-name": "Name"
+ },
+ "redirect-uris": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "x-go-name": "RedirectURIs"
+ }
+ },
+ "x-go-package": "code.gitea.io/gitea/modules/structs"
+ },
  "Organization": {
  "description": "Organization represents an organization",
  "type": "object",
@@ -13677,6 +13717,12 @@
  }
  }
  },
+ "OAuth2Application": {
+ "description": "OAuth2Application",
+ "schema": {
+ "$ref": "#/definitions/OAuth2Application"
+ }
+ },
  "Organization": {
  "description": "Organization",
  "schema": {