fix #12, endpoint to validate client operations against the latest schema

Author: StarpTech

.prettierignore

@@ -1,3 +1,4 @@
 coverage
 .nyc_output
-dist
+dist
+insomnia.json

README.md

@@ -26,8 +26,9 @@ State: Experimental
 - Stores versioned schemas for all GraphQL-federated services
 - Serves schema for GraphQL gateway based on provided services & their versions
 - Validates new schema to be compatible with other running services
+- Validates that all client operations are supported by your schema
 - Produce a diff between your proposed schema and the current registry state
-- Lightweight authorization concept with JWT.
+- Lightweight authorization concept based on JWT.
 
 [**Read more**](https://principledgraphql.com/integrity#3-track-the-schema-in-a-registry)
 

docs/api.md

@@ -107,6 +107,24 @@ POST - `/schema/validate` Validate schema between provided and latest schemas.
 </p>
 </details>
 
+### Validating client operations
+
+POST - `/document/validate` Confirm that all client operations are supported by the latest schema.
+
+<details>
+<summary>Example Request</summary>
+<p>
+
+```json
+{
+  "graphName": "my_graph",
+  "document": "query { hello }"
+}
+```
+
+</p>
+</details>
+
 ## Monitoring / Maintanance
 
 ### Remove all schemas except the most (N) recent

docs/auth.md

@@ -10,8 +10,8 @@ You have to set `JWT_SECRET=secret` to enable jwt. The jwt payload must match th
 
 ```jsonc
 {
-  "services": ["foo"] // names of the granted services
-}
+  "client": "my-service", // your unique client name
+  "services": [] // additional services you have control over.
 ```
 
-This activates authorization in the `/schema/push` endpoint. Only the client with the valid jwt is be able to register schemas in the name of the services. The client will have access to all available graphs. You can use [jwt.io](https://jwt.io/) to construct a jwt.
+This activates authorization in the `/schema/push` endpoint. Only the client with a valid jwt is be able to register schemas in the name of the `services`. The client will have access to all available graphs. You can use [jwt.io](https://jwt.io/) to construct a valid jwt.