From ae8dca84230975aa553d588435625b0a14f7e69d Mon Sep 17 00:00:00 2001 From: 0ko <0ko@noreply.codeberg.org> Date: Mon, 17 Mar 2025 07:12:11 +0000 Subject: [PATCH] branding: update API descriptions (#7244) Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/7244 Reviewed-by: Gusted Reviewed-by: Earl Warren Co-authored-by: 0ko <0ko@noreply.codeberg.org> Co-committed-by: 0ko <0ko@noreply.codeberg.org> --- modules/structs/user.go | 2 +- routers/api/v1/misc/nodeinfo.go | 4 ++-- routers/api/v1/misc/version.go | 2 +- templates/swagger/v1_json.tmpl | 6 +++--- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/modules/structs/user.go b/modules/structs/user.go index 2dd3051c50..6c0468b5fb 100644 --- a/modules/structs/user.go +++ b/modules/structs/user.go @@ -27,7 +27,7 @@ type User struct { Email string `json:"email"` // URL to the user's avatar AvatarURL string `json:"avatar_url"` - // URL to the user's gitea page + // URL to the user's profile page HTMLURL string `json:"html_url"` // User locale Language string `json:"language"` diff --git a/routers/api/v1/misc/nodeinfo.go b/routers/api/v1/misc/nodeinfo.go index 9c2a0db8d2..70187e0ebf 100644 --- a/routers/api/v1/misc/nodeinfo.go +++ b/routers/api/v1/misc/nodeinfo.go @@ -16,11 +16,11 @@ import ( 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) { // swagger:operation GET /nodeinfo miscellaneous getNodeInfo // --- - // summary: Returns the nodeinfo of the Gitea application + // summary: Returns the nodeinfo of the Forgejo application // produces: // - application/json // responses: diff --git a/routers/api/v1/misc/version.go b/routers/api/v1/misc/version.go index e3b43a0e6b..3417475d21 100644 --- a/routers/api/v1/misc/version.go +++ b/routers/api/v1/misc/version.go @@ -15,7 +15,7 @@ import ( func Version(ctx *context.APIContext) { // swagger:operation GET /version miscellaneous getVersion // --- - // summary: Returns the version of the Gitea application + // summary: Returns the version of the running application // produces: // - application/json // responses: diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index eb891d5a8a..36ed631207 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -1877,7 +1877,7 @@ "tags": [ "miscellaneous" ], - "summary": "Returns the nodeinfo of the Gitea application", + "summary": "Returns the nodeinfo of the Forgejo application", "operationId": "getNodeInfo", "responses": { "200": { @@ -20530,7 +20530,7 @@ "tags": [ "miscellaneous" ], - "summary": "Returns the version of the Gitea application", + "summary": "Returns the version of the running application", "operationId": "getVersion", "responses": { "200": { @@ -27943,7 +27943,7 @@ "x-go-name": "FullName" }, "html_url": { - "description": "URL to the user's gitea page", + "description": "URL to the user's profile page", "type": "string", "x-go-name": "HTMLURL" },