summaryrefslogtreecommitdiff
path: root/src/services/api/graphql/README.graphql
diff options
context:
space:
mode:
authorJohn Estabrook <jestabro@vyos.io>2021-11-22 11:26:58 -0600
committerJohn Estabrook <jestabro@vyos.io>2021-11-24 13:33:45 -0600
commit715b3c05b6f6bed436c7651d8a7897e8c120329b (patch)
tree1482d184f860640e2ce087b0f868abf919c6f623 /src/services/api/graphql/README.graphql
parentecf14b0e900c7207507196f6de6ad69c80b2e09e (diff)
downloadvyos-1x-715b3c05b6f6bed436c7651d8a7897e8c120329b.tar.gz
vyos-1x-715b3c05b6f6bed436c7651d8a7897e8c120329b.zip
graphql: T3993: change name of directive
(cherry picked from commit 6de15a4162224dbf2d911bce0a9d4eaa396071a3)
Diffstat (limited to 'src/services/api/graphql/README.graphql')
-rw-r--r--src/services/api/graphql/README.graphql15
1 files changed, 8 insertions, 7 deletions
diff --git a/src/services/api/graphql/README.graphql b/src/services/api/graphql/README.graphql
index 0ddcb578a..a387f3276 100644
--- a/src/services/api/graphql/README.graphql
+++ b/src/services/api/graphql/README.graphql
@@ -122,13 +122,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: