From 8463219b7a4f6b163ae961866436f7886f0f3434 Mon Sep 17 00:00:00 2001 From: Michael Eden Date: Thu, 28 Sep 2017 20:12:16 -0400 Subject: [PATCH] Added docs. --- api.graphql | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/api.graphql b/api.graphql index adcb4f44..67bf804d 100644 --- a/api.graphql +++ b/api.graphql @@ -8,9 +8,11 @@ type Query { # Query. Leave id empty if you'd like to view the currently logged in # user. user(id: ID): User - # All the users in the database, useful for polling for new user information + # All the users in the database, useful for polling for new user information. + # This is paginated, n is the number of results, and last_id is the last ID + # seen from the latest page retrieved, if you want the first page leave this out. users(last_id: ID, n: Int!): [User!]! - # Search through a user's name and email through regex (admin only) + # Search through a user's name and email through regex search_user(search: String!, offset: Int!, n: Int!): [User!]! # All possible question branches question_branches: [String!]! @@ -62,21 +64,29 @@ type Branch { type: String! # A key-value list of questions and answers from the confirmation application data: [FormItem!]! + # Start of application as some RFC's date string start_time: String + # Submit time of application as some RFC's date string submit_time: String } # Application teams type Team { + # ID of the Team id: ID! } # Entries to various forms (application, confirmation, etc.) type FormItem { + # Name of the question / form item name: String! + # Type of form item (textbox, checkbox, phone no.) type: String! + # Value (if just one string) value: String + # Values (if many selections are applicable, like checkbox) values: [String!] + # File if type contains a file file: File }