Skip to content

Latest commit

 

History

History
1239 lines (1217 loc) · 23.8 KB

graphql_endpoints.md

File metadata and controls

1239 lines (1217 loc) · 23.8 KB
Raw

GraphQL

Our GraphQL endpoints fall into three categories: queries, mutations, and filter queries.

Queries

  1. getUser(id: ID) Finds a specific user in the database
  • Example Query
{
    getUser(id: "1") {
      name
      program
      module
      id
      image
    }
  }
  • Example Response
{ "data": {
  "getUser": {
    "name": "Bowen Arrow",
    "program": "BE",
    "module": "4",
    "id": "208",
    "image": "https://loremflickr.com/300/300"
  }
}
}
  1. getUserByFirebaseID(id: ID) Finds user by FirebaseID for logging in
  • Example Query
    { getUserByFirebaseID(
    id: "er561v3h0si34bu56m1l2e34v7ax"
      ) {
         name
         program
         module
         id
         image
         pronouns
         email
         phoneNumber
         slack
         skills
      }
    }
  • Example Response
  { "data":
    { "getUserByFirebaseID":
      {
        "name": "Alec Tricity",
        "program": "BE",
        "module": "4",
        "id": "213",
        "image": "https://loremflickr.com/300/300",
        "pronouns": "She/her",
        "email": "patrina@konopelski.info",
        "phoneNumber": "5555550100",
        "slack": "Zeke N. Yeshallfind",
        "skills": [
          "Ruby",
          "Rails"
        ]
      }
    }
  }
  1. getUserPairings(id: ID) Will return a list of booked pairings where the user is the pairer or pairee
  • Example Query
  { getUserPairings(id: "1")
    {
      pairer {
        name
        module
        program
        id
        pronouns
        slack
        image
      }
      pairee {
        name
        module
        program
        pronouns
        slack
        image
      }
      date
      time
      id
      notes
    }
  }
  • Example Response
{ "data":
  { "getUserPairings":
    [
      { "pairer":
          {
            "name": "Bowen Arrow",
            "module": "4",
            "program": "BE",
            "id": "208",
            "pronouns": "She/her",
            "slack": "Kenney C. Strait",
            "image": "https://loremflickr.com/300/300"
          },
        "pairee":
          {
            "name": "Harmon Ikka",
            "module": "2",
            "program": "BE",
            "pronouns": "She/her",
            "slack": "Ty Knotts",
            "image": "https://loremflickr.com/300/300"
          },
        "date": "Wed Apr 03 2020",
        "time": "lunch",
        "id": "4077",
        "notes": "Help me with Battleship!"
      },
      { "pairer":
        {
          "name": "Bowen Arrow",
          "module": "4",
          "program": "BE",
          "id": "208",
          "pronouns": "She/her",
          "slack": "Kenney C. Strait",
          "image": "https://loremflickr.com/300/300"
        },
        "pairee":
          {
            "name": "Curt N. Rodd",
            "module": "5",
            "program": "BE",
            "pronouns": "She/her",
            "slack": "Noah Riddle",
            "image": "https://loremflickr.com/300/300"
          },
        "date": "Wed Apr 03 2020",
        "time": "lunch",
        "id": "4073",
        "notes": "Need to work on MVC"
      },
    ]
  }
}
  1. getUsers Returns all users in the database
  • Example Query
{
  getUsers {
    name
    program
    module
  }
}
  • Example Response
{ "data": {
  "getUsers": [
    {
      "name": "Ben Down",
      "program": "BE",
      "module": "3"
    },
    {
      "name": "Neil B. Formy",
      "program": "BE",
      "module": "2"
    },
    {
      "name": "Bowen Arrow",
      "program": "BE",
      "module": "4"
    },
    {
      "name": "Eli Ondefloor",
      "program": "BE",
      "module": "3"
    },
    {
      "name": "Curt N. Rodd",
      "program": "BE",
      "module": "5"
    },
    {
      "name": "R. M. Pitt",
      "program": "BE",
      "module": "1"
    },
  ]
}
}
  1. getPairings Returns all pairings
  • Example Query
{ getPairings
  {
    id
    pairer {
     name
    }
    pairee {
     name
    }
    date
    time
  }
}
  • Example Response
{ "data": {
  "getPairings": [
    {
      "id": "4082",
      "pairer": {
        "name": "Eli Ondefloor"
      },
      "pairee": null,
      "date": "Wed Apr 03 2020",
      "time": "lunch"
    },
    {
      "id": "4073",
      "pairer": {
        "name": "Bowen Arrow"
      },
      "pairee": {
        "name": "Curt N. Rodd"
      },
      "date": "Wed Apr 03 2020",
      "time": "lunch"
    },
    {
      "id": "4074",
      "pairer": {
        "name": "Curt N. Rodd"
      },
      "pairee": {
        "name": "Bowen Arrow"
      },
      "date": "Wed Apr 03 2020",
      "time": "lunch"
    },
    {
      "id": "4075",
      "pairer": {
        "name": "Curt N. Rodd"
      },
      "pairee": {
        "name": "R. M. Pitt"
      },
      "date": "Wed Apr 03 2020",
      "time": "lunch"
    },
    {
      "id": "4076",
      "pairer": {
        "name": "R. M. Pitt"
      },
      "pairee": {
        "name": "Curt N. Rodd"
      },
      "date": "Wed Apr 03 2020",
      "time": "lunch"
    },
  ]
}
}
  1. getPairing(id: ID) Finds a specific pairing by pairing id
  • Example Query
{ getPairing(id: "1") {
    pairer {
      name
      module
      program
      id
      pronouns
      skills
      slack
      image
    }
    pairee {
      name
    }
    date
    time
    id
  }
}
  • Example Response
{
  "data": {
    "getPairing": {
      "pairer": {
        "name": "Hill",
        "module": "3",
        "program": "BE",
        "id": "216",
        "pronouns": "she/her",
        "skills": [
          "paired",
          "ruby",
          "react"
        ],
        "slack": "@h34",
        "image": "https://avatars3.githubusercontent.com/u/36748280?v=4"
      },
      "pairee": {
        "name": "Kylie "
      },
      "date": "Mon May 13 2019",
      "time": "morning",
      "id": "4463"
    }
  }
}
  1. getUserStats(id: ID) Returns a specific users statistics on pairing hours
  • Example Query
{
  getUserStats(id: "1") {
    name
    totalBookings
    totalMentorHours
    totalHoursMentored
    mentees {
      name }
    }
}
  • Example Response
{ "data":
  { "getUserStats":
    {
      "name": "Bowen Arrow",
      "totalBookings": 2,
      "totalMentorHours": 1,
      "totalHoursMentored": 0.5,
      "mentees": [
        {
          "name": "Harmon Ikka"
        },
        {
          "name": "Curt N. Rodd"
        }
      ]
    }
  }
}

Mutations

  1. createUser(CreateUserInput) Used during profile creation. Will create a new user in the database
  • Example Query
mutation {
        user: createUser(
        input: {
          name: "Samantha"
          email: "so@gmail.com"
          image: "https://robohash.org/image"
          firebaseID: "425tgw2g4w43"
          module: "3"
          program: "BE"
          phoneNumber: "4231563232"
          pronouns: "she/her"
          slack: "rer7891"
          skills: ["ruby", "rails", "graphql"]
        }
        ) {
          name
          program
          module
          id
          image
          pronouns
          email
          slack
          skills
          }
        }
  • Example Response
{ "data": {
  "user": {
    "name": "Samantha",
    "program": "BE",
    "module": "3",
    "id": "411",
    "image": "https://robohash.org/image",
    "pronouns": "she/her",
    "email": "so@gmail.com",
    "slack": "rer7891",
    "skills": [
      "ruby",
      "rails",
      "graphql"
    ]
  }
}
}
  1. updateUser(UpdateUserInput) Allows a user to update their profile details.
  • Example Query
mutation {
  user: updateUser(
    input: {
      id: "11"
      name: "Carl Crockett"
      email: "cap@gmail.com"
      module: 2
      program: "BE"
      pronouns: "she/her"
      slack: "capleugh"
      skills: ["rspec", "react", "ruby"]
    }
  ) {
    name
    program
    module
    id
    image
    pronouns
    email
    slack
    skills
  }
}
  • Example Response
{
  "data": {
    "user": {
      "name": "Carl Crockett",
      "program": "BE",
      "module": "2",
      "id": "412",
      "image": "https://robohash.org/image",
      "pronouns": "she/her",
      "email": "cap@gmail.com",
      "slack": "capleugh",
      "skills": [
      "rspec",
      "react",
      "ruby"
      ]
    }
  }
}
  1. deleteUser(DeleteUserInput) Allows a user to delete their account.
  • Example Query
mutation {
  deleteUser(
    input:{
      id: "121" } )
  {
  name
  }
}
  • Example Response
{
  "data": {
    "deleteUser": {
      "name": "Carl Crockett"
    }
  }
}
  1. createPairings(createPairingsInput) Creates open pairings for a user when they set availability. Pairee is nil.
  • Example Query
  mutation {
    createPairings(input: {
      pairings: [
        {
          date:"Mon Apr 29 2019",
          time:"morning",
          pairer:"5caa7eebfdebb8348e53a48e"
        },
        {
          date:"Mon May 06 2019",
          time:"morning",
          pairer:"5caa7eebfdebb8348e53a48e"
        }
      ]
    }) {
      unbookedPairings
      {
        pairer {id}
        date
        time
      }
    }
  }
  • Example Response
{
"data": {
  "createPairings": {
    "unbookedPairings": [
      {
        "pairer": {
          "id": "411"
        },
        "date": "Mon Apr 29 2019",
        "time": "morning"
      },
      {
        "pairer": {
          "id": "411"
        },
        "date": "Mon May 06 2019",
        "time": "morning"
      }
    ]
  }
}
}
  1. updatePairings(updatePairingsInput) When a pairing is booked this updates the pairee from nil to an assigned pairee.
  • Example Query
mutation {
  updatePairing(input: {
        id: "1"
        pairee: "23"
        notes: "I need help with Flashcards"
        }) {
  pairer {
    name
    module
    program
    id
    pronouns
      slack
      image
  }
  pairee {
    name
    module
    program
    id
    pronouns
    slack
    image
  }
    date
    time
    id
    notes
  }
}
  • Example Response
{
  "data": {
    "updatePairing": {
      "pairer": {
        "name": "Ann",
        "module": "2",
        "program": "FE",
        "id": "267",
        "pronouns": "she/her",
        "slack": "Ann",
        "image": "https://avatars0.githubusercontent.com/u/34483051?v=4"
      },
      "pairee": {
        "name": "Carl Crockett",
        "module": "2",
        "program": "BE",
        "id": "411",
        "pronouns": "she/her",
        "slack": "capleugh",
        "image": "https://robohash.org/image"
      },
      "date": "Mon Jul 29 2019",
      "time": "lunch",
      "id": "4702",
      "notes": "I need help with Flashcards"
    }
  }
}
  1. deletePairing(id: ID) Deletes a specific date and time of availability for a user.
  • Example Query
 mutation {
           pairing: deletePairing(
             input: {
               id: #{id: "11"}
             }
           ){
             pairer {id}
             pairee {id}
           }
         }
  • Example Response
{
  "data": {
    "pairing": {
      "pairer": {
        "id": "219"
      },
      "pairee": null
    }
  }
}
  1. deletePairings(id: ID) Deletes all old availability for a user when they update their availability.
  • Example Query
 mutation {
      deletePairings(
        input:{
          id: "122"
        }
      ) {
        pairer { id }
      }
    }
  • Example Response
{
  "data": {
    "deletePairings": {
      "pairer": null
    }
  }
}

Filter Queries

  1. getPairing (id: ID) Returns all available pairings filtered by program, mod and date
  • Example Query
{
  getAvailablePairings(filter: {
    program: "FE",
    module: 2,
    date: "Wed Apr 04 2020"
  }) {
     pairer {
       name
       module
       program
       id
       pronouns
       skills
       slack
       image
     }
     date
     time
     id
   }
}
  • Example Response
{ "data":
  { "getAvailablePairings":
    [
      { "pairer":
        {
          "name": "Eli Ondefloor",
          "module": "3",
          "program": "BE",
          "id": "209",
          "pronouns": "She/her",
          "skills": [
            "Armand Hammer",
            "Luna Tick",
            "Brock Lee",
            "Rusty Fossat",
            "Lou Pole",
            "Jane Linkfence"
          ],
          "slack": "Candice B. Fureal",
          "image": "https://loremflickr.com/300/300"
        },
        "date": "Wed Apr 03 2020",
        "time": "lunch",
        "id": "4082"
      }
    ]
  }
}

Rock And Pebble Queries and Mutations

Queries

  1. getUserRocksAndPebble(id: ID) Returns all Rock and Pebble relationships by User
  • Example Query
getUserRockAndPebble(id: 4) {
    myRocks {
      name
      module
      program
      id
      pronouns
      skills
      slack
      image
    }
    myPebbles {
      name
      module
      program
      id
      pronouns
      skills
      slack
      image
    }
    pendingPebbles {
      name
      module
      program
      id
      pronouns
      skills
      slack
      image
    } 
    pendingRocks {
      name
      module
      program
      id
      pronouns
      skills
      slack
      image
    }  
  }
}
  • Example Response
{
"data": {
  "getUserRockAndPebble": {
    "myRocks": [
      {
        "name": "Kenny Penny",
        "module": "5",
        "program": "BE",
        "id": "4",
        "pronouns": "she/her",
        "skills": [
          "Chad Terbocks",
          "Walter Melon",
          "Bob Ng"
        ],
        "slack": "Olive Hoyl",
        "image": "https://loremflickr.com/300/300"
      }
    ],
    "myPebbles": [
      {
        "name": "Frank Furter",
        "module": "2",
        "program": "BE",
        "id": "3",
        "pronouns": "She/her",
        "skills": [
          "Ferris Wheeler",
          "Hilda Climb",
          "Woody Forrest",
          "Seymour Legg"
        ],
        "slack": "Cole Kutz",
        "image": "https://loremflickr.com/300/300"
      }
    ],
    "pendingPebbles": [],
    "pendingRocks": []
  }
}
}

Mutations

  1. rockOptInOut(input: {id: ID!}) Allows a user to opt in or out of being available as a Rock
  • Example Query
mutation {
    updateUserOptinStatus(
      input: {
        id: "1"
      })
      {
        rockOptIn
    }
  }
  • Example Response
{
  "data": {
    "updateUserOptinStatus": {
      "rockOptIn": false
    }
  }
}
  1. createRockPebbleRelationship(input: {rockId: ID!, pebbleId: ID!}) Creates initial Rock and Pebble Relationship
  • Example Query
mutation {
  createRockPebbleRelationship(
    input: {
      rockId: "1"
      pebbleId: "4"
    })
  {
    myRocks {
      name
      module
      program
      id
      pronouns
      skills
      slack
      image
    }
    myPebbles {
      name
      module
      program
      id
      pronouns
      skills
      slack
      image
    }
    pendingPebbles {
      name
      module
      program
      id
      pronouns
      skills
      slack
      image
    } 
    pendingRocks {
      name
      module
      program
      id
      pronouns
      skills
      slack
      image
    } 
  }
}
  • Example Response
{
  "data": {
    "createRockPebbleRelationship": {
      "myRocks": [],
      "myPebbles": [
        {
          "name": "Becky Simpson",
          "module": "4",
          "program": "BE",
          "id": "11",
          "pronouns": "",
          "skills": [
            "grid",
            "flexbox",
            "Graphql "
          ],
          "slack": "3srtr4",
          "image": "https://avatars1.githubusercontent.com/u/52762517?v=4"
        }
      ],
      "pendingPebbles": [],
      "pendingRocks": [
        {
          "name": "Sarah Clarkson",
          "module": "5",
          "program": "BE",
          "id": "14",
          "pronouns": "",
          "skills": [
            "grid",
            "flexbox",
            "Graphql "
          ],
          "slack": "som342",
          "image": "https://avatars1.githubusercontent.com/u/52762517?v=4"
        }
      ]
    }
  }
}
  1. activateRockPebbleRelationship(input: {rockId: ID!, pebbleId: ID!}) Activates a Rock and Pebble Relationship once a Rock accepts
  • Example Query
mutation {
    activateRockPebbleRelationship(
      input: {
        rockId: "1"
        pebbleId: "4"
      })
    {
      myRocks {
        name
        module
        program
        id
        pronouns
        skills
        slack
        image
      }
      myPebbles {
        name
        module
        program
        id
        pronouns
        skills
        slack
        image
      }
      pendingPebbles {
        name
        module
        program
        id
        pronouns
        skills
        slack
        image
      } 
      pendingRocks {
        name
        module
        program
        id
        pronouns
        skills
        slack
        image
      } 
    }
  }
  • Example Response
{
  "data": {
    "activateRockPebbleRelationship": {
      "myRocks": [
      {
          "name": "Sarah Clarkson",
          "module": "5",
          "program": "BE",
          "id": "14",
          "pronouns": "",
          "skills": [
            "grid",
            "flexbox",
            "Graphql "
          ],
          "slack": "som342",
          "image": "https://avatars1.githubusercontent.com/u/52762517?v=4"
        }
      ],
      "myPebbles": [
        {
          "name": "Becky Simpson",
          "module": "4",
          "program": "BE",
          "id": "11",
          "pronouns": "",
          "skills": [
            "grid",
            "flexbox",
            "Graphql "
          ],
          "slack": "3srtr4",
          "image": "https://avatars1.githubusercontent.com/u/52762517?v=4"
        }
      ],
      "pendingPebbles": [],
      "pendingRocks": []
    }
  }
}
  1. declineRockPebbleRelationship(input: {rockId: ID!, pebbleId: ID!, reason: String!}) Destroys a Rock and Pebble Relationship if a Rock declines relationship
  • Example Query
mutation {
    declineRockPebbleRelationship(
      input: {
        rockId: "1"
        pebbleId: "4"
        reason: "I no longer wish to be available as a rock."
      })
    {
      myRocks {
        name
        module
        program
        id
        pronouns
        skills
        slack
        image
      }
      myPebbles {
        name
        module
        program
        id
        pronouns
        skills
        slack
        image
      }
      pendingPebbles {
        name
        module
        program
        id
        pronouns
        skills
        slack
        image
      } 
      pendingRocks {
        name
        module
        program
        id
        pronouns
        skills
        slack
        image
      } 
    }
  }
  • Example Response
{
  "data": {
    "declineRockPebbleRelationship": {
      "myRocks": [],
      "myPebbles": [
        {
          "name": "Becky Simpson",
          "module": "4",
          "program": "BE",
          "id": "11",
          "pronouns": "",
          "skills": [
            "grid",
            "flexbox",
            "Graphql "
          ],
          "slack": "3srtr4",
          "image": "https://avatars1.githubusercontent.com/u/52762517?v=4"
        }
      ],
      "pendingPebbles": [],
      "pendingRocks": []
    }
  }
}
  1. discontinueRockPebbleRelationship(input: {rockId: ID!, pebbleId: ID!, reason: String!, userRelationship: String!}) Updates a Rock and Pebble Relationship to inactive
  • Example Query
mutation {
    discontinueRockPebbleRelationship(
      input: {
        rockId: "1"
        pebbleId: "4"
        reason:"I'm too busy."
        userRelationship: "pebble"
      })
    {
      myRocks {
        name
        module
        program
        id
        pronouns
        skills
        slack
        image
      }
      myPebbles {
        name
        module
        program
        id
        pronouns
        skills
        slack
        image
      }
      pendingPebbles {
        name
        module
        program
        id
        pronouns
        skills
        slack
        image
      } 
      pendingRocks {
        name
        module
        program
        id
        pronouns
        skills
        slack
        image
      } 
    }
  }
  • Example Response
{
  "data": {
    "discontinueRockPebbleRelationship": {
      "myRocks": [],
      "myPebbles": [],
      "pendingPebbles": [],
      "pendingRocks": []
    }
  }
}

Filter Queries

  1. findAvailableRocks(filter: {program: String, module: Int}) Searches for Rocks that are opted in to the program by program and module
  • Example Query
{
    findAvailableRocks(filter: { program: "BE", module: 5}) {
      name
      module
      program
      id
      pronouns
      skills
      slack
      image
    }
  }
  • Example Response
{
  "data": {
    "findAvailableRocks": [
      {
        "name": "Kenny Penny",
        "module": "5",
        "program": "BE",
        "id": "4",
        "pronouns": "she/her",
        "skills": [
          "Chad Terbocks",
          "Walter Melon",
          "Bob Ng"
        ],
        "slack": "Olive Hoyl",
        "image": "https://loremflickr.com/300/300"
      }
    ]
  }
}