From 06f800d53541f2548add7c8f16056cc0f1505d5c Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Fri, 25 Apr 2025 21:46:01 -0700 Subject: [PATCH] Update token creation API swagger documentation --- modules/structs/user_app.go | 4 +++- templates/swagger/v1_json.tmpl | 13 ++++++++++++- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/modules/structs/user_app.go b/modules/structs/user_app.go index a7d2e28b41291..8401252bd6591 100644 --- a/modules/structs/user_app.go +++ b/modules/structs/user_app.go @@ -23,9 +23,11 @@ type AccessToken struct { type AccessTokenList []*AccessToken // CreateAccessTokenOption options when create access token +// swagger:model CreateAccessTokenOption type CreateAccessTokenOption struct { // required: true - Name string `json:"name" binding:"Required"` + Name string `json:"name" binding:"Required"` + // example: ["all", "read:activitypub","read:issue", "write:misc", "read:notification", "read:organization", "read:package", "read:repository", "read:user"] Scopes []string `json:"scopes"` } diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index 0a9432fc9d124..8758b5c0a1505 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -21350,7 +21350,18 @@ "items": { "type": "string" }, - "x-go-name": "Scopes" + "x-go-name": "Scopes", + "example": [ + "all", + "read:activitypub", + "read:issue", + "write:misc", + "read:notification", + "read:organization", + "read:package", + "read:repository", + "read:user" + ] } }, "x-go-package": "code.gitea.io/gitea/modules/structs"