From ff2c855cc5ace47ef91d4f8a6fcb9f1959eec239 Mon Sep 17 00:00:00 2001 From: powerkimhub Date: Thu, 5 Sep 2024 23:03:54 +0900 Subject: [PATCH] Add Simple Guide link to Swagger Abstraction --- api-runtime/rest-runtime/CBSpiderRuntime.go | 2 +- api/docs.go | 2 +- api/swagger.json | 2 +- api/swagger.yaml | 3 ++- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/api-runtime/rest-runtime/CBSpiderRuntime.go b/api-runtime/rest-runtime/CBSpiderRuntime.go index 16255bb57..1b2518eb7 100644 --- a/api-runtime/rest-runtime/CBSpiderRuntime.go +++ b/api-runtime/rest-runtime/CBSpiderRuntime.go @@ -42,7 +42,7 @@ var cblog *logrus.Logger // @title CB-Spider REST API // @version latest -// @description **🕷️ [User Guide](https://github.com/cloud-barista/cb-spider/wiki/features-and-usages)** +// @description **🕷️ [User Guide](https://github.com/cloud-barista/cb-spider/wiki/features-and-usages)** **🕷️ [Simple Guide](https://github.com/cloud-barista/cb-spider/wiki/Simple-Sample-API-Guide)** // @contact.name API Support // @contact.url http://cloud-barista.github.io diff --git a/api/docs.go b/api/docs.go index d652edc56..40144e955 100644 --- a/api/docs.go +++ b/api/docs.go @@ -11268,7 +11268,7 @@ var SwaggerInfo = &swag.Spec{ BasePath: "/spider", Schemes: []string{"http"}, Title: "CB-Spider REST API", - Description: "**🕷️ [User Guide](https://github.com/cloud-barista/cb-spider/wiki/features-and-usages)**", + Description: "**🕷️ [User Guide](https://github.com/cloud-barista/cb-spider/wiki/features-and-usages)** **🕷️ [Simple Guide](https://github.com/cloud-barista/cb-spider/wiki/Simple-Sample-API-Guide)**", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, LeftDelim: "{{", diff --git a/api/swagger.json b/api/swagger.json index e95efa37c..327e892e8 100644 --- a/api/swagger.json +++ b/api/swagger.json @@ -4,7 +4,7 @@ ], "swagger": "2.0", "info": { - "description": "**🕷️ [User Guide](https://github.com/cloud-barista/cb-spider/wiki/features-and-usages)**", + "description": "**🕷️ [User Guide](https://github.com/cloud-barista/cb-spider/wiki/features-and-usages)** **🕷️ [Simple Guide](https://github.com/cloud-barista/cb-spider/wiki/Simple-Sample-API-Guide)**", "title": "CB-Spider REST API", "contact": { "name": "API Support", diff --git a/api/swagger.yaml b/api/swagger.yaml index 15796a59d..65a722148 100644 --- a/api/swagger.yaml +++ b/api/swagger.yaml @@ -2631,7 +2631,8 @@ info: email: contact-to-cloud-barista@googlegroups.com name: API Support url: http://cloud-barista.github.io - description: "**\U0001F577️ [User Guide](https://github.com/cloud-barista/cb-spider/wiki/features-and-usages)**" + description: "**\U0001F577️ [User Guide](https://github.com/cloud-barista/cb-spider/wiki/features-and-usages)** + \ **\U0001F577️ [Simple Guide](https://github.com/cloud-barista/cb-spider/wiki/Simple-Sample-API-Guide)**" license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html