graphql: simple queries that clients can use

3 years ago · 3ab5a96c3b
2 changed files with 221 additions and 69 deletions
--- a/docs/db/graphql.md
+++ b/docs/db/graphql.md
@ -0,0 +1,221 @@
+# Examples of graphql (queries)
+
+> Note: that all queries present where can be ran in your own school. For this you must login with an admin role and access the following route <https://((DOMAIN))/graphiql>. Depending on our role the tables permissions may differ.
+
+## Simple queries to get info
+
+- The following query gives the basic information of a give user :
+
+```graphql
+query getUserInfo($name: String!) {
+  user(where: {login: {_eq: $name}}) {
+    profile
+    login
+    attrs
+    auditRatio
+    campus
+    createdAt
+    totalDown
+    totalUp
+    updatedAt
+  }
+}
+```
+
+query variable:
+
+```graphql
+{"name": "Joao"}
+```
+
+---
+
+- The following query gives the record of a given user, the output would be :
+  - author of the record
+  - the time that the record was created and will end
+  - message/reason for the band
+
+ to see band students
+
+```graphql
+query bandUsers($userName: String!) {
+  record(where: {user: {login: {_eq: $userName}}}) {
+    authorLogin
+    banEndAt
+    createdAt
+    message
+  }
+}
+```
+
+query variable:
+
+```graphql
+{"userName": "Joao"}
+```
+
+---
+
+- The following query gives a list of groups given the project `name`. The output will be the `captainLogin` and all the members from that group, including the `userLogin`.
+
+```graphql
+query getGroupInfo($object: String!) {
+  group(where: {object: {name: {_eq: $object}}}) {
+    captainLogin
+    members {
+      userLogin
+    }
+  }
+}
+```
+
+query variable:
+
+```graphql
+{"object": "ascii-art"}
+```
+
+---
+
+- The following query get all events in a given campus, the output for this query will be the:
+  - object name
+  - path of the event
+  - parent event (this will be the parent event of the given child event)
+
+```graphql
+query eventsByCampus($campus: String!) {
+  event(where: {campus: {_eq: $campus}}) {
+    object {
+      name
+    }
+    path
+    parent {
+      path
+      object {
+        name
+      }
+    }
+  }
+}
+```
+
+query variable:
+
+```graphql
+{ "campus": "madere" }
+```
+
+---
+
+- The following query gets the information of users that are associated to an event. For the query to work it should be given two arguments : `campus` and the `object`. The output will be the user name/login, audit ration and the event info.
+
+```graphql
+query usersEvent($campus: String!, $object: String!) {
+  event_user(where: {event: {object: {name: {_eq: $object}}, _and: {campus: {_eq: $campus}}}}) {
+    userAuditRatio
+    userLogin
+    event {
+      path
+      object {
+        name
+      }
+    }
+  }
+}
+```
+
+query variable:
+
+```graphql
+{"campus": "pyc", "object": "Final Exam"}
+```
+
+- If we wanted to filter the users that where registered to a type of object in the event, we would just need to filter the object by `type` instead of `name`. Should look something like this:
+
+```graphql
+query usersEvent($campus: String!, $objectType: String!) {
+  event_user(where: {event: {object: {type: {_eq: $objectType}}, _and: {campus: {_eq: $campus}}}}) {
+    userAuditRatio
+    userLogin
+    event {
+      path
+      object {
+        name
+      }
+    }
+  }
+}
+```
+
+query variable:
+
+```graphql
+{"campus": "pyc", "objectType": "raid"}
+```
+
+---
+
+- The following query gets the current `XP` of a given user, the output should be the `amount` that this use should have
+
+```graphql
+query xp($userName: String!) {
+  xp(where: {user: {login: {_eq: $userName}}}) {
+    user {
+      login
+    }
+    amount
+  }
+}
+```
+
+query variable:
+
+```graphql
+{"userName": "Joao"}
+```
+
+- If we wanted to filter all `XP` gain from a user from an given object, it would look something like this:
+
+```graphql
+query eventXp($userName: String!, $objectName: String!) {
+  xp_by_path(where: {user: {login: {_eq: $userName}}, _and: {object: {name: {_eq: $objectName}}}}) {
+    path
+    user {
+      login
+    }
+    event {
+      path
+    }
+    object {
+      name
+    }
+    amount
+  }
+}
+```
+
+query variable:
+
+```graphql
+{"userName": "Joao", "objectName": "ascii-art"}
+```
+
+This query will return the amount of `XP` gain from each of the events.
+
+---
+
+- The following query gives information relevant to the onboarding games.
+
+```graphql
+query getGameInfo($name: String!) {
+  toad_result_view(where: {user: {login: {_eq: $name}}}) {
+    games
+  }
+}
+```
+
+query variables:
+
+```graphql
+{"name": "Qazaqbala"}
+```
--- a/docs/db/read-only-access.md
+++ b/docs/db/read-only-access.md
@ -1,69 +0,0 @@
-# Read Only token
-
-## instructions
-
-1. **How to get read-only role?**, for this role to be given the user who wants to create the app should have an `admin` role.
-
-2. **How to create and associate application with read-only access?**, for this you must create an application on `gitea` then you can create your own application token. This token will grant access to your account using the `gitea` API. To create this token you must go to **user/settings/application** then **Generate New Token**, you can use this link <https://((DOMAIN))/user/settings/applications>. It should display a token.
-
-3. **How to get the read only token (JWT)?**, to get this token you must send a request to the authentication service with the application token. The authentication service can be accessed/reached by sending the request to : `https://((DOMAIN))/api/auth/token?token=${appToken}`.
-This route will validate the application token and build a new **JWT** that allows you to query the information needed.
-
-The following example should help :
-
-```js
-const APPTOKEN = '<app token>' // put your application token here
-const res = await fetch(
-  `https://dev.01-edu.org/api/auth/token?token=${APPTOKEN}`
-)
-const { token } = await res.json()
-
-// you should take care of error cases
-
-console.log('JWT : ', token)
-```
-
-4. **What can you query?**, querying information is dependent on the users role. A role is given by default to every user, in this case it should be a `read_only` role. You can see more about possible information you can query [here](db-authorization.md)
-
-5. **How to query the information?**, to query the information you must send a request with the query you desire to use. You can see more information and instructions about this on the project [graphql](../../subjects/graphql/README.md).
-
-The following example should help :
-
-```js
-const jwt = '<jwt>' // put your jwt here
-const query = '{user(where:{id:{_eq:1}}){login}}' // what you want to query
-const res = await fetch(
-  'https://((DOMAIN))/api/graphql-engine/v1/graphql',
-  {
-    method: 'POST',
-    headers: { Authorization: `Bearer ${jwt}` },
-    body: JSON.stringify({ query }),
-  }
-)
-const { data } = await res.json()
-
-// you should take care of error cases...
-
-console.log(data)
-```
-
-## Observations
-
-Because of the nature of JWT you should renew the token often, normally this token will have a life spam of one day.
-To refresh the tokens you need to do the following:
-
- Send a request to the authentication service with the `JWT`. The authentication service can be accessed/reached by sending the request to : `https://((DOMAIN))/api/auth/token/refresh?token=${jwt}`. This route will create a new token and expire the current token.
-
-The following example should help :
-
-```js
-const JWT = '<jwt>' // put your jwt here
-const res = await fetch(
-  `https://((DOMAIN))/api/auth/token/refresh?token=${JWT}`
-)
-const { token } = await res.json()
-
-// you should take care of error cases...
-
-console.log('JWT : ', token)
-```