Swagger AccessToken fixes (#16574) (#16597)

Backport #16574

There is a subtle problem with the Swagger definition for AccessTokens which causes
autogeneration of APIs for these endpoints to fail.

This PR corrects these errors.

Ref: https://github.com/zeripath/java-gitea-api/issues/4
Signed-off-by: Andrew Thornton <art27@cantab.net>

Co-authored-by: techknowlogick <techknowlogick@gitea.io>

Co-authored-by: techknowlogick <techknowlogick@gitea.io>
This commit is contained in:
zeripath 2021-08-02 19:24:47 +01:00 committed by GitHub
parent 763e4196ba
commit 5fe7c0ed7b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 27 additions and 31 deletions

View File

@ -14,3 +14,10 @@ type swaggerResponseOAuth2Application struct {
// in:body // in:body
Body api.OAuth2Application `json:"body"` Body api.OAuth2Application `json:"body"`
} }
// AccessToken represents an API access token.
// swagger:response AccessToken
type swaggerResponseAccessToken struct {
// in:body
Body api.AccessToken `json:"body"`
}

View File

@ -164,6 +164,9 @@ type swaggerParameterBodies struct {
// in:body // in:body
CreateTagOption api.CreateTagOption CreateTagOption api.CreateTagOption
// in:body
CreateAccessTokenOption api.CreateAccessTokenOption
// in:body // in:body
UserSettingsOptions api.UserSettingsOptions UserSettingsOptions api.UserSettingsOptions
} }

View File

@ -76,15 +76,10 @@ func CreateAccessToken(ctx *context.APIContext) {
// description: username of user // description: username of user
// type: string // type: string
// required: true // required: true
// - name: accessToken // - name: userCreateToken
// in: body // in: body
// schema: // schema:
// type: object // "$ref": "#/definitions/CreateAccessTokenOption"
// required:
// - name
// properties:
// name:
// type: string
// responses: // responses:
// "201": // "201":
// "$ref": "#/responses/AccessToken" // "$ref": "#/responses/AccessToken"

View File

@ -11917,18 +11917,10 @@
"required": true "required": true
}, },
{ {
"name": "accessToken", "name": "userCreateToken",
"in": "body", "in": "body",
"schema": { "schema": {
"type": "object", "$ref": "#/definitions/CreateAccessTokenOption"
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
}
}
} }
} }
], ],
@ -12654,6 +12646,17 @@
}, },
"x-go-package": "code.gitea.io/gitea/modules/structs" "x-go-package": "code.gitea.io/gitea/modules/structs"
}, },
"CreateAccessTokenOption": {
"description": "CreateAccessTokenOption options when create access token",
"type": "object",
"properties": {
"name": {
"type": "string",
"x-go-name": "Name"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
"CreateBranchProtectionOption": { "CreateBranchProtectionOption": {
"description": "CreateBranchProtectionOption options for creating a branch protection", "description": "CreateBranchProtectionOption options for creating a branch protection",
"type": "object", "type": "object",
@ -17044,20 +17047,8 @@
"responses": { "responses": {
"AccessToken": { "AccessToken": {
"description": "AccessToken represents an API access token.", "description": "AccessToken represents an API access token.",
"headers": { "schema": {
"id": { "$ref": "#/definitions/AccessToken"
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"sha1": {
"type": "string"
},
"token_last_eight": {
"type": "string"
}
} }
}, },
"AccessTokenList": { "AccessTokenList": {