Skip to content

Commit

Permalink
add some reponse status on api docs (#15399)
Browse files Browse the repository at this point in the history
Signed-off-by: a1012112796 <[email protected]>

Co-authored-by: techknowlogick <[email protected]>
Co-authored-by: 6543 <[email protected]>
  • Loading branch information
3 people authored Apr 11, 2021
1 parent 18efe9a commit 6341130
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
12 changes: 12 additions & 0 deletions routers/api/v1/user/app.go
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ func CreateAccessToken(ctx *context.APIContext) {
// responses:
// "201":
// "$ref": "#/responses/AccessToken"
// "400":
// "$ref": "#/responses/error"

form := web.GetForm(ctx).(*api.CreateAccessTokenOption)

Expand Down Expand Up @@ -139,6 +141,8 @@ func DeleteAccessToken(ctx *context.APIContext) {
// responses:
// "204":
// "$ref": "#/responses/empty"
// "404":
// "$ref": "#/responses/notFound"
// "422":
// "$ref": "#/responses/error"

Expand Down Expand Up @@ -199,6 +203,8 @@ func CreateOauth2Application(ctx *context.APIContext) {
// responses:
// "201":
// "$ref": "#/responses/OAuth2Application"
// "400":
// "$ref": "#/responses/error"

data := web.GetForm(ctx).(*api.CreateOAuth2ApplicationOptions)

Expand Down Expand Up @@ -272,6 +278,8 @@ func DeleteOauth2Application(ctx *context.APIContext) {
// responses:
// "204":
// "$ref": "#/responses/empty"
// "404":
// "$ref": "#/responses/notFound"
appID := ctx.ParamsInt64(":id")
if err := models.DeleteOAuth2Application(appID, ctx.User.ID); err != nil {
if models.IsErrOAuthApplicationNotFound(err) {
Expand Down Expand Up @@ -302,6 +310,8 @@ func GetOauth2Application(ctx *context.APIContext) {
// responses:
// "200":
// "$ref": "#/responses/OAuth2Application"
// "404":
// "$ref": "#/responses/notFound"
appID := ctx.ParamsInt64(":id")
app, err := models.GetOAuth2ApplicationByID(appID)
if err != nil {
Expand Down Expand Up @@ -340,6 +350,8 @@ func UpdateOauth2Application(ctx *context.APIContext) {
// responses:
// "200":
// "$ref": "#/responses/OAuth2Application"
// "404":
// "$ref": "#/responses/notFound"
appID := ctx.ParamsInt64(":id")

data := web.GetForm(ctx).(*api.CreateOAuth2ApplicationOptions)
Expand Down
18 changes: 18 additions & 0 deletions templates/swagger/v1_json.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -10068,6 +10068,9 @@
"responses": {
"201": {
"$ref": "#/responses/OAuth2Application"
},
"400": {
"$ref": "#/responses/error"
}
}
}
Expand Down Expand Up @@ -10095,6 +10098,9 @@
"responses": {
"200": {
"$ref": "#/responses/OAuth2Application"
},
"404": {
"$ref": "#/responses/notFound"
}
}
},
Expand All @@ -10120,6 +10126,9 @@
"responses": {
"204": {
"$ref": "#/responses/empty"
},
"404": {
"$ref": "#/responses/notFound"
}
}
},
Expand Down Expand Up @@ -10153,6 +10162,9 @@
"responses": {
"200": {
"$ref": "#/responses/OAuth2Application"
},
"404": {
"$ref": "#/responses/notFound"
}
}
}
Expand Down Expand Up @@ -11492,6 +11504,9 @@
"responses": {
"201": {
"$ref": "#/responses/AccessToken"
},
"400": {
"$ref": "#/responses/error"
}
}
}
Expand Down Expand Up @@ -11526,6 +11541,9 @@
"204": {
"$ref": "#/responses/empty"
},
"404": {
"$ref": "#/responses/notFound"
},
"422": {
"$ref": "#/responses/error"
}
Expand Down

0 comments on commit 6341130

Please sign in to comment.