vcaw
/
public
forked from root/public
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

review: corrections on db-authorization and graphql

content-update
lee 3 years ago committed by Clément
parent
1f9b2777cc
commit
20ae7908eb
2 changed files with 24 additions and 17 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 8
      docs/db/db-authorization.md
  2. 33
      docs/db/graphql.md

8
docs/db/db-authorization.md
unescape_control_characters View File

@ -6,7 +6,7 @@ Every request to Hasura executes against a set of session variables. Normally th
- `X-Hasura-Role`: This variable denotes the role with which the user is executing the current request. Hasura has a built-in notion of a role, and will explicitly look for this variable to infer the role.
- `X-Hasura-campus`: this variable contains the campus that the user currently is on.
- `X-Hasura-campuses`: this variable contains the campus that the user currently is on.
In our database we have several roles which are simple arbitrary names.
Each role can be given a set of permissions and actions (`select`, `insert`, `update`, `delete`). That will execute against each table of the database.
@ -73,7 +73,6 @@ These are the roles presented in the database:
- _`progress_view`_
- _`xp`_
- _`xp_by_event`_
- _`xp_by_object`_
- _`xp_by_path`_
---
@ -115,7 +114,6 @@ These are the roles presented in the database:
- _`registration_with_event_ready_view`_
- _`toad_result_view`_
- _`xp_by_event`_
- _`xp_by_object`_
- _`xp_by_path`_
---
@ -156,7 +154,6 @@ These are the roles presented in the database:
- _`registration_with_event_ready_view`_
- _`toad_result_view`_
- _`xp_by_event`_
- _`xp_by_object`_
- _`xp_by_path`_
---
@ -167,7 +164,7 @@ These are the roles presented in the database:
- `admin` : this role allows users to query using any action in any table on the database.
> You can see more about each role by going to the [graphiql](https://[[DOMAIN]]/graphiql) in the docs section. Note that you must be logged in with the user role you desire to see. For the role `anonymous` you do not need to be logged in. If you want to see the possible tables that can be queried by an admin, you must login with an admin, and so on...
> You can see more about each role by going to the [graphiql](https://((DOMAIN))/graphiql) in the docs section. Note that you must be logged in with the user role you desire to see. For the role `anonymous` you do not need to be logged in. If you want to see the possible tables that can be queried by an admin, you must login with an admin, and so on...
A role is given by default to every user, if an user has more roles, the highest would be taken by default when login.
@ -225,5 +222,4 @@ D : delete
| user_roles_view | ❌ ❌ ❌ ❌ | ✅ ❌ ❌ ❌ | 🟩 ❌ ❌ ❌ | 🟩 ❌ ❌ ❌ | ✅ ✅ ✅ ✅ | ✅ ❌ ❌ ❌ |
| xp | ❌ ❌ ❌ ❌ | ✅ ❌ ❌ ❌ | ❌ ❌ ❌ ❌ | ❌ ❌ ❌ ❌ | ✅ ✅ ✅ ✅ | ✅ ❌ ❌ ❌ |
| xp_by_event | ❌ ❌ ❌ ❌ | ✅ ❌ ❌ ❌ | ✅ ❌ ❌ ❌ | ✅ ❌ ❌ ❌ | ✅ ✅ ✅ ✅ | ✅ ❌ ❌ ❌ |
| xp_by_object | ❌ ❌ ❌ ❌ | ✅ ❌ ❌ ❌ | ✅ ❌ ❌ ❌ | ✅ ❌ ❌ ❌ | ✅ ✅ ✅ ✅ | ✅ ❌ ❌ ❌ |
| xp_by_path | ❌ ❌ ❌ ❌ | ✅ ❌ ❌ ❌ | ✅ ❌ ❌ ❌ | ✅ ❌ ❌ ❌ | ✅ ✅ ✅ ✅ | ✅ ❌ ❌ ❌ |

33
docs/db/graphql.md
unescape_control_characters View File

@ -4,7 +4,7 @@
## Simple queries to get info
- The following query gives the basic information of a given user :
- The following query returns the basic information of a given user :
```graphql
query getUserInfo($name: String!) {
@ -30,7 +30,7 @@ Query variable:
---
- The following query gives the record of a given user, the output would be :
- The following query returns the list of all records of a given user (including the finished ones), the output would be :
- author of the record
- the time that the record was created and will end
- message/reason for the ban
@ -54,12 +54,14 @@ Query variable:
---
- The following query gives a list of groups given the project `name`. The output will be the `captainLogin` and the `userLogin` from all the members of that group.
- The following query returns a list of groups given the path `name`. The output will be the `captainLogin` and the `userLogin` from all the members of that group.
```graphql
query getGroupInfo($object: String!) {
group(where: {object: {name: {_eq: $object}}}) {
captainLogin
path
status
members {
userLogin
}
@ -70,7 +72,7 @@ query getGroupInfo($object: String!) {
Query variable:
```graphql
{"object": "ascii-art"}
{"path": "/madere/div-01/go-reloaded"}
```
---
@ -86,12 +88,14 @@ query eventsByCampus($campus: String!) {
object {
name
}
path
parent {
path
object {
name
}
createdAt
endAt
path
}
}
}
@ -105,11 +109,11 @@ Query variable:
---
- The following query returns 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 ratio and the event info.
- The following query returns information of users that are associated to an event. For the query to work it should be given two arguments : `campus` and the `path`. The output will be the user name/login, audit ratio and the event info.
```graphql
query usersEvent($campus: String!, $object: String!) {
event_user(where: {event: {object: {name: {_eq: $object}}, _and: {campus: {_eq: $campus}}}}) {
query usersEvent($campus: String!, $path: String!) {
event_user(where: {event: {path: {_eq: $path}, _and: {campus: {_eq: $campus}}}}) {
userAuditRatio
userLogin
event {
@ -125,10 +129,10 @@ query usersEvent($campus: String!, $object: String!) {
Query variable:
```graphql
{"campus": "pyc", "object": "Final Exam"}
{"campus": "madera", "path": "/madere/div-01/piscine-js"}
```
- If we wanted to filter the users that were 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:
- If we wanted to filter the users that were registered to a type of object in the event, we would just need to filter the object by `type` instead of filtering using the `path`. Should look something like this:
```graphql
query usersEvent($campus: String!, $objectType: String!) {
@ -200,11 +204,18 @@ Query variable:
---
- The following query gives information relevant to the onboarding games.
- The following query gives information relevant to the onboarding games, This view will.
```graphql
query getGameInfo($name: String!) {
toad_result_view(where: {user: {login: {_eq: $name}}}) {
user {
login
}
attempts
allowedAttempts
score
path
games
}
}

Write Preview
Loading…
Cancel
Save