From 9fa4c302a402fd1db1bba89cdfe55da6beca3930 Mon Sep 17 00:00:00 2001 From: Jonathan Cobb Date: Thu, 3 Dec 2020 19:52:10 -0500 Subject: [PATCH] update api docs --- .../src/main/resources/META-INF/bubble/openapi-tags.json | 4 ++-- bubble-server/src/main/resources/bubble-config.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/bubble-server/src/main/resources/META-INF/bubble/openapi-tags.json b/bubble-server/src/main/resources/META-INF/bubble/openapi-tags.json index d9237c58..cefede6e 100644 --- a/bubble-server/src/main/resources/META-INF/bubble/openapi-tags.json +++ b/bubble-server/src/main/resources/META-INF/bubble/openapi-tags.json @@ -41,7 +41,7 @@ }, { "name": "mitmproxy", - "description": "mitmproxy uses these APIs to coordinate with Bubble and enhance your internet experience." + "description": "[mitmproxy](https://mitmproxy.org/) uses these APIs to coordinate with Bubble and enhance your internet experience through selective blocking and modification of your traffic, according to how you've set up your Bubble apps." }, { "name": "node", @@ -49,7 +49,7 @@ }, { "name": "node_manager", - "description": "The nodemanager is a low-level service that can monitor CPU, memory and disk usage. It is also useful in disaster recovery situations." + "description": "The [nodemanager](https://git.bubblev.org/bubblev/bubble-nodemanager) is a low-level service that can monitor CPU, memory and disk usage. It is also useful in disaster recovery situations." }, { "name": "payment", diff --git a/bubble-server/src/main/resources/bubble-config.yml b/bubble-server/src/main/resources/bubble-config.yml index 01c78d7d..a7b41fdf 100644 --- a/bubble-server/src/main/resources/bubble-config.yml +++ b/bubble-server/src/main/resources/bubble-config.yml @@ -10,7 +10,7 @@ publicUriBase: {{PUBLIC_BASE_URI}} openApi: title: Bubble API Reference - description: This is the Bubble API. It is used by the Bubble web UI, native apps, and CLI tools. + description: This is the Bubble API. It is used by the Bubble web UI, native apps, and CLI tools.\n\n[Learn more about Bubble](https://getbubblenow.com/)\n\n[Bubble Git Server](https://git.bubblev.org/)\n\n[Bubble on Github](https://github.com/GetBubbleNow/) contactEmail: {{OPENAPI_CONTACT_EMAIL}} terms: https://getbubblenow.com/terms/ licenseName: Bubble License