From 33de2a98c50af76e94f2d66e458c29360bbd0810 Mon Sep 17 00:00:00 2001
From: Daniel LaCosse <3759828+daniellacosse@users.noreply.github.com>
Date: Mon, 29 Jan 2024 17:32:11 -0500
Subject: [PATCH] feat(manager): link to Management API Documentation next to
the Management API Endpoint (#1486)
* wip
* style tweak
---
src/server_manager/messages/en.json | 1 +
.../messages/master_messages.json | 4 ++++
.../ui_components/outline-server-settings.ts | 17 +++++++++++++++++
3 files changed, 22 insertions(+)
diff --git a/src/server_manager/messages/en.json b/src/server_manager/messages/en.json
index ce1352f9..22471fcc 100644
--- a/src/server_manager/messages/en.json
+++ b/src/server_manager/messages/en.json
@@ -144,6 +144,7 @@
"gcp-type-outline-server": "Type 'outline-server' in the 'Name' field.",
"key": "Key {keyId}",
"manager-resources": "Manager Resources",
+ "management-api-documentation": "Server Management API Documentation",
"manual-server-assign-firewall": "Assign firewall rule",
"manual-server-assign-group": "Assign Security Group",
"manual-server-create-firewall": "Create a firewall rule",
diff --git a/src/server_manager/messages/master_messages.json b/src/server_manager/messages/master_messages.json
index e36880c6..ccae614a 100644
--- a/src/server_manager/messages/master_messages.json
+++ b/src/server_manager/messages/master_messages.json
@@ -718,6 +718,10 @@
"message": "Manager Resources",
"description": "This string appears within the manager sidebar as a link to the manager documentation."
},
+ "management_api_documentation": {
+ "message": "Server Management API Documentation",
+ "description": "This string appears next to the management API url, pointing to the API documentation."
+ },
"manual_server_assign_firewall": {
"message": "Assign firewall rule",
"description": "This string appears in the server setup view as a sub-header of a section that provides instructions to configure the server's firewall."
diff --git a/src/server_manager/web_app/ui_components/outline-server-settings.ts b/src/server_manager/web_app/ui_components/outline-server-settings.ts
index 3cd7c05e..43a9b936 100644
--- a/src/server_manager/web_app/ui_components/outline-server-settings.ts
+++ b/src/server_manager/web_app/ui_components/outline-server-settings.ts
@@ -119,6 +119,14 @@ Polymer({
margin-top: 0px;
font-size: 12px;
}
+ .management-api-documentation-link {
+ align-items: center;
+ color: var(--primary-green);
+ display: flex;
+ gap: 0.25rem;
+ margin-bottom: 1rem;
+ margin-top: -1rem;
+ }
paper-input:not([readonly]) {
width: 60%;
}
@@ -253,6 +261,15 @@ Polymer({
always-float-label=""
maxlength="100"
>
+
+
+ [[localize('management-api-documentation')]]
+
+
+