From 63411309fb010d2b7f739dd21dc3de06cfbfcc86 Mon Sep 17 00:00:00 2001 From: a1012112796 <1012112796@qq.com> Date: Sun, 11 Apr 2021 16:53:23 +0800 Subject: [PATCH] add some reponse status on api docs (#15399) Signed-off-by: a1012112796 <1012112796@qq.com> Co-authored-by: techknowlogick Co-authored-by: 6543 <6543@obermui.de> --- routers/api/v1/user/app.go | 12 ++++++++++++ templates/swagger/v1_json.tmpl | 18 ++++++++++++++++++ 2 files changed, 30 insertions(+) diff --git a/routers/api/v1/user/app.go b/routers/api/v1/user/app.go index b88ed6fbd2..7b69c50d7e 100644 --- a/routers/api/v1/user/app.go +++ b/routers/api/v1/user/app.go @@ -88,6 +88,8 @@ func CreateAccessToken(ctx *context.APIContext) { // responses: // "201": // "$ref": "#/responses/AccessToken" + // "400": + // "$ref": "#/responses/error" form := web.GetForm(ctx).(*api.CreateAccessTokenOption) @@ -139,6 +141,8 @@ func DeleteAccessToken(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + // "404": + // "$ref": "#/responses/notFound" // "422": // "$ref": "#/responses/error" @@ -199,6 +203,8 @@ func CreateOauth2Application(ctx *context.APIContext) { // responses: // "201": // "$ref": "#/responses/OAuth2Application" + // "400": + // "$ref": "#/responses/error" data := web.GetForm(ctx).(*api.CreateOAuth2ApplicationOptions) @@ -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) { @@ -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 { @@ -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) diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index 4be2718ef1..b548f25f4f 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -10068,6 +10068,9 @@ "responses": { "201": { "$ref": "#/responses/OAuth2Application" + }, + "400": { + "$ref": "#/responses/error" } } } @@ -10095,6 +10098,9 @@ "responses": { "200": { "$ref": "#/responses/OAuth2Application" + }, + "404": { + "$ref": "#/responses/notFound" } } }, @@ -10120,6 +10126,9 @@ "responses": { "204": { "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/notFound" } } }, @@ -10153,6 +10162,9 @@ "responses": { "200": { "$ref": "#/responses/OAuth2Application" + }, + "404": { + "$ref": "#/responses/notFound" } } } @@ -11492,6 +11504,9 @@ "responses": { "201": { "$ref": "#/responses/AccessToken" + }, + "400": { + "$ref": "#/responses/error" } } } @@ -11526,6 +11541,9 @@ "204": { "$ref": "#/responses/empty" }, + "404": { + "$ref": "#/responses/notFound" + }, "422": { "$ref": "#/responses/error" }