summaryrefslogtreecommitdiff
path: root/src/services/api/graphql
diff options
context:
space:
mode:
authorJohn Estabrook <jestabro@vyos.io>2021-11-30 16:55:03 -0600
committerJohn Estabrook <jestabro@vyos.io>2021-12-01 15:38:07 -0600
commit9f6ca1e489c0498bfa90ca027d1d7419d4e422b8 (patch)
tree2a22cf41c2b6524277878bbb5d4a277f14fa47e0 /src/services/api/graphql
parentb654b7991d2ec1d9aa40554f471cb7740fabfb91 (diff)
downloadvyos-1x-9f6ca1e489c0498bfa90ca027d1d7419d4e422b8.tar.gz
vyos-1x-9f6ca1e489c0498bfa90ca027d1d7419d4e422b8.zip
graphql: T3993: update README.graphql
Diffstat (limited to 'src/services/api/graphql')
-rw-r--r--src/services/api/graphql/README.graphql25
1 files changed, 23 insertions, 2 deletions
diff --git a/src/services/api/graphql/README.graphql b/src/services/api/graphql/README.graphql
index 29f58f709..a3c30b005 100644
--- a/src/services/api/graphql/README.graphql
+++ b/src/services/api/graphql/README.graphql
@@ -73,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:
@@ -97,15 +111,22 @@ services
│   │   └── 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
│   │   ├── __init__.py
+│   │   ├── remove_firewall_address_group_members.py
│   │   ├── session.py
│   │   └── templates
│   │   ├── create_dhcp_server.tmpl
-│   │   └── create_interface_ethernet.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