From 6cd47afe3366a615d40655a435275d5543910065 Mon Sep 17 00:00:00 2001
From: Gusted <postmaster@gusted.xyz>
Date: Mon, 9 Jan 2023 22:28:04 +0100
Subject: [PATCH] [BRANDING] Replace branding in Swagger
- "Gitea" is automatically being determined in Swagger and cannot be
overridden, therefor we override it after `swagger generate spec` is run.
- Resolves https://codeberg.org/forgejo/forgejo/issues/226
(cherry picked from commit 0b453807656b6fbe54284d865e59880460f3d253)
[BRANDING] Change Swagger title to Forgejo API
(cherry picked from commit 79f6a70b53421be9984a9ad96ebd0d06ab5af02e)
---
Makefile | 2 ++
templates/swagger/ui.tmpl | 2 +-
templates/swagger/v1_json.tmpl | 4 ++--
3 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/Makefile b/Makefile
index f8eecf5f4e..d514dbaffb 100644
--- a/Makefile
+++ b/Makefile
@@ -158,6 +158,7 @@ SWAGGER_SPEC_S_TMPL := s|"basePath": *"/api/v1"|"basePath": "{{AppSubUrl \| JSEs
SWAGGER_SPEC_S_JSON := s|"basePath": *"{{AppSubUrl \| JSEscape \| Safe}}/api/v1"|"basePath": "/api/v1"|g
SWAGGER_EXCLUDE := code.gitea.io/sdk
SWAGGER_NEWLINE_COMMAND := -e '$$a\'
+SWAGGER_SPEC_BRANDING := s|Gitea API|Forgejo API|g
TEST_MYSQL_HOST ?= mysql:3306
TEST_MYSQL_DBNAME ?= testgitea
@@ -332,6 +333,7 @@ $(SWAGGER_SPEC): $(GO_SOURCES_NO_BINDATA)
$(GO) run $(SWAGGER_PACKAGE) generate spec -x "$(SWAGGER_EXCLUDE)" -o './$(SWAGGER_SPEC)'
$(SED_INPLACE) '$(SWAGGER_SPEC_S_TMPL)' './$(SWAGGER_SPEC)'
$(SED_INPLACE) $(SWAGGER_NEWLINE_COMMAND) './$(SWAGGER_SPEC)'
+ $(SED_INPLACE) '$(SWAGGER_SPEC_BRANDING)' './$(SWAGGER_SPEC)'
.PHONY: swagger-check
swagger-check: generate-swagger
diff --git a/templates/swagger/ui.tmpl b/templates/swagger/ui.tmpl
index 57b560bc15..56346e8fec 100644
--- a/templates/swagger/ui.tmpl
+++ b/templates/swagger/ui.tmpl
@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="UTF-8">
- <title>Gitea API</title>
+ <title>Forgejo API</title>
<link href="{{AssetUrlPrefix}}/css/swagger.css?v={{AssetVersion}}" rel="stylesheet">
</head>
<body>
diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl
index 2a675766ab..ac56bc5c29 100644
--- a/templates/swagger/v1_json.tmpl
+++ b/templates/swagger/v1_json.tmpl
@@ -13,8 +13,8 @@
],
"swagger": "2.0",
"info": {
- "description": "This documentation describes the Gitea API.",
- "title": "Gitea API.",
+ "description": "This documentation describes the Forgejo API.",
+ "title": "Forgejo API.",
"license": {
"name": "MIT",
"url": "http://opensource.org/licenses/MIT"