mirror of
https://github.com/go-gitea/gitea.git
synced 2026-07-23 09:22:46 +00:00
fix(api): align Swagger schemas for UserSettings and TopicListResponse (#38590)
Corrects the Swagger/OpenAPI schemas for `/user/settings` and `/topics/search` to match the actual JSON objects returned by the API. Signed-off-by: Sudhanshu Singh <sudhanshuwriterblc@gmail.com>
This commit is contained in:
@@ -32,3 +32,8 @@ type RepoTopicOptions struct {
|
||||
// list of topic names
|
||||
Topics []string `json:"topics"`
|
||||
}
|
||||
|
||||
// TopicListResponse returns a list of TopicResponse
|
||||
type TopicListResponse struct {
|
||||
Topics []*TopicResponse `json:"topics"`
|
||||
}
|
||||
|
||||
@@ -300,7 +300,7 @@ func TopicSearch(ctx *context.APIContext) {
|
||||
}
|
||||
|
||||
ctx.SetTotalCountHeader(total)
|
||||
ctx.JSON(http.StatusOK, map[string]any{
|
||||
"topics": topicResponses,
|
||||
ctx.JSON(http.StatusOK, api.TopicListResponse{
|
||||
Topics: topicResponses,
|
||||
})
|
||||
}
|
||||
|
||||
@@ -341,7 +341,7 @@ type swaggerFileDeleteResponse struct {
|
||||
// swagger:response TopicListResponse
|
||||
type swaggerTopicListResponse struct {
|
||||
// in: body
|
||||
Body []api.TopicResponse `json:"body"`
|
||||
Body api.TopicListResponse `json:"body"`
|
||||
}
|
||||
|
||||
// TopicNames
|
||||
|
||||
@@ -46,7 +46,7 @@ type swaggerResponseUserHeatmapData struct {
|
||||
// swagger:response UserSettings
|
||||
type swaggerResponseUserSettings struct {
|
||||
// in:body
|
||||
Body []api.UserSettings `json:"body"`
|
||||
Body api.UserSettings `json:"body"`
|
||||
}
|
||||
|
||||
// BadgeList
|
||||
|
||||
24
templates/swagger/v1_json.tmpl
generated
24
templates/swagger/v1_json.tmpl
generated
@@ -30208,6 +30208,20 @@
|
||||
},
|
||||
"x-go-package": "gitea.dev/modules/structs"
|
||||
},
|
||||
"TopicListResponse": {
|
||||
"description": "TopicListResponse returns a list of TopicResponse",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"topics": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/TopicResponse"
|
||||
},
|
||||
"x-go-name": "Topics"
|
||||
}
|
||||
},
|
||||
"x-go-package": "gitea.dev/modules/structs"
|
||||
},
|
||||
"TopicName": {
|
||||
"description": "TopicName a list of repo topic names",
|
||||
"type": "object",
|
||||
@@ -31804,10 +31818,7 @@
|
||||
"TopicListResponse": {
|
||||
"description": "TopicListResponse",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/TopicResponse"
|
||||
}
|
||||
"$ref": "#/definitions/TopicListResponse"
|
||||
}
|
||||
},
|
||||
"TopicNames": {
|
||||
@@ -31858,10 +31869,7 @@
|
||||
"UserSettings": {
|
||||
"description": "UserSettings",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/UserSettings"
|
||||
}
|
||||
"$ref": "#/definitions/UserSettings"
|
||||
}
|
||||
},
|
||||
"VariableList": {
|
||||
|
||||
24
templates/swagger/v1_openapi3_json.tmpl
generated
24
templates/swagger/v1_openapi3_json.tmpl
generated
@@ -1402,10 +1402,7 @@
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/TopicResponse"
|
||||
},
|
||||
"type": "array"
|
||||
"$ref": "#/components/schemas/TopicListResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -1484,10 +1481,7 @@
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/UserSettings"
|
||||
},
|
||||
"type": "array"
|
||||
"$ref": "#/components/schemas/UserSettings"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -9963,6 +9957,20 @@
|
||||
"type": "object",
|
||||
"x-go-package": "gitea.dev/modules/structs"
|
||||
},
|
||||
"TopicListResponse": {
|
||||
"description": "TopicListResponse returns a list of TopicResponse",
|
||||
"properties": {
|
||||
"topics": {
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/TopicResponse"
|
||||
},
|
||||
"type": "array",
|
||||
"x-go-name": "Topics"
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"x-go-package": "gitea.dev/modules/structs"
|
||||
},
|
||||
"TopicName": {
|
||||
"description": "TopicName a list of repo topic names",
|
||||
"properties": {
|
||||
|
||||
Reference in New Issue
Block a user