summaryrefslogtreecommitdiff
path: root/src/services/api/graphql
diff options
context:
space:
mode:
authorJohn Estabrook <jestabro@vyos.io>2021-11-22 09:28:31 -0600
committerJohn Estabrook <jestabro@vyos.io>2021-11-24 13:33:45 -0600
commitecf14b0e900c7207507196f6de6ad69c80b2e09e (patch)
treef9ce0b6fc15b35dde7bb296105f71625e2e9c46e /src/services/api/graphql
parentac87c75e708ac3f7c29c415a4f17f63217cd399e (diff)
downloadvyos-1x-ecf14b0e900c7207507196f6de6ad69c80b2e09e.tar.gz
vyos-1x-ecf14b0e900c7207507196f6de6ad69c80b2e09e.zip
graphql: T3993: update README.graphql
(cherry picked from commit f4ec1a88b655e64372d30166b69021e2a17b2a90)
Diffstat (limited to 'src/services/api/graphql')
-rw-r--r--src/services/api/graphql/README.graphql12
1 files changed, 10 insertions, 2 deletions
diff --git a/src/services/api/graphql/README.graphql b/src/services/api/graphql/README.graphql
index c91b70782..0ddcb578a 100644
--- a/src/services/api/graphql/README.graphql
+++ b/src/services/api/graphql/README.graphql
@@ -42,6 +42,8 @@ mutation {
}
}
+To save the configuration, use the following mutation:
+
mutation {
saveConfigFile(data: {fileName: "/config/config.boot"}) {
success
@@ -52,8 +54,14 @@ mutation {
}
}
-N.B. fileName can be empty (fileName: "") or data can be empty (data: {}) to save to
-/config/config.boot; to save to an alternative path, specify fileName.
+N.B. fileName can be empty (fileName: "") or data can be empty (data: {}) to
+save to /config/config.boot; to save to an alternative path, specify
+fileName.
+
+Similarly, using the same 'endpoint' (meaning the form of the request and
+resolver; the actual enpoint for all GraphQL requests is
+https://hostname/graphql), one can load an arbitrary config file from a
+path.
mutation {
loadConfigFile(data: {fileName: "/home/vyos/config.boot"}) {