git724/forgejo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

branding: update API descriptions (#7244)

Browse source 
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/7244
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: 0ko <0ko@noreply.codeberg.org>
Co-committed-by: 0ko <0ko@noreply.codeberg.org>
This commit is contained in:
0ko 2025-03-17 07:12:11 +00:00 • committed by Earl Warren
parent 1132fde45f
commit ae8dca8423
4 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
modules/structs/user.go
View file

@ -27,7 +27,7 @@ type User struct {
Email string `json:"email"` Email string `json:"email"`
// URL to the user's avatar // URL to the user's avatar
AvatarURL string `json:"avatar_url"` AvatarURL string `json:"avatar_url"`
// URL to the user's gitea page // URL to the user's profile page
HTMLURL string `json:"html_url"` HTMLURL string `json:"html_url"`
// User locale // User locale
Language string `json:"language"` Language string `json:"language"`

4
routers/api/v1/misc/nodeinfo.go
View file

@ -16,11 +16,11 @@ import (
const cacheKeyNodeInfoUsage = "API_NodeInfoUsage" const cacheKeyNodeInfoUsage = "API_NodeInfoUsage"
// NodeInfo returns the NodeInfo for the Gitea instance to allow for federation // NodeInfo returns the NodeInfo for the Forgejo instance to allow for federation
func NodeInfo(ctx *context.APIContext) { func NodeInfo(ctx *context.APIContext) {
// swagger:operation GET /nodeinfo miscellaneous getNodeInfo // swagger:operation GET /nodeinfo miscellaneous getNodeInfo
// --- // ---
// summary: Returns the nodeinfo of the Gitea application // summary: Returns the nodeinfo of the Forgejo application
// produces: // produces:
// - application/json // - application/json
// responses: // responses:

2
routers/api/v1/misc/version.go
View file

@ -15,7 +15,7 @@ import (
func Version(ctx *context.APIContext) { func Version(ctx *context.APIContext) {
// swagger:operation GET /version miscellaneous getVersion // swagger:operation GET /version miscellaneous getVersion
// --- // ---
// summary: Returns the version of the Gitea application // summary: Returns the version of the running application
// produces: // produces:
// - application/json // - application/json
// responses: // responses:

6
templates/swagger/v1_json.tmpl generated
View file

@ -1877,7 +1877,7 @@
"tags": [ "tags": [
"miscellaneous" "miscellaneous"
], ],
"summary": "Returns the nodeinfo of the Gitea application", "summary": "Returns the nodeinfo of the Forgejo application",
"operationId": "getNodeInfo", "operationId": "getNodeInfo",
"responses": { "responses": {
"200": { "200": {
@ -20530,7 +20530,7 @@
"tags": [ "tags": [
"miscellaneous" "miscellaneous"
], ],
"summary": "Returns the version of the Gitea application", "summary": "Returns the version of the running application",
"operationId": "getVersion", "operationId": "getVersion",
"responses": { "responses": {
"200": { "200": {
@ -27943,7 +27943,7 @@
"x-go-name": "FullName" "x-go-name": "FullName"
}, },
"html_url": { "html_url": {
"description": "URL to the user's gitea page", "description": "URL to the user's profile page",
"type": "string", "type": "string",
"x-go-name": "HTMLURL" "x-go-name": "HTMLURL"
}, },