1 files changed, 50 insertions, 19 deletions

diff --git a/src/services/api/graphql/README.graphql b/src/services/api/graphql/README.graphql
index c91b70782..a3c30b005 100644
--- a/src/services/api/graphql/README.graphql
+++ b/src/services/api/graphql/README.graphql
@@ -10,7 +10,7 @@ to run with that address as default router by requesting these 'mutations'
 in the GraphQL playground:
 
 mutation {
-  createInterfaceEthernet (data: {interface: "eth1",
+  CreateInterfaceEthernet (data: {interface: "eth1",
                                   address: "192.168.0.1/24",
                                   description: "BOB"}) {
     success
@@ -22,7 +22,7 @@ mutation {
 }
 
 mutation {
-  createDhcpServer(data: {sharedNetworkName: "BOB",
+  CreateDhcpServer(data: {sharedNetworkName: "BOB",
                           subnet: "192.168.0.0/24",
                           defaultRouter: "192.168.0.1",
                           nameServer: "192.168.0.1",
@@ -42,8 +42,10 @@ mutation {
   }
 }
 
+To save the configuration, use the following mutation:
+
 mutation {
-  saveConfigFile(data: {fileName: "/config/config.boot"}) {
+  SaveConfigFile(data: {fileName: "/config/config.boot"}) {
     success
     errors
     data {
@@ -52,11 +54,17 @@ 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"}) {
+  LoadConfigFile(data: {fileName: "/home/vyos/config.boot"}) {
     success
     errors
     data {
@@ -65,6 +73,20 @@ mutation {
   }
 }
 
+Op-mode 'show' commands may be requested by path, e.g.:
+
+mutation {
+  Show (data: {path: ["interfaces", "ethernet", "detail"]}) {
+    success
+    errors
+    data {
+      result
+    }
+  }
+}
+
+N.B. to see the output the 'data' field 'result' must be present in the
+request.
 
 The GraphQL playground will be found at:
 
@@ -81,22 +103,30 @@ What's here:
 services
 ├── api
 │   └── graphql
+│       ├── bindings.py
 │       ├── graphql
 │       │   ├── directives.py
 │       │   ├── __init__.py
 │       │   ├── mutations.py
 │       │   └── schema
+│       │       ├── config_file.graphql
 │       │       ├── dhcp_server.graphql
+│       │       ├── firewall_group.graphql
 │       │       ├── interface_ethernet.graphql
-│       │       └── schema.graphql
+│       │       ├── schema.graphql
+│       │       ├── show_config.graphql
+│       │       └── show.graphql
+│       ├── README.graphql
 │       ├── recipes
-│       │   ├── dhcp_server.py
 │       │   ├── __init__.py
-│       │   ├── interface_ethernet.py
-│       │   ├── recipe.py
+│       │   ├── remove_firewall_address_group_members.py
+│       │   ├── session.py
 │       │   └── templates
-│       │       ├── dhcp_server.tmpl
-│       │       └── interface_ethernet.tmpl
+│       │       ├── create_dhcp_server.tmpl
+│       │       ├── create_firewall_address_group.tmpl
+│       │       ├── create_interface_ethernet.tmpl
+│       │       ├── remove_firewall_address_group_members.tmpl
+│       │       └── update_firewall_address_group_members.tmpl
 │       └── state.py
 ├── vyos-configd
 ├── vyos-hostsd
@@ -114,13 +144,14 @@ the Ur-data; the GraphQL schema is produced from those files, located in
 
 Resolvers for the schema Mutation fields are dynamically generated using a
 'directive' added to the respective schema field. The directive,
-'@generate', is handled by the class 'DataDirective' in
-'api/graphql/graphql/directives.py', which calls the 'make_resolver' function in
-'api/graphql/graphql/mutations.py'; the produced resolver calls the appropriate
-wrapper in 'api/graphql/recipes', with base class doing the (overridable)
-configuration steps of calling all defined 'set'/'delete' commands.
-
-Integrating the above with vyos-http-api-server is ~10 lines of code.
+'@configure', is handled by the class 'ConfigureDirective' in
+'api/graphql/graphql/directives.py', which calls the
+'make_configure_resolver' function in 'api/graphql/graphql/mutations.py';
+the produced resolver calls the appropriate wrapper in
+'api/graphql/recipes', with base class doing the (overridable) configuration
+steps of calling all defined 'set'/'delete' commands.
+
+Integrating the above with vyos-http-api-server is 4 lines of code.
 
 What needs to be done: