From 8183e2cc8178f5da67a918ee37c21797a05c142d Mon Sep 17 00:00:00 2001
From: John Estabrook <jestabro@vyos.io>
Date: Wed, 25 Sep 2024 08:43:41 -0500
Subject: http-api: T6736: add distinct XML path for REST API

---
 interface-definitions/service_https.xml.in | 53 +++++++++++++++++-------------
 1 file changed, 30 insertions(+), 23 deletions(-)

(limited to 'interface-definitions')

diff --git a/interface-definitions/service_https.xml.in b/interface-definitions/service_https.xml.in
index afe430c0c..7bb63fa5a 100644
--- a/interface-definitions/service_https.xml.in
+++ b/interface-definitions/service_https.xml.in
@@ -32,22 +32,29 @@
                   </tagNode>
                 </children>
               </node>
-              <leafNode name="strict">
+              <node name="rest">
                 <properties>
-                  <help>Enforce strict path checking</help>
-                  <valueless/>
+                  <help>REST API</help>
                 </properties>
-              </leafNode>
-              <leafNode name="debug">
-                <properties>
-                  <help>Debug</help>
-                  <valueless/>
-                  <hidden/>
-                </properties>
-              </leafNode>
+                <children>
+                  <leafNode name="strict">
+                    <properties>
+                      <help>Enforce strict path checking</help>
+                      <valueless/>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="debug">
+                    <properties>
+                      <help>Debug</help>
+                      <valueless/>
+                      <hidden/>
+                    </properties>
+                  </leafNode>
+                </children>
+              </node>
               <node name="graphql">
                 <properties>
-                  <help>GraphQL support</help>
+                  <help>GraphQL API</help>
                 </properties>
                 <children>
                   <leafNode name="introspection">
@@ -109,19 +116,19 @@
                       </leafNode>
                     </children>
                   </node>
-                </children>
-              </node>
-              <node name="cors">
-                <properties>
-                  <help>Set CORS options</help>
-                </properties>
-                <children>
-                  <leafNode name="allow-origin">
+                  <node name="cors">
                     <properties>
-                      <help>Allow resource request from origin</help>
-                      <multi/>
+                      <help>Set CORS options</help>
                     </properties>
-                  </leafNode>
+                    <children>
+                      <leafNode name="allow-origin">
+                        <properties>
+                          <help>Allow resource request from origin</help>
+                          <multi/>
+                        </properties>
+                      </leafNode>
+                    </children>
+                  </node>
                 </children>
               </node>
             </children>
-- 
cgit v1.2.3


From 40d966310cb5d8d758f7fa801facd0a560795783 Mon Sep 17 00:00:00 2001
From: John Estabrook <jestabro@vyos.io>
Date: Sun, 29 Sep 2024 20:49:30 -0500
Subject: http-api: T6736: add migration script and update version

---
 .../include/version/https-version.xml.i            |  2 +-
 src/migration-scripts/https/6-to-7                 | 43 ++++++++++++++++++++++
 2 files changed, 44 insertions(+), 1 deletion(-)
 create mode 100644 src/migration-scripts/https/6-to-7

(limited to 'interface-definitions')

diff --git a/interface-definitions/include/version/https-version.xml.i b/interface-definitions/include/version/https-version.xml.i
index 525314dbd..a889a7805 100644
--- a/interface-definitions/include/version/https-version.xml.i
+++ b/interface-definitions/include/version/https-version.xml.i
@@ -1,3 +1,3 @@
 <!-- include start from include/version/https-version.xml.i -->
-<syntaxVersion component='https' version='6'></syntaxVersion>
+<syntaxVersion component='https' version='7'></syntaxVersion>
 <!-- include end -->
diff --git a/src/migration-scripts/https/6-to-7 b/src/migration-scripts/https/6-to-7
new file mode 100644
index 000000000..571f3b6ae
--- /dev/null
+++ b/src/migration-scripts/https/6-to-7
@@ -0,0 +1,43 @@
+# Copyright 2024 VyOS maintainers and contributors <maintainers@vyos.io>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library.  If not, see <http://www.gnu.org/licenses/>.
+
+# T6736: move REST API to distinct node
+
+
+from vyos.configtree import ConfigTree
+
+
+base = ['service', 'https', 'api']
+
+def migrate(config: ConfigTree) -> None:
+    if not config.exists(base):
+        # Nothing to do
+        return
+
+    # Move REST API configuration to new node
+    # REST API was previously enabled if base path exists
+    config.set(['service', 'https', 'api', 'rest'])
+    for entry in ('debug', 'strict'):
+        if config.exists(base + [entry]):
+            config.set(base + ['rest', entry])
+            config.delete(base + [entry])
+
+    # Move CORS settings under GraphQL
+    # CORS is not implemented for REST API
+    if config.exists(base + ['cors']):
+        old_base = base + ['cors']
+        new_base = base + ['graphql', 'cors']
+        config.copy(old_base, new_base)
+        config.delete(old_base)
-- 
cgit v1.2.3