openapi.json

{"openapi":"3.0.2","info":{"title":"Saturn API","description":"API Documentation for Saturn","version":"0.1"},"paths":{"/api/v2/auth/verify":{"post":{"tags":["Auth"],"summary":"Verify an user from an OAuth2 token","operationId":"verify_token_v2_auth_verify_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignupView"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Verify Token V2 Auth Verify Post","anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/SchoolViewPublic"}},{"$ref":"#/components/schemas/Token"}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/waitlist/schools":{"get":{"tags":["Waitlist"],"summary":"Get all the schools on waitlist","operationId":"get_waitlist_schools_public_info_v2_waitlist_schools_get","parameters":[{"required":false,"schema":{"title":"Query","type":"string"},"name":"query","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Waitlist Schools Public Info V2 Waitlist Schools Get","type":"array","items":{"$ref":"#/components/schemas/WaitlistSchoolPublicView"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/waitlist/active-schools":{"get":{"tags":["Waitlist"],"summary":"Get all the schools on waitlist","operationId":"get_waitlist_schools_v2_waitlist_active_schools_get","parameters":[{"required":false,"schema":{"title":"Show All","type":"boolean","default":false},"name":"show_all","in":"query"},{"required":false,"schema":{"title":"Paginate","type":"boolean","default":false},"name":"paginate","in":"query"},{"required":false,"schema":{"title":"Limit","type":"integer","default":50},"name":"limit","in":"query"},{"required":false,"schema":{"title":"Page","type":"integer","default":1},"name":"page","in":"query"},{"required":false,"schema":{"title":"Sort By","type":"string","default":""},"name":"sort_by","in":"query"},{"required":false,"schema":{"title":"Order By","type":"string","default":"desc"},"name":"order_by","in":"query"},{"required":false,"schema":{"title":"Filter By","type":"string","default":""},"name":"filter_by","in":"query"},{"required":false,"schema":{"title":"Search","type":"string","default":""},"name":"search","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedWaitlistSchools"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/waitlist/users":{"get":{"tags":["Waitlist"],"summary":"Get all the users on waitlist","operationId":"get_waitlist_users_v2_waitlist_users_get","parameters":[{"required":false,"schema":{"title":"Paginate","type":"boolean","default":false},"name":"paginate","in":"query"},{"required":false,"schema":{"title":"Limit","type":"integer","default":50},"name":"limit","in":"query"},{"required":false,"schema":{"title":"Page","type":"integer","default":1},"name":"page","in":"query"},{"required":false,"schema":{"title":"Sort By","type":"string","default":""},"name":"sort_by","in":"query"},{"required":false,"schema":{"title":"Order By","type":"string","default":"desc"},"name":"order_by","in":"query"},{"required":false,"schema":{"title":"Filter By","type":"string","default":""},"name":"filter_by","in":"query"},{"required":false,"schema":{"title":"Search","type":"string","default":""},"name":"search","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Waitlist Users V2 Waitlist Users Get","type":"array","items":{"$ref":"#/components/schemas/WaitlistUserView"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/waitlist/signup":{"post":{"tags":["Waitlist"],"summary":"Enroll a new user on the waitlist","operationId":"signup_to_waitlist_v2_waitlist_signup_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WaitlistSignupView"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WailtistLeaderboardView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/waitlist/leaderboard":{"get":{"tags":["Waitlist"],"summary":"Get the leaderboard view for a user","operationId":"get_leaderboard_v2_waitlist_leaderboard_get","parameters":[{"required":true,"schema":{"title":"User Id","type":"string"},"name":"user_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WailtistLeaderboardView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/waitlist/schedule":{"post":{"tags":["Waitlist"],"summary":"Upload file resources for defining schedules","operationId":"upload_schedule_v2_waitlist_schedule_post","parameters":[{"required":false,"schema":{"title":"User Id","type":"string"},"name":"user_id","in":"query"},{"required":false,"schema":{"title":"School Id","type":"string"},"name":"school_id","in":"query"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_schedule_v2_waitlist_schedule_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleImageView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/waitlist/{school_code}":{"get":{"tags":["Waitlist"],"summary":"Get school info","operationId":"get_school_v2_waitlist__school_code__get","parameters":[{"required":true,"schema":{"title":"School Code","type":"string"},"name":"school_code","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WaitlistSchoolView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"put":{"tags":["Waitlist"],"summary":"Update school info","operationId":"update_school_v2_waitlist__school_code__put","parameters":[{"required":true,"schema":{"title":"School Code","type":"string"},"name":"school_code","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WaitlistSchoolUpdate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WaitlistSchoolView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/waitlist/school":{"post":{"tags":["Waitlist"],"summary":"Create a new waitlist school","operationId":"create_school_v2_waitlist_school_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WaitlistSchoolCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WaitlistSchoolView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/waitlist/{school_code}/{data_type}":{"get":{"tags":["Waitlist"],"summary":"Get school info","operationId":"get_school_extra_info_v2_waitlist__school_code___data_type__get","parameters":[{"required":true,"schema":{"title":"School Code","type":"string"},"name":"school_code","in":"path"},{"required":true,"schema":{"title":"Data Type","enum":["users","schedule-images"],"type":"string"},"name":"data_type","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get School Extra Info V2 Waitlist  School Code   Data Type  Get","anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/WaitlistUserView"}},{"type":"array","items":{"$ref":"#/components/schemas/ScheduleImageView"}}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/waitlist/schedule-image/{image_uuid}/toggle-star":{"put":{"tags":["Waitlist"],"summary":"Mark a image as starred","operationId":"toggle_schedule_image_star_v2_waitlist_schedule_image__image_uuid__toggle_star_put","parameters":[{"required":true,"schema":{"title":"Image Uuid","type":"string","format":"uuid"},"name":"image_uuid","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleImageView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/waitlist/schedule-image/{image_uuid}":{"delete":{"tags":["Waitlist"],"summary":"Mark a image as starred","operationId":"delete_schedule_image_v2_waitlist_schedule_image__image_uuid__delete","parameters":[{"required":true,"schema":{"title":"Image Uuid","type":"string","format":"uuid"},"name":"image_uuid","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/waitlist/user/{user_id}":{"put":{"tags":["Waitlist"],"summary":"Update waitlisted user info","operationId":"update_user_v2_waitlist_user__user_id__put","parameters":[{"required":true,"schema":{"title":"User Id","type":"string"},"name":"user_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WaitlistUserUpdate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WaitlistUserView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/waitlist/school/{school_id}/convert":{"post":{"tags":["Waitlist"],"summary":"Convert a WL school into a Saturn school","operationId":"convert_school_v2_waitlist_school__school_id__convert_post","parameters":[{"required":true,"schema":{"title":"School Id","type":"string"},"name":"school_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WaitlistSchoolConvert"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WaitlistSchoolPublicView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/courses":{"get":{"tags":["Courses"],"summary":"Get courses or filter by name","operationId":"search_courses_v2_courses_get","parameters":[{"required":false,"schema":{"title":"Course Name","type":"string","default":""},"name":"course_name","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Search Courses V2 Courses Get","type":"array","items":{"$ref":"#/components/schemas/CourseView"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"post":{"tags":["Courses"],"summary":"Create a course","operationId":"create_courses_v2_courses_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseCreateView"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/courses/{course_id}":{"put":{"tags":["Courses"],"summary":"Update a course","operationId":"update_courses_v2_courses__course_id__put","parameters":[{"required":true,"schema":{"title":"Course Id","type":"integer"},"name":"course_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseCreateView"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"delete":{"tags":["Courses"],"summary":"Delete a course","operationId":"delete_courses_v2_courses__course_id__delete","parameters":[{"required":true,"schema":{"title":"Course Id","type":"integer"},"name":"course_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/courses/instance/{course_id}":{"get":{"tags":["Courses"],"summary":"Get courses instances by course id","operationId":"get_courses_instances_v2_courses_instance__course_id__get","parameters":[{"required":true,"schema":{"title":"Course Id","type":"integer"},"name":"course_id","in":"path"},{"required":false,"schema":{"title":"On Meeting","type":"string"},"name":"on_meeting","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Courses Instances V2 Courses Instance  Course Id  Get","type":"array","items":{"$ref":"#/components/schemas/EventInstanceView"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"put":{"tags":["Courses"],"summary":"update joined instance info or join if instance doesn't exist","operationId":"upsert_course_instance_v2_courses_instance__course_id__put","parameters":[{"required":true,"schema":{"title":"Course Id","type":"integer"},"name":"course_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventInstanceCreateView"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventInstanceView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"delete":{"tags":["Courses"],"summary":"Leave a course","operationId":"leave_courses_v2_courses_instance__course_id__delete","parameters":[{"required":true,"schema":{"title":"Course Id","type":"integer"},"name":"course_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/courses/instance":{"get":{"tags":["Courses"],"summary":"Get courses instances or filter by name","operationId":"search_courses_instances_v2_courses_instance_get","parameters":[{"required":false,"schema":{"title":"Course Name","type":"string","default":""},"name":"course_name","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Search Courses Instances V2 Courses Instance Get","type":"array","items":{"$ref":"#/components/schemas/EventInstanceView"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/schools":{"get":{"tags":["Schools"],"summary":"Get school or filter by name","operationId":"search_schools_v2_schools_get","parameters":[{"required":false,"schema":{"title":"Domain","type":"string","default":""},"name":"domain","in":"query"},{"required":false,"schema":{"title":"Meta","type":"boolean","default":true},"name":"meta","in":"query"},{"required":false,"schema":{"title":"Paginate","type":"boolean","default":false},"name":"paginate","in":"query"},{"required":false,"schema":{"title":"Limit","type":"integer","default":50},"name":"limit","in":"query"},{"required":false,"schema":{"title":"Page","type":"integer","default":1},"name":"page","in":"query"},{"required":false,"schema":{"title":"Sort By","type":"string","default":""},"name":"sort_by","in":"query"},{"required":false,"schema":{"title":"Order By","type":"string","default":"desc"},"name":"order_by","in":"query"},{"required":false,"schema":{"title":"Filter By","type":"string","default":""},"name":"filter_by","in":"query"},{"required":false,"schema":{"title":"Search","type":"string","default":""},"name":"search","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Search Schools V2 Schools Get","type":"array","items":{"$ref":"#/components/schemas/SchoolViewSearch"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"post":{"tags":["Schools"],"summary":"Create a school","description":"Creates a new school\nArgs:\n    body: the data for the new school\n    super_admin_user: even though this param isn't used, it will still enforce only super admins\n\nReturns: SchoolView with newly created school","operationId":"create_school_v2_schools_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchoolCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchoolView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/schools/csv":{"get":{"tags":["Schools"],"summary":"Get schools as table","operationId":"schools_csv_v2_schools_csv_get","parameters":[{"required":false,"schema":{"title":"Domain","type":"string","default":""},"name":"domain","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/schools/{school_id}":{"get":{"tags":["Schools"],"summary":"Get school with extra information","operationId":"get_school_extra_v2_schools__school_id__get","parameters":[{"required":true,"schema":{"title":"School Id","type":"string"},"name":"school_id","in":"path"},{"required":false,"schema":{"title":"For Dashboard","type":"boolean","default":false},"name":"for_dashboard","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchoolViewExtra"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"put":{"tags":["Schools"],"summary":"Update a school","description":"Update a school\nReturns: SchoolView with school","operationId":"update_school_v2_schools__school_id__put","parameters":[{"required":true,"schema":{"title":"School Id","type":"string"},"name":"school_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchoolCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchoolView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/schools/{school_id}/staff":{"post":{"tags":["Schools"],"summary":"Create a staff in a school","operationId":"create_staff_v2_schools__school_id__staff_post","parameters":[{"required":true,"schema":{"title":"School Id","type":"string"},"name":"school_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaffCreateView"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaffView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/schools/{school_id}/staff/{staff_id}":{"put":{"tags":["Schools"],"summary":"Update a staff in a school","operationId":"update_staff_v2_schools__school_id__staff__staff_id__put","parameters":[{"required":true,"schema":{"title":"School Id","type":"string"},"name":"school_id","in":"path"},{"required":true,"schema":{"title":"Staff Id","type":"integer"},"name":"staff_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaffCreateView"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaffView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"delete":{"tags":["Schools"],"summary":"Delete a staff in a school","operationId":"delete_staff_v2_schools__school_id__staff__staff_id__delete","parameters":[{"required":true,"schema":{"title":"School Id","type":"string"},"name":"school_id","in":"path"},{"required":true,"schema":{"title":"Staff Id","type":"integer"},"name":"staff_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/schools/{school_id}/calendar/{date}/cancel":{"delete":{"tags":["Schools"],"summary":"Cancel a day in a school","description":"Notes\n----------\ndate: datetime.date\n\nAvailable formats are: YYYY-MM-DD, int or float (See [datetime-types](https://pydantic-docs.helpmanual.io/usage/types/#datetime-types))","operationId":"cancel_day_v2_schools__school_id__calendar__date__cancel_delete","parameters":[{"required":true,"schema":{"title":"School Id","type":"string"},"name":"school_id","in":"path"},{"required":true,"schema":{"title":"Date","type":"string","format":"date"},"name":"date","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/schools/{school_id}/calendar/{date}/schedule/{schedule_id}":{"patch":{"tags":["Schools"],"summary":"Update a day in a school","description":"Notes\n----------\ndate: datetime.date\n\nAvailable formats are: YYYY-MM-DD, int or float (See [datetime-types](https://pydantic-docs.helpmanual.io/usage/types/#datetime-types))","operationId":"update_day_v2_schools__school_id__calendar__date__schedule__schedule_id__patch","parameters":[{"required":true,"schema":{"title":"School Id","type":"string"},"name":"school_id","in":"path"},{"required":true,"schema":{"title":"Schedule Id","type":"integer"},"name":"schedule_id","in":"path"},{"required":true,"schema":{"title":"Date","type":"string","format":"date"},"name":"date","in":"path"},{"required":false,"schema":{"title":"Clone","type":"boolean","default":false},"name":"clone","in":"query"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/schools/{school_id}/birthdays":{"get":{"tags":["Schools"],"summary":"Get user school upcoming birthdays for the month","operationId":"get_school_birthdays_v2_schools__school_id__birthdays_get","parameters":[{"required":true,"schema":{"title":"School Id","type":"string"},"name":"school_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get School Birthdays V2 Schools  School Id  Birthdays Get","type":"array","items":{"$ref":"#/components/schemas/UserViewBirthdays"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/schools/{school_id}/{resource}":{"get":{"tags":["Schools"],"summary":"Get a specific resource at a school","operationId":"get_resource_v2_schools__school_id___resource__get","parameters":[{"required":true,"schema":{"title":"School Id","type":"string"},"name":"school_id","in":"path"},{"required":true,"schema":{"title":"Resource","enum":["meta","staff","users","courses","schedules","calendar","links"],"type":"string"},"name":"resource","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Resource V2 Schools  School Id   Resource  Get","anyOf":[{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/SchedulesViewUser"},{"$ref":"#/components/schemas/CourseView"},{"$ref":"#/components/schemas/UserViewPublic"},{"$ref":"#/components/schemas/StaffView"},{"$ref":"#/components/schemas/CalendarEntryView"}]}},{"$ref":"#/components/schemas/SchoolMeta"}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/schools/{school_id}/schedules/{schedule_id}":{"put":{"tags":["Schools"],"summary":"Update a schedule","description":"Update a schedule\nReturns: SchedulesView with schedule updated","operationId":"update_schedule_v2_schools__school_id__schedules__schedule_id__put","parameters":[{"required":true,"schema":{"title":"School Id","type":"string"},"name":"school_id","in":"path"},{"required":true,"schema":{"title":"Schedule Id","type":"integer"},"name":"schedule_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulesCreation"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulesView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"delete":{"tags":["Schools"],"summary":"Delete a schedule","description":"Delete a schedule","operationId":"delete_schedule_v2_schools__school_id__schedules__schedule_id__delete","parameters":[{"required":true,"schema":{"title":"School Id","type":"string"},"name":"school_id","in":"path"},{"required":true,"schema":{"title":"Schedule Id","type":"integer"},"name":"schedule_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/schools/{school_id}/schedules":{"post":{"tags":["Schools"],"summary":"Create a schedule","description":"Create a schedule\nReturns: SchedulesView with schedule","operationId":"create_schedule_v2_schools__school_id__schedules_post","parameters":[{"required":true,"schema":{"title":"School Id","type":"string"},"name":"school_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulesCreation"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulesView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/schools/{school_id}/features/{feature_id}":{"post":{"tags":["Schools"],"summary":"Enable a feature in a school","operationId":"add_feature_v2_schools__school_id__features__feature_id__post","parameters":[{"required":true,"schema":{"title":"School Id","type":"string"},"name":"school_id","in":"path"},{"required":true,"schema":{"title":"Feature Id","type":"string"},"name":"feature_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"delete":{"tags":["Schools"],"summary":"Disable a feature in a school","operationId":"delete_feature_v2_schools__school_id__features__feature_id__delete","parameters":[{"required":true,"schema":{"title":"School Id","type":"string"},"name":"school_id","in":"path"},{"required":true,"schema":{"title":"Feature Id","type":"string"},"name":"feature_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/schools/{school_id}/attachment":{"patch":{"tags":["Schools"],"summary":"Modify school attachments","operationId":"update_attachments_v2_schools__school_id__attachment_patch","parameters":[{"required":true,"schema":{"title":"School Id","type":"string"},"name":"school_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentView"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/course/{course_id}":{"get":{"tags":["Users"],"summary":"Get user event instance information","description":"Get course information based on user's periods.\nOptional args:\n* on_meeting: You can pass a custom meeting time (e.g {\"1\": [\"A\"]}) to retrieve classmates on specific meeting times\n* from_user: If you pass a value here it will try to fetch another user information (if you have permission)","operationId":"get_user_course_v2_user_course__course_id__get","parameters":[{"required":true,"schema":{"title":"Course Id","type":"integer"},"name":"course_id","in":"path"},{"required":false,"schema":{"title":"On Meeting","type":"string"},"name":"on_meeting","in":"query"},{"required":false,"schema":{"title":"From User","type":"integer"},"name":"from_user","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventInstanceViewPersonal"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/me":{"get":{"tags":["Users"],"summary":"Get current user info","operationId":"get_own_profile_v2_user_me_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserViewFull"}}}}},"security":[{"HTTPBearer":[]}]},"put":{"tags":["Users"],"summary":"Update user info","operationId":"update_user_v2_user_me_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUpdateView"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/me/sharing_status":{"get":{"tags":["Users"],"summary":"Get current user sharing info","operationId":"get_sharing_status_v2_user_me_sharing_status_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharingView"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/{user_id}":{"get":{"tags":["Users"],"summary":"Get user info","operationId":"get_user_profile_v2_user__user_id__get","parameters":[{"required":true,"schema":{"title":"User Id","type":"integer"},"name":"user_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get User Profile V2 User  User Id  Get","anyOf":[{"$ref":"#/components/schemas/UserViewFull"},{"$ref":"#/components/schemas/UserViewPublic"}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/friends/today":{"get":{"tags":["Users"],"summary":"Get public/friends schedule for today","operationId":"get_user_friends_schedule_today_v2_user_friends_today_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/friends/{schedule_id}":{"get":{"tags":["Users"],"summary":"Get public/friends schedules","operationId":"get_user_friends_schedule_v2_user_friends__schedule_id__get","parameters":[{"required":true,"schema":{"title":"Schedule Id","type":"integer"},"name":"schedule_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/friends/{schedule_id}/lunch":{"get":{"tags":["Users"],"summary":"Get lunch friends","operationId":"get_lunch_friends_v2_user_friends__schedule_id__lunch_get","parameters":[{"required":true,"schema":{"title":"Schedule Id","type":"integer"},"name":"schedule_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Lunch Friends V2 User Friends  Schedule Id  Lunch Get","type":"array","items":{"$ref":"#/components/schemas/UserViewPublic"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/me/{schedule_id}/lunch":{"patch":{"tags":["Users"],"summary":"Update lunch","operationId":"update_user_schedule_lunch_v2_user_me__schedule_id__lunch_patch","parameters":[{"required":true,"schema":{"title":"Schedule Id","type":"integer"},"name":"schedule_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserLunch"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/me/profile-picture":{"post":{"tags":["Users"],"summary":"Upload your profile picture","description":"**NOTE**: Unlike all other routes, this uses `FormData` and not a `JSON` body!\n\n**Args:**\n* `file`: The file being uploaded - Must be of type *JPG*, *PNG*, or *GIF*.\n\n**Returns:** The newly uploaded profile picture.","operationId":"upload_profile_picture_v2_user_me_profile_picture_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_profile_picture_v2_user_me_profile_picture_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/me/phone/verify":{"post":{"tags":["Users"],"summary":"Validate phone number","operationId":"check_phone_v2_user_me_phone_verify_post","parameters":[{"required":true,"schema":{"title":"Code","type":"string"},"name":"code","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/me/phone/resend":{"post":{"tags":["Users"],"summary":"Resend phone number verification code","operationId":"resend_check_phone_v2_user_me_phone_resend_post","responses":{"204":{"description":"Successful Response"}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/school":{"put":{"tags":["Users"],"summary":"Update user school","operationId":"update_user_school_v2_user_school_put","parameters":[{"required":true,"schema":{"title":"School Id","type":"string"},"name":"school_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/{user_id}/schedule":{"get":{"tags":["Users"],"summary":"Get user schedules","operationId":"get_user_schedule_v2_user__user_id__schedule_get","parameters":[{"required":true,"schema":{"title":"User Id","type":"integer"},"name":"user_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get User Schedule V2 User  User Id  Schedule Get","type":"array","items":{"$ref":"#/components/schemas/SchedulesViewUser"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/{user_id}/courses":{"get":{"tags":["Users"],"summary":"Get user courses","operationId":"get_user_courses_v2_user__user_id__courses_get","parameters":[{"required":true,"schema":{"title":"User Id","type":"integer"},"name":"user_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get User Courses V2 User  User Id  Courses Get","type":"array","items":{"$ref":"#/components/schemas/EventInstanceView"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/tasks":{"get":{"tags":["Tasks"],"summary":"Get your tasks","operationId":"get_tasks_v2_tasks_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Tasks V2 Tasks Get","type":"array","items":{"$ref":"#/components/schemas/TaskView"}}}}}},"security":[{"HTTPBearer":[]}]},"post":{"tags":["Tasks"],"summary":"Create a task","operationId":"create_task_v2_tasks_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskCreateView"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/tasks/{task_id}":{"put":{"tags":["Tasks"],"summary":"Update a task","operationId":"update_task_v2_tasks__task_id__put","parameters":[{"required":true,"schema":{"title":"Task Id","type":"integer"},"name":"task_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskCreateView"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"delete":{"tags":["Tasks"],"summary":"Delete a task","operationId":"delete_task_v2_tasks__task_id__delete","parameters":[{"required":true,"schema":{"title":"Task Id","type":"integer"},"name":"task_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/tasks/photo":{"post":{"tags":["Tasks"],"summary":"Upload task image","operationId":"upload_task_image_v2_tasks_photo_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_task_image_v2_tasks_photo_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/{user_id}/request_access":{"post":{"tags":["Sharing"],"summary":"Request access to a user","operationId":"send_request_to_user_v2_user__user_id__request_access_post","parameters":[{"required":true,"schema":{"title":"User Id","type":"integer"},"name":"user_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Send Request To User V2 User  User Id  Request Access Post","type":"array","items":{"$ref":"#/components/schemas/UserViewPublic"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/{user_id}/cancel_request":{"delete":{"tags":["Sharing"],"summary":"Cancel access request send to a user","operationId":"cancel_access_request_v2_user__user_id__cancel_request_delete","parameters":[{"required":true,"schema":{"title":"User Id","type":"integer"},"name":"user_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/{user_id}/grant_access":{"post":{"tags":["Sharing"],"summary":"Grant access to a user that has requested it","operationId":"accept_request_from_user_v2_user__user_id__grant_access_post","parameters":[{"required":true,"schema":{"title":"User Id","type":"integer"},"name":"user_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Accept Request From User V2 User  User Id  Grant Access Post","type":"array","items":{"$ref":"#/components/schemas/UserViewPublic"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/{user_id}/reject_request":{"delete":{"tags":["Sharing"],"summary":"Reject an access request from a user","operationId":"reject_request_from_user_v2_user__user_id__reject_request_delete","parameters":[{"required":true,"schema":{"title":"User Id","type":"integer"},"name":"user_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/{user_id}/revoke_access":{"delete":{"tags":["Sharing"],"summary":"Revoke access to a user","operationId":"revoke_access_to_user_v2_user__user_id__revoke_access_delete","parameters":[{"required":true,"schema":{"title":"User Id","type":"integer"},"name":"user_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/{user_id}/unfollow":{"delete":{"tags":["Sharing"],"summary":"Unfollow a user","operationId":"unfollow_user_v2_user__user_id__unfollow_delete","parameters":[{"required":true,"schema":{"title":"User Id","type":"integer"},"name":"user_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/{user_id}/star":{"post":{"tags":["Sharing"],"summary":"Star a user","operationId":"star_user_v2_user__user_id__star_post","parameters":[{"required":true,"schema":{"title":"User Id","type":"integer"},"name":"user_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"delete":{"tags":["Sharing"],"summary":"Remove a star from user","operationId":"remove_star_v2_user__user_id__star_delete","parameters":[{"required":true,"schema":{"title":"User Id","type":"integer"},"name":"user_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/chats/group":{"post":{"tags":["Chat"],"summary":"Create a group","operationId":"create_group_chat_v2_chats_group_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/chats/{chat_id}":{"get":{"tags":["Chat"],"summary":"Get a chat","operationId":"get_user_chat_v2_chats__chat_id__get","parameters":[{"required":true,"schema":{"title":"Chat Id","type":"string","format":"uuid"},"name":"chat_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"delete":{"tags":["Chat"],"summary":"Exit a chat","operationId":"close_a_chat_v2_chats__chat_id__delete","parameters":[{"required":true,"schema":{"title":"Chat Id","type":"string","format":"uuid"},"name":"chat_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/chats/{chat_id}/seen":{"post":{"tags":["Chat"],"summary":"Mark as seen","operationId":"mark_chat_seen_v2_chats__chat_id__seen_post","parameters":[{"required":true,"schema":{"title":"Chat Id","type":"string","format":"uuid"},"name":"chat_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/chats/{chat_id}/messages/{message_id}":{"get":{"tags":["Chat"],"summary":"Get chat message","operationId":"get_specific_message_v2_chats__chat_id__messages__message_id__get","parameters":[{"required":true,"schema":{"title":"Chat Id","type":"string","format":"uuid"},"name":"chat_id","in":"path"},{"required":true,"schema":{"title":"Message Id","type":"integer"},"name":"message_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/chats/{chat_id}/messages/{message_id}/reactions/{emoji_id}":{"post":{"tags":["Chat"],"summary":"Create a reaction","operationId":"create_reaction_v2_chats__chat_id__messages__message_id__reactions__emoji_id__post","parameters":[{"required":true,"schema":{"title":"Chat Id","type":"string","format":"uuid"},"name":"chat_id","in":"path"},{"required":true,"schema":{"title":"Message Id","type":"integer"},"name":"message_id","in":"path"},{"required":true,"schema":{"title":"Emoji Id","type":"string"},"name":"emoji_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"delete":{"tags":["Chat"],"summary":"Delete a reaction","operationId":"delete_a_reaction_v2_chats__chat_id__messages__message_id__reactions__emoji_id__delete","parameters":[{"required":true,"schema":{"title":"Chat Id","type":"string","format":"uuid"},"name":"chat_id","in":"path"},{"required":true,"schema":{"title":"Message Id","type":"integer"},"name":"message_id","in":"path"},{"required":true,"schema":{"title":"Emoji Id","type":"string"},"name":"emoji_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/chats/{chat_id}/messages":{"get":{"tags":["Chat"],"summary":"Get chat messages","operationId":"get_chat_messages_v2_chats__chat_id__messages_get","parameters":[{"required":true,"schema":{"title":"Chat Id","type":"string","format":"uuid"},"name":"chat_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Chat Messages V2 Chats  Chat Id  Messages Get","type":"array","items":{"$ref":"#/components/schemas/MessageView"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"post":{"tags":["Chat"],"summary":"Send a message","operationId":"send_chat_messages_v2_chats__chat_id__messages_post","parameters":[{"required":true,"schema":{"title":"Chat Id","type":"string","format":"uuid"},"name":"chat_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageSend"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/user/me/chats":{"get":{"tags":["Chat"],"summary":"Get direct messages","operationId":"get_dms_v2_user_me_chats_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Dms V2 User Me Chats Get","type":"array","items":{"$ref":"#/components/schemas/ChatSimpleView"}}}}}},"security":[{"HTTPBearer":[]}]},"post":{"tags":["Chat"],"summary":"Create direct messages","operationId":"create_dm_v2_user_me_chats_post","parameters":[{"required":true,"schema":{"title":"Recipient Id","type":"integer"},"name":"recipient_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/chats":{"get":{"tags":["Chat"],"summary":"Get all chats","operationId":"get_all_chats_v2_chats_get","parameters":[{"required":false,"schema":{"title":"Filter By","enum":["dm","group","course"],"type":"string"},"name":"filter_by","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get All Chats V2 Chats Get","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/ClassChatSimple"},{"$ref":"#/components/schemas/ChatSimpleView"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/pusher/auth":{"post":{"tags":["Pusher"],"summary":"Pusher base auth","description":"## Integration notes:\n\nPlease include the Bearer token from saturn on the pusher client, you can check how to send custom headers\non [Pusher docs about headers](https://pusher.com/docs/channels/server_api/authenticating-users#csrf-protected-authentication-endpoints)\n\n## Channels naming convetions:\n\n* Saturn channels: private-saturn@{channel_id}\n* Private user channels: private-user@{user_id}\n* User conversations channels: presence-chat@{channel_id}\n* School private **general** channel: private-{school_id}@general\n* School private **channel_id** channels: private-{school_id}@{channel_id}\n\nClient integration information available on [Pusher docs](https://pusher.com/docs/channels/server_api/authenticating-users#client-side-setting-the-channel-authentication-endpoint)","operationId":"pusher_auth_v2_pusher_auth_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PusherAuth"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/colleges":{"get":{"tags":["College"],"summary":"Search colleges","description":"Search all colleges.\n\n*Args:*\n\n    `query:` Search college by name.\n\nReturns: List of colleges found.","operationId":"search_colleges_v2_colleges_get","parameters":[{"required":true,"schema":{"title":"Query","type":"string"},"name":"query","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Search Colleges V2 Colleges Get","type":"array","items":{"$ref":"#/components/schemas/CollegeView"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/admin/upload/{file_type}":{"post":{"tags":["Admin"],"summary":"Upload data to database","operationId":"upload_file_v2_admin_upload__file_type__post","parameters":[{"required":true,"schema":{"title":"File Type","enum":["teachers","courses","blocks"],"type":"string"},"name":"file_type","in":"path"},{"required":false,"schema":{"title":"Override","type":"boolean","default":false},"name":"override","in":"query"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_file_v2_admin_upload__file_type__post"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/admin/emojis":{"get":{"tags":["Admin"],"summary":"Get emoji list","operationId":"get_emojis_v2_admin_emojis_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Emojis V2 Admin Emojis Get","type":"array","items":{"$ref":"#/components/schemas/EmojiView"}}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/admin/features":{"get":{"tags":["Admin"],"summary":"Get feature list","operationId":"get_features_v2_admin_features_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Features V2 Admin Features Get","type":"array","items":{}}}}}},"security":[{"HTTPBearer":[]}]},"patch":{"tags":["Admin"],"summary":"Add/update a new feature","operationId":"create_feature_v2_admin_features_patch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_create_feature_v2_admin_features_patch"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/admin/suspend":{"get":{"tags":["Admin"],"summary":"Get suspend list","operationId":"suspend_list_v2_admin_suspend_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Suspend List V2 Admin Suspend Get","type":"array","items":{"$ref":"#/components/schemas/SuspendItem"}}}}}},"security":[{"HTTPBearer":[]}]},"post":{"tags":["Admin"],"summary":"Suspend/ban someone","operationId":"suspend_user_v2_admin_suspend_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuspendRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/admin/suspend/{block_id}":{"delete":{"tags":["Admin"],"summary":"Unsuspend user","operationId":"unsuspend_user_v2_admin_suspend__block_id__delete","parameters":[{"required":true,"schema":{"title":"Block Id","type":"integer"},"name":"block_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/yearbook/memories":{"get":{"tags":["Yearbook"],"summary":"Get memories feed","description":"**Returns:** The school's memory feed, showing only public/private memories, ordered descending by `date_approved` *(\nfield not returned)*.","operationId":"get_memories_v2_yearbook_memories_get","parameters":[{"required":false,"schema":{"title":"Status","enum":["public","private","pending"],"type":"string"},"name":"status","in":"query"},{"required":false,"schema":{"title":"Starred Mode","type":"boolean","default":false},"name":"starred_mode","in":"query"},{"required":false,"schema":{"title":"Public Mode","type":"boolean","default":false},"name":"public_mode","in":"query"},{"required":false,"schema":{"title":"School Mode","type":"boolean","default":false},"name":"school_mode","in":"query"},{"required":false,"schema":{"title":"Image Ranked","type":"boolean","default":false},"name":"image_ranked","in":"query"},{"required":false,"schema":{"title":"Paginate","type":"boolean","default":false},"name":"paginate","in":"query"},{"required":false,"schema":{"title":"Limit","type":"integer","default":50},"name":"limit","in":"query"},{"required":false,"schema":{"title":"Page","type":"integer","default":1},"name":"page","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Memories V2 Yearbook Memories Get","type":"array","items":{"$ref":"#/components/schemas/YearbookMemoryView"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"post":{"tags":["Yearbook"],"summary":"Create a memory","description":"**Returns:** Returns the newly created object (status pending by default).","operationId":"create_memory_v2_yearbook_memories_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/YearbookMemoryCreateView"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/YearbookMemoryView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/yearbook/memories/me":{"get":{"tags":["Yearbook"],"summary":"Get my memories","description":"**Returns:** *All* memories for the current user.","operationId":"get_my_memories_v2_yearbook_memories_me_get","parameters":[{"required":false,"schema":{"title":"Status","enum":["public","private","pending"],"type":"string"},"name":"status","in":"query"},{"required":false,"schema":{"title":"Paginate","type":"boolean","default":false},"name":"paginate","in":"query"},{"required":false,"schema":{"title":"Limit","type":"integer","default":50},"name":"limit","in":"query"},{"required":false,"schema":{"title":"Page","type":"integer","default":1},"name":"page","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get My Memories V2 Yearbook Memories Me Get","type":"array","items":{"$ref":"#/components/schemas/YearbookMemoryView"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/yearbook/memories/{user_id}":{"get":{"tags":["Yearbook"],"summary":"Get memories for user","description":"**Args:**\n    `user_id`: The user to get memories for.\n\n**Returns:** `approved` memories for `user_id`.","operationId":"get_user_memories_v2_yearbook_memories__user_id__get","parameters":[{"required":true,"schema":{"title":"User Id","type":"integer"},"name":"user_id","in":"path"},{"required":false,"schema":{"title":"Paginate","type":"boolean","default":false},"name":"paginate","in":"query"},{"required":false,"schema":{"title":"Limit","type":"integer","default":50},"name":"limit","in":"query"},{"required":false,"schema":{"title":"Page","type":"integer","default":1},"name":"page","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get User Memories V2 Yearbook Memories  User Id  Get","type":"array","items":{"$ref":"#/components/schemas/YearbookMemoryView"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/yearbook/memories/{memory_id}/curate":{"patch":{"tags":["Yearbook"],"summary":"Curate memory","operationId":"curate_memory_v2_yearbook_memories__memory_id__curate_patch","parameters":[{"required":true,"schema":{"title":"Memory Id","type":"integer"},"name":"memory_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/yearbook/memories/{memory_id}":{"delete":{"tags":["Yearbook"],"summary":"Delete a memory (only to/from current user)","description":"**Args:**\n    `memory_id`: The memory id to delete - *must be owned by current user or will receive *404*.","operationId":"delete_memory_v2_yearbook_memories__memory_id__delete","parameters":[{"required":true,"schema":{"title":"Memory Id","type":"integer"},"name":"memory_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"patch":{"tags":["Yearbook"],"summary":"Update memory (that is to you)","description":"**Args:**\n    `memory_id`: The memory id to update.\n\n**Returns:** The updated memory.","operationId":"update_memory_v2_yearbook_memories__memory_id__patch","parameters":[{"required":true,"schema":{"title":"Memory Id","type":"integer"},"name":"memory_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/YearbookMemoryUpdateView"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/YearbookMemoryView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/yearbook/memories/content":{"post":{"tags":["Yearbook"],"summary":"Upload memory content","description":"**NOTE**: Unlike all other routes, this uses `FormData` and not a `JSON` body! We also are uploading all data\nbefore `POST`ing it to objects.\n\n**Args:**\n* `image`: If `file` uploaded is of type *JPG*, *PNG*, or *GIF* (ie not a signature).\n* `file`: The file being uploaded.\n* `metadata`: *MUST BE A STRING*, will be encoded to `JSON` on server, but `FormData` can't parse it otherwise.\nNote that all values returned will be {`str`: `str`}.\n\n**Returns:** The uploaded file and id, to be passed into `POST /yearbook/memories`.","operationId":"upload_memory_content_v2_yearbook_memories_content_post","parameters":[{"required":false,"schema":{"title":"Image","type":"boolean","default":false},"name":"image","in":"query"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_memory_content_v2_yearbook_memories_content_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/yearbook/users/photo":{"post":{"tags":["Yearbook"],"summary":"Upload your yearbook photo","description":"**NOTE**: Unlike all other routes, this uses `FormData` and not a `JSON` body!\n\n**Args:**\n* `file`: The file being uploaded - Must be of type *JPG*, *PNG*, or *GIF*.\n\n**Returns:** The newly uploaded yearbook photo .","operationId":"upload_yearbook_photo_v2_yearbook_users_photo_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_yearbook_photo_v2_yearbook_users_photo_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/yearbook/users/info":{"patch":{"tags":["Yearbook"],"summary":"Update your yearbook user info","operationId":"update_user_info_v2_yearbook_users_info_patch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/YearbookUserInfoEditView"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/YearbookUserInfoView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/yearbook/users":{"get":{"tags":["Yearbook"],"summary":"Get users with yearbook info","description":"*Args:*\n    `all_users`: Whether or not to show non-yearbook users too.\n\n*Returns:* Users with their attached yearbook info.","operationId":"get_yearbook_users_v2_yearbook_users_get","parameters":[{"required":false,"schema":{"title":"All Users","type":"boolean","default":false},"name":"all_users","in":"query"},{"required":false,"schema":{"title":"By Grade","enum":[8,9,10,11,12],"type":"integer"},"name":"by_grade","in":"query"},{"required":false,"schema":{"title":"By Name","type":"string"},"name":"by_name","in":"query"},{"required":false,"schema":{"title":"Paginate","type":"boolean","default":false},"name":"paginate","in":"query"},{"required":false,"schema":{"title":"Limit","type":"integer","default":50},"name":"limit","in":"query"},{"required":false,"schema":{"title":"Page","type":"integer","default":1},"name":"page","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Yearbook Users V2 Yearbook Users Get","type":"array","items":{"$ref":"#/components/schemas/YearbookUserView"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/yearbook/users/me":{"get":{"tags":["Yearbook"],"summary":"Get my user with yearbook info","operationId":"get_my_yearbook_user_v2_yearbook_users_me_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/YearbookUserView"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/yearbook/users/{user_id}":{"get":{"tags":["Yearbook"],"summary":"Get users with yearbook info","operationId":"get_yearbook_user_v2_yearbook_users__user_id__get","parameters":[{"required":true,"schema":{"title":"User Id","type":"integer"},"name":"user_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/YearbookUserView"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/yearbook/users/{user_id}/hags":{"post":{"tags":["Yearbook"],"summary":"HAGS a user","description":"Send a push notification to a user after pressing the HAGS button.\n*Args:*\n    `user_id`: The user to HAGS","operationId":"hags_user_v2_yearbook_users__user_id__hags_post","parameters":[{"required":true,"schema":{"title":"User Id","type":"integer"},"name":"user_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/contactbook":{"get":{"tags":["Contactbook"],"summary":"Get uploaded contact book","operationId":"get_contact_book_v2_contactbook_get","parameters":[{"required":false,"schema":{"title":"Paginate","type":"boolean","default":false},"name":"paginate","in":"query"},{"required":false,"schema":{"title":"Limit","type":"integer","default":50},"name":"limit","in":"query"},{"required":false,"schema":{"title":"Page","type":"integer","default":1},"name":"page","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Contact Book V2 Contactbook Get","type":"array","items":{"$ref":"#/components/schemas/Contact"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"post":{"tags":["Contactbook"],"summary":"Upload contact book","operationId":"contact_book_upload_v2_contactbook_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactBookUpload"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/contactbook/mutuals":{"get":{"tags":["Contactbook"],"summary":"Get mutual friends based on contactbook","operationId":"get_mutuals_v2_contactbook_mutuals_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Mutuals V2 Contactbook Mutuals Get","type":"array","items":{"$ref":"#/components/schemas/UserViewPublic"}}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/contactbook/recommended":{"get":{"tags":["Contactbook"],"summary":"Get recommended friends","operationId":"get_recommended_v2_contactbook_recommended_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Recommended V2 Contactbook Recommended Get","type":"array","items":{"$ref":"#/components/schemas/UserViewPublic"}}}}}},"security":[{"HTTPBearer":[]}]}}},"components":{"schemas":{"AttachmentView":{"title":"AttachmentView","required":["type"],"type":"object","properties":{"type":{"title":"Type","enum":["twitter","website","bell_schedule","modified_bell_schedule","rotation_calendar","important_dates","rotation_calendar_drive","course_teacher_drive","course_catalog","staff_directory","uploaded_asset"],"type":"string"},"url":{"title":"Url","type":"string"}}},"Body_create_feature_v2_admin_features_patch":{"title":"Body_create_feature_v2_admin_features_patch","required":["feature_name","default"],"type":"object","properties":{"feature_name":{"title":"Feature Name","type":"string"},"default":{"title":"Default","type":"boolean"},"override":{"title":"Override","type":"boolean","default":false}}},"Body_upload_file_v2_admin_upload__file_type__post":{"title":"Body_upload_file_v2_admin_upload__file_type__post","required":["file"],"type":"object","properties":{"file":{"title":"File","type":"string","format":"binary"}}},"Body_upload_memory_content_v2_yearbook_memories_content_post":{"title":"Body_upload_memory_content_v2_yearbook_memories_content_post","required":["file"],"type":"object","properties":{"file":{"title":"File","type":"string","format":"binary"},"metadata":{"title":"Metadata","type":"string"}}},"Body_upload_profile_picture_v2_user_me_profile_picture_post":{"title":"Body_upload_profile_picture_v2_user_me_profile_picture_post","required":["file"],"type":"object","properties":{"file":{"title":"File","type":"string","format":"binary"}}},"Body_upload_schedule_v2_waitlist_schedule_post":{"title":"Body_upload_schedule_v2_waitlist_schedule_post","required":["file"],"type":"object","properties":{"file":{"title":"File","type":"string","format":"binary"}}},"Body_upload_task_image_v2_tasks_photo_post":{"title":"Body_upload_task_image_v2_tasks_photo_post","required":["file"],"type":"object","properties":{"file":{"title":"File","type":"string","format":"binary"}}},"Body_upload_yearbook_photo_v2_yearbook_users_photo_post":{"title":"Body_upload_yearbook_photo_v2_yearbook_users_photo_post","required":["file"],"type":"object","properties":{"file":{"title":"File","type":"string","format":"binary"}}},"CalendarEntryView":{"title":"CalendarEntryView","required":["date","is_canceled"],"type":"object","properties":{"date":{"title":"Date","type":"string","format":"date"},"schedule":{"$ref":"#/components/schemas/SchedulesSimplifiedView"},"raw_block_name":{"title":"Raw Block Name","type":"string"},"is_canceled":{"title":"Is Canceled","type":"boolean"}}},"ChatSimpleView":{"title":"ChatSimpleView","required":["id","type","members"],"type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid"},"type":{"title":"Type","enum":["dm","group","course"],"type":"string"},"title":{"title":"Title","type":"string"},"description":{"title":"Description","type":"string"},"emoji":{"$ref":"#/components/schemas/EmojiView"},"last_message":{"$ref":"#/components/schemas/MessageView"},"members":{"title":"Members","type":"array","items":{"$ref":"#/components/schemas/UserViewPublic"}},"unseen":{"title":"Unseen","type":"integer","default":0}}},"ChatView":{"title":"ChatView","required":["id","type","members"],"type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid"},"type":{"title":"Type","enum":["dm","group","course"],"type":"string"},"title":{"title":"Title","type":"string"},"description":{"title":"Description","type":"string"},"emoji":{"$ref":"#/components/schemas/EmojiView"},"last_message":{"$ref":"#/components/schemas/MessageView"},"members":{"title":"Members","type":"array","items":{"$ref":"#/components/schemas/UserViewPublic"}},"unseen":{"title":"Unseen","type":"integer","default":0},"messages":{"title":"Messages","type":"array","items":{"$ref":"#/components/schemas/MessageView"},"default":[]}}},"ClassChatSimple":{"title":"ClassChatSimple","required":["id","type","members","locked","remaining","course"],"type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid"},"type":{"title":"Type","enum":["dm","group","course"],"type":"string"},"title":{"title":"Title","type":"string"},"description":{"title":"Description","type":"string"},"emoji":{"$ref":"#/components/schemas/EmojiView"},"last_message":{"$ref":"#/components/schemas/MessageView"},"members":{"title":"Members","type":"array","items":{"$ref":"#/components/schemas/UserViewPublic"}},"unseen":{"title":"Unseen","type":"integer","default":0},"locked":{"title":"Locked","type":"boolean"},"remaining":{"title":"Remaining","type":"integer"},"course":{"$ref":"#/components/schemas/CourseView"}}},"ClientExtra":{"title":"ClientExtra","required":["identifier"],"type":"object","properties":{"identifier":{"title":"Identifier","type":"string","format":"uuid"}}},"CollegeView":{"title":"CollegeView","required":["id","college_name"],"type":"object","properties":{"created_at":{"title":"Created At","type":"string","format":"date-time","default":"2020-06-17T03:42:19.662081"},"updated_at":{"title":"Updated At","type":"string","format":"date-time","default":"2020-06-17T03:42:19.662106"},"id":{"title":"Id","type":"integer"},"college_name":{"title":"College Name","type":"string"},"colors":{"title":"Colors","type":"array","items":{},"default":[]},"logo_url":{"title":"Logo Url","type":"string"}}},"Contact":{"title":"Contact","required":["id","appears_on"],"type":"object","properties":{"created_at":{"title":"Created At","type":"string","format":"date-time","default":"2020-06-17T03:42:21.296196"},"updated_at":{"title":"Updated At","type":"string","format":"date-time","default":"2020-06-17T03:42:21.296236"},"id":{"title":"Id","type":"integer"},"phone_numbers":{"title":"Phone Numbers","type":"array","items":{"type":"string","format":"phone","example":"+14232863668","pattern":"^[+]*[(]{0,1}[0-9]{1,4}[)]{0,1}[-\\s\\./0-9]*$","examples":["+14232863668","+551144445487"]}},"name":{"title":"Name","type":"string"},"emails":{"title":"Emails","type":"array","items":{"type":"string","format":"email"}},"appears_on":{"title":"Appears On","type":"integer"}}},"ContactBookItem":{"title":"ContactBookItem","required":["name"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"phone_numbers":{"title":"Phone Numbers","type":"array","items":{"anyOf":[{"type":"string","format":"phone","example":"+14232863668","pattern":"^[+]*[(]{0,1}[0-9]{1,4}[)]{0,1}[-\\s\\./0-9]*$","examples":["+14232863668","+551144445487"]},{"type":"string"}]},"default":[]},"emails":{"title":"Emails","type":"array","items":{"type":"string","format":"email"},"default":[]}}},"ContactBookUpload":{"title":"ContactBookUpload","required":["contacts"],"type":"object","properties":{"contacts":{"title":"Contacts","type":"array","items":{"$ref":"#/components/schemas/ContactBookItem"}}}},"ContentView":{"title":"ContentView","required":["id"],"type":"object","properties":{"id":{"title":"Id","anyOf":[{"type":"string"},{"type":"string","format":"uuid"}]},"content_type":{"title":"Content Type","enum":["png","jpg","gif","pdf","doc","docx","heic","json"],"type":"string"},"metadata":{"title":"Metadata","type":"object"},"resource_url":{"title":"Resource Url","type":"string"},"size_urls":{"$ref":"#/components/schemas/ImageSizeURLs"}}},"CourseCreateView":{"title":"CourseCreateView","required":["name","school"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"school":{"title":"School","type":"string"},"emoji_id":{"title":"Emoji Id","type":"string"}}},"CourseView":{"title":"CourseView","required":["name","school","id"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"school":{"title":"School","type":"string"},"id":{"title":"Id","type":"integer"},"emoji":{"$ref":"#/components/schemas/EmojiView"}}},"EmojiImageTypes":{"title":"EmojiImageTypes","type":"object","properties":{"gif":{"$ref":"#/components/schemas/ContentView"},"png":{"$ref":"#/components/schemas/ContentView"}}},"EmojiView":{"title":"EmojiView","required":["resources","name"],"type":"object","properties":{"resources":{"$ref":"#/components/schemas/EmojiImageTypes"},"name":{"title":"Name","type":"string"}}},"EventInstanceCreateView":{"title":"EventInstanceCreateView","type":"object","properties":{"meeting_times":{"title":"Meeting Times","type":"object"},"room":{"title":"Room","type":"string"},"staff":{"title":"Staff","type":"array","items":{"type":"integer"},"default":[]},"override":{"title":"Override","type":"boolean","default":false}}},"EventInstanceView":{"title":"EventInstanceView","required":["id","school","course"],"type":"object","properties":{"meeting_times":{"title":"Meeting Times","type":"object"},"room":{"title":"Room","type":"string"},"staff":{"title":"Staff","type":"array","items":{"$ref":"#/components/schemas/StaffView"},"default":[]},"id":{"title":"Id","type":"integer"},"school":{"title":"School","type":"string"},"course":{"$ref":"#/components/schemas/CourseView"}}},"EventInstanceViewPersonal":{"title":"EventInstanceViewPersonal","required":["id","school","course"],"type":"object","properties":{"meeting_times":{"title":"Meeting Times","type":"object"},"room":{"title":"Room","type":"string"},"staff":{"title":"Staff","type":"array","items":{"$ref":"#/components/schemas/StaffView"},"default":[]},"id":{"title":"Id","type":"integer"},"school":{"title":"School","type":"string"},"course":{"$ref":"#/components/schemas/CourseView"},"classmates":{"title":"Classmates","type":"array","items":{"$ref":"#/components/schemas/UserViewPublic"},"default":[]}}},"GroupCreate":{"title":"GroupCreate","required":["title","description","members"],"type":"object","properties":{"title":{"title":"Title","type":"string"},"description":{"title":"Description","type":"string"},"emoji_id":{"title":"Emoji Id","type":"string"},"members":{"title":"Members","type":"array","items":{"type":"integer"}}}},"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ImageSizeURLs":{"title":"ImageSizeURLs","required":["small","medium","large"],"type":"object","properties":{"small":{"title":"Small","type":"string"},"medium":{"title":"Medium","type":"string"},"large":{"title":"Large","type":"string"}}},"LeaderboardSchoolView":{"title":"LeaderboardSchoolView","required":["school_code","school_name"],"type":"object","properties":{"school_code":{"title":"School Code","type":"string"},"school_name":{"title":"School Name","type":"string"},"district_code":{"title":"District Code","type":"string"},"user_count":{"title":"User Count","type":"integer","default":0},"distance":{"title":"Distance","type":"number","default":0.0}}},"MessageAttachment":{"title":"MessageAttachment","required":["type","content"],"type":"object","properties":{"type":{"title":"Type","enum":["image","hyperlink","task","invalid"],"type":"string"},"content":{"title":"Content","anyOf":[{"type":"string","minLength":1,"maxLength":65536,"format":"uri"},{"type":"integer"},{"$ref":"#/components/schemas/TaskView"}]}}},"MessageSend":{"title":"MessageSend","required":["message"],"type":"object","properties":{"message":{"title":"Message","type":"string"},"attachments":{"title":"Attachments","type":"array","items":{"$ref":"#/components/schemas/MessageAttachment"}},"client_extra":{"$ref":"#/components/schemas/ClientExtra"}}},"MessageView":{"title":"MessageView","required":["id","from_user","to_chat","content"],"type":"object","properties":{"created_at":{"title":"Created At","type":"string","format":"date-time","default":"2020-06-17T03:42:19.959294"},"id":{"title":"Id","type":"integer"},"from_user":{"title":"From User","type":"integer"},"to_chat":{"title":"To Chat","type":"string","format":"uuid"},"content":{"title":"Content","type":"string"},"reactions":{"title":"Reactions","type":"array","items":{"$ref":"#/components/schemas/ReactionView"}},"attachments":{"title":"Attachments","type":"array","items":{"$ref":"#/components/schemas/MessageAttachment"}},"mentions":{"title":"Mentions","type":"array","items":{"$ref":"#/components/schemas/UserViewPublic"},"default":[]},"client_extra":{"$ref":"#/components/schemas/ClientExtra"}}},"PaginatedWaitlistSchools":{"title":"PaginatedWaitlistSchools","required":["tags","schools"],"type":"object","properties":{"total_user_count":{"title":"Total User Count","type":"integer","default":0},"tags":{"title":"Tags","type":"array","items":{"type":"string"}},"schools":{"title":"Schools","type":"array","items":{"$ref":"#/components/schemas/WaitlistSchoolView"}}}},"PeriodBase":{"title":"PeriodBase","required":["name","start_seconds","end_seconds","lunch","custom"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"period_id":{"title":"Period Id","anyOf":[{"type":"integer"},{"type":"string"}]},"start_seconds":{"title":"Start Seconds","type":"number","format":"time-delta"},"end_seconds":{"title":"End Seconds","type":"number","format":"time-delta"},"lunch":{"title":"Lunch","type":"boolean"},"custom":{"title":"Custom","type":"boolean"},"emoji_id":{"title":"Emoji Id","type":"string"}}},"PeriodViewUser":{"title":"PeriodViewUser","required":["name","start_seconds","end_seconds","lunch","custom","id"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"period_id":{"title":"Period Id","anyOf":[{"type":"integer"},{"type":"string"}]},"start_seconds":{"title":"Start Seconds","type":"number","format":"time-delta"},"end_seconds":{"title":"End Seconds","type":"number","format":"time-delta"},"lunch":{"title":"Lunch","type":"boolean"},"custom":{"title":"Custom","type":"boolean"},"emoji_id":{"title":"Emoji Id","type":"string"},"id":{"title":"Id","type":"integer"},"emoji":{"$ref":"#/components/schemas/EmojiView"},"instance":{"$ref":"#/components/schemas/EventInstanceView"}}},"PusherAuth":{"title":"PusherAuth","required":["channel_name","socket_id"],"type":"object","properties":{"channel_name":{"title":"Channel Name","type":"string"},"socket_id":{"title":"Socket Id","anyOf":[{"type":"string"},{"type":"number"}]}}},"ReactionView":{"title":"ReactionView","required":["from_user","type"],"type":"object","properties":{"created_at":{"title":"Created At","type":"string","format":"date-time","default":"2020-06-17T03:42:19.960099"},"from_user":{"title":"From User","type":"integer"},"type":{"title":"Type","enum":["read","emoji"],"type":"string"},"emoji":{"$ref":"#/components/schemas/EmojiView"}}},"ScheduleImageView":{"title":"ScheduleImageView","required":["id","url","starred"],"type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid"},"url":{"title":"Url","type":"string"},"starred":{"title":"Starred","type":"boolean"}}},"SchedulesCreation":{"title":"SchedulesCreation","required":["name","is_modified","schedule_type"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"is_modified":{"title":"Is Modified","type":"boolean"},"schedule_type":{"title":"Schedule Type","type":"string"},"modified_date":{"title":"Modified Date","type":"string","format":"date"},"lunch_frequencies":{"title":"Lunch Frequencies","type":"array","items":{"type":"integer"}},"lunch_length":{"title":"Lunch Length","anyOf":[{"type":"integer"},{"type":"number"}]},"periods":{"title":"Periods","type":"array","items":{"$ref":"#/components/schemas/PeriodBase"}}}},"SchedulesSimplifiedView":{"title":"SchedulesSimplifiedView","required":["id","name"],"type":"object","properties":{"id":{"title":"Id","type":"integer"},"name":{"title":"Name","type":"string"}}},"SchedulesView":{"title":"SchedulesView","required":["name","is_modified","schedule_type","id","school"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"is_modified":{"title":"Is Modified","type":"boolean"},"schedule_type":{"title":"Schedule Type","type":"string"},"modified_date":{"title":"Modified Date","type":"string","format":"date"},"lunch_frequencies":{"title":"Lunch Frequencies","type":"array","items":{"type":"integer"}},"lunch_length":{"title":"Lunch Length","anyOf":[{"type":"integer"},{"type":"number"}]},"id":{"title":"Id","type":"integer"},"school":{"title":"School","type":"string"}}},"SchedulesViewUser":{"title":"SchedulesViewUser","required":["name","is_modified","schedule_type","id","school"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"is_modified":{"title":"Is Modified","type":"boolean"},"schedule_type":{"title":"Schedule Type","type":"string"},"modified_date":{"title":"Modified Date","type":"string","format":"date"},"lunch_frequencies":{"title":"Lunch Frequencies","type":"array","items":{"type":"integer"}},"lunch_length":{"title":"Lunch Length","anyOf":[{"type":"integer"},{"type":"number"}]},"id":{"title":"Id","type":"integer"},"school":{"title":"School","type":"string"},"lunch_wave":{"title":"Lunch Wave","type":"integer"},"periods":{"title":"Periods","type":"array","items":{"$ref":"#/components/schemas/PeriodViewUser"},"default":[]}}},"SchoolCreate":{"title":"SchoolCreate","required":["school_name","status","school_title","state"],"type":"object","properties":{"school_name":{"title":"School Name","type":"string"},"status":{"title":"Status","enum":["live","suspended","waitlist"],"type":"string"},"domains":{"title":"Domains","type":"array","items":{},"default":[]},"static_schedules":{"title":"Static Schedules","type":"object"},"school_title":{"title":"School Title","type":"string"},"period_names":{"title":"Period Names","type":"object"},"lunch_length":{"title":"Lunch Length","type":"integer"},"lunch_wave_frequency":{"title":"Lunch Wave Frequency","type":"integer"},"lunch_passing_time":{"title":"Lunch Passing Time","type":"integer"},"lunch_waves":{"title":"Lunch Waves","type":"integer"},"lunch_first_wave_now":{"title":"Lunch First Wave Now","type":"boolean"},"lunch_first_wave_now_offset":{"title":"Lunch First Wave Now Offset","type":"integer"},"lunch_first_wave_pass":{"title":"Lunch First Wave Pass","type":"integer"},"lunch_last_wave_pass":{"title":"Lunch Last Wave Pass","type":"integer"},"phone_number":{"title":"Phone Number","pattern":"^[+]*[(]{0,1}[0-9]{1,4}[)]{0,1}[-\\s\\./0-9]*$","type":"string","format":"phone","example":"+14232863668"},"primary_color":{"title":"Primary Color","type":"string"},"dark_mode_color":{"title":"Dark Mode Color","type":"string"},"students_count":{"title":"Students Count","type":"integer"},"state":{"title":"State","type":"string"},"district_code":{"title":"District Code","type":"string"},"timezone":{"title":"Timezone","pattern":"^([A-Za-z]*[_/\\-\\+]*[A-Za-z0-9])*$","type":"string","format":"timezone","default":"US/Eastern","example":"US/Western"},"lat":{"title":"Lat","type":"number"},"lng":{"title":"Lng","type":"number"},"notes":{"title":"Notes","type":"string"},"schedule_tags":{"title":"Schedule Tags","type":"array","items":{},"default":[]},"private":{"title":"Private","type":"boolean","default":false}}},"SchoolLink":{"title":"SchoolLink","required":["id","type","url"],"type":"object","properties":{"id":{"title":"Id","type":"integer"},"type":{"title":"Type","enum":["twitter","website","bell_schedule","modified_bell_schedule","rotation_calendar","important_dates","rotation_calendar_drive","course_teacher_drive","course_catalog","staff_directory","uploaded_asset"]},"url":{"title":"Url","type":"string"}}},"SchoolMeta":{"title":"SchoolMeta","type":"object","properties":{"free_period_course_id":{"title":"Free Period Course Id","type":"integer"},"user_count":{"title":"User Count","type":"integer","default":0},"features":{"title":"Features","type":"object","default":{"local_schedule_change":false,"realtime_status":false,"starred_friends":false,"tasks":false}}}},"SchoolView":{"title":"SchoolView","required":["school_name","status","school_title","state"],"type":"object","properties":{"created_at":{"title":"Created At","type":"string","format":"date-time","default":"2020-06-17T03:42:15.461705"},"updated_at":{"title":"Updated At","type":"string","format":"date-time","default":"2020-06-17T03:42:15.461730"},"school_name":{"title":"School Name","type":"string"},"status":{"title":"Status","enum":["live","suspended","waitlist"],"type":"string"},"domains":{"title":"Domains","type":"array","items":{},"default":[]},"static_schedules":{"title":"Static Schedules","type":"object"},"school_title":{"title":"School Title","type":"string"},"period_names":{"title":"Period Names","type":"object"},"lunch_length":{"title":"Lunch Length","type":"integer"},"lunch_wave_frequency":{"title":"Lunch Wave Frequency","type":"integer"},"lunch_passing_time":{"title":"Lunch Passing Time","type":"integer"},"lunch_waves":{"title":"Lunch Waves","type":"integer"},"lunch_first_wave_now":{"title":"Lunch First Wave Now","type":"boolean"},"lunch_first_wave_now_offset":{"title":"Lunch First Wave Now Offset","type":"integer"},"lunch_first_wave_pass":{"title":"Lunch First Wave Pass","type":"integer"},"lunch_last_wave_pass":{"title":"Lunch Last Wave Pass","type":"integer"},"phone_number":{"title":"Phone Number","pattern":"^[+]*[(]{0,1}[0-9]{1,4}[)]{0,1}[-\\s\\./0-9]*$","type":"string","format":"phone","example":"+14232863668"},"primary_color":{"title":"Primary Color","type":"string"},"dark_mode_color":{"title":"Dark Mode Color","type":"string"},"students_count":{"title":"Students Count","type":"integer"},"state":{"title":"State","type":"string"},"district_code":{"title":"District Code","type":"string"},"timezone":{"title":"Timezone","pattern":"^([A-Za-z]*[_/\\-\\+]*[A-Za-z0-9])*$","type":"string","format":"timezone","default":"US/Eastern","example":"US/Western"},"lat":{"title":"Lat","type":"number"},"lng":{"title":"Lng","type":"number"},"notes":{"title":"Notes","type":"string"},"schedule_tags":{"title":"Schedule Tags","type":"array","items":{},"default":[]},"private":{"title":"Private","type":"boolean","default":false}}},"SchoolViewExtra":{"title":"SchoolViewExtra","required":["school_name","status","school_title","state"],"type":"object","properties":{"created_at":{"title":"Created At","type":"string","format":"date-time","default":"2020-06-17T03:42:15.461705"},"updated_at":{"title":"Updated At","type":"string","format":"date-time","default":"2020-06-17T03:42:15.461730"},"school_name":{"title":"School Name","type":"string"},"status":{"title":"Status","enum":["live","suspended","waitlist"],"type":"string"},"domains":{"title":"Domains","type":"array","items":{},"default":[]},"static_schedules":{"title":"Static Schedules","type":"object"},"school_title":{"title":"School Title","type":"string"},"period_names":{"title":"Period Names","type":"object"},"lunch_length":{"title":"Lunch Length","type":"integer"},"lunch_wave_frequency":{"title":"Lunch Wave Frequency","type":"integer"},"lunch_passing_time":{"title":"Lunch Passing Time","type":"integer"},"lunch_waves":{"title":"Lunch Waves","type":"integer"},"lunch_first_wave_now":{"title":"Lunch First Wave Now","type":"boolean"},"lunch_first_wave_now_offset":{"title":"Lunch First Wave Now Offset","type":"integer"},"lunch_first_wave_pass":{"title":"Lunch First Wave Pass","type":"integer"},"lunch_last_wave_pass":{"title":"Lunch Last Wave Pass","type":"integer"},"phone_number":{"title":"Phone Number","pattern":"^[+]*[(]{0,1}[0-9]{1,4}[)]{0,1}[-\\s\\./0-9]*$","type":"string","format":"phone","example":"+14232863668"},"primary_color":{"title":"Primary Color","type":"string"},"dark_mode_color":{"title":"Dark Mode Color","type":"string"},"students_count":{"title":"Students Count","type":"integer"},"state":{"title":"State","type":"string"},"district_code":{"title":"District Code","type":"string"},"timezone":{"title":"Timezone","pattern":"^([A-Za-z]*[_/\\-\\+]*[A-Za-z0-9])*$","type":"string","format":"timezone","default":"US/Eastern","example":"US/Western"},"lat":{"title":"Lat","type":"number"},"lng":{"title":"Lng","type":"number"},"notes":{"title":"Notes","type":"string"},"schedule_tags":{"title":"Schedule Tags","type":"array","items":{},"default":[]},"private":{"title":"Private","type":"boolean","default":false},"meta":{"$ref":"#/components/schemas/SchoolMeta"},"staff":{"title":"Staff","type":"array","items":{"$ref":"#/components/schemas/StaffView"}},"users":{"title":"Users","type":"array","items":{"$ref":"#/components/schemas/UserViewPublic"}},"courses":{"title":"Courses","type":"array","items":{"$ref":"#/components/schemas/CourseView"}},"schedules":{"title":"Schedules","type":"array","items":{"$ref":"#/components/schemas/SchedulesViewUser"}},"calendar":{"title":"Calendar","type":"array","items":{"$ref":"#/components/schemas/CalendarEntryView"}},"links":{"title":"Links","type":"array","items":{"$ref":"#/components/schemas/SchoolLink"}}}},"SchoolViewPublic":{"title":"SchoolViewPublic","required":["school_name","school_title"],"type":"object","properties":{"school_name":{"title":"School Name","type":"string"},"school_title":{"title":"School Title","type":"string"}}},"SchoolViewSearch":{"title":"SchoolViewSearch","required":["school_name","status","school_title","state"],"type":"object","properties":{"created_at":{"title":"Created At","type":"string","format":"date-time","default":"2020-06-17T03:42:15.461705"},"updated_at":{"title":"Updated At","type":"string","format":"date-time","default":"2020-06-17T03:42:15.461730"},"school_name":{"title":"School Name","type":"string"},"status":{"title":"Status","enum":["live","suspended","waitlist"],"type":"string"},"domains":{"title":"Domains","type":"array","items":{},"default":[]},"static_schedules":{"title":"Static Schedules","type":"object"},"school_title":{"title":"School Title","type":"string"},"period_names":{"title":"Period Names","type":"object"},"lunch_length":{"title":"Lunch Length","type":"integer"},"lunch_wave_frequency":{"title":"Lunch Wave Frequency","type":"integer"},"lunch_passing_time":{"title":"Lunch Passing Time","type":"integer"},"lunch_waves":{"title":"Lunch Waves","type":"integer"},"lunch_first_wave_now":{"title":"Lunch First Wave Now","type":"boolean"},"lunch_first_wave_now_offset":{"title":"Lunch First Wave Now Offset","type":"integer"},"lunch_first_wave_pass":{"title":"Lunch First Wave Pass","type":"integer"},"lunch_last_wave_pass":{"title":"Lunch Last Wave Pass","type":"integer"},"phone_number":{"title":"Phone Number","pattern":"^[+]*[(]{0,1}[0-9]{1,4}[)]{0,1}[-\\s\\./0-9]*$","type":"string","format":"phone","example":"+14232863668"},"primary_color":{"title":"Primary Color","type":"string"},"dark_mode_color":{"title":"Dark Mode Color","type":"string"},"students_count":{"title":"Students Count","type":"integer"},"state":{"title":"State","type":"string"},"district_code":{"title":"District Code","type":"string"},"timezone":{"title":"Timezone","pattern":"^([A-Za-z]*[_/\\-\\+]*[A-Za-z0-9])*$","type":"string","format":"timezone","default":"US/Eastern","example":"US/Western"},"lat":{"title":"Lat","type":"number"},"lng":{"title":"Lng","type":"number"},"notes":{"title":"Notes","type":"string"},"schedule_tags":{"title":"Schedule Tags","type":"array","items":{},"default":[]},"private":{"title":"Private","type":"boolean","default":false},"meta":{"$ref":"#/components/schemas/SchoolMeta"}}},"SharingView":{"title":"SharingView","required":["following","followers","requests_received","requests_sent"],"type":"object","properties":{"following":{"title":"Following","type":"array","items":{"$ref":"#/components/schemas/UserViewPublic"}},"followers":{"title":"Followers","type":"array","items":{"$ref":"#/components/schemas/UserViewPublic"}},"requests_received":{"title":"Requests Received","type":"array","items":{"$ref":"#/components/schemas/UserViewPublic"}},"requests_sent":{"title":"Requests Sent","type":"array","items":{"$ref":"#/components/schemas/UserViewPublic"}}}},"SignupView":{"title":"SignupView","required":["token"],"type":"object","properties":{"provider":{"title":"Provider","type":"string","default":"google"},"token":{"title":"Token","type":"string"},"school":{"title":"School","type":"string"},"waitlist":{"title":"Waitlist","type":"string"}}},"StaffCreateView":{"title":"StaffCreateView","required":["name"],"type":"object","properties":{"name":{"title":"Name","type":"string"}}},"StaffView":{"title":"StaffView","required":["name","id"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"id":{"title":"Id","type":"integer"}}},"SuspendItem":{"title":"SuspendItem","required":["id"],"type":"object","properties":{"id":{"title":"Id","type":"integer"},"email":{"title":"Email","type":"string","format":"email"},"phone_number":{"title":"Phone Number","pattern":"^[+]*[(]{0,1}[0-9]{1,4}[)]{0,1}[-\\s\\./0-9]*$","type":"string","format":"phone","example":"+14232863668"},"reason":{"title":"Reason","type":"string","default":"unknown"},"until":{"title":"Until","anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"default":"2100-01-01"}}},"SuspendRequest":{"title":"SuspendRequest","type":"object","properties":{"user_id":{"title":"User Id","type":"integer"},"email":{"title":"Email","type":"string","format":"email"},"phone_number":{"title":"Phone Number","pattern":"^[+]*[(]{0,1}[0-9]{1,4}[)]{0,1}[-\\s\\./0-9]*$","type":"string","format":"phone","example":"+14232863668"},"reason":{"title":"Reason","type":"string","default":"unknown"},"until":{"title":"Until","anyOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"default":"2100-01-01"}}},"TaskCreateView":{"title":"TaskCreateView","type":"object","properties":{"title":{"title":"Title","type":"string"},"due_date":{"title":"Due Date","type":"string","format":"date"},"due_seconds":{"title":"Due Seconds","type":"integer"},"course_id":{"title":"Course Id","type":"integer"},"is_completed":{"title":"Is Completed","type":"boolean","default":false},"images":{"title":"Images","type":"array","items":{"type":"string","format":"uuid"}}}},"TaskView":{"title":"TaskView","required":["id"],"type":"object","properties":{"id":{"title":"Id","type":"integer"},"title":{"title":"Title","type":"string"},"due_date":{"title":"Due Date","type":"string","format":"date"},"due_seconds":{"title":"Due Seconds","type":"integer"},"date_completed":{"title":"Date Completed","type":"string","format":"date"},"course_id":{"title":"Course Id","type":"integer"},"is_completed":{"title":"Is Completed","type":"boolean","default":false},"images":{"title":"Images","type":"array","items":{"$ref":"#/components/schemas/ContentView"}}}},"Token":{"title":"Token","type":"object","properties":{"token":{"title":"Token","type":"string"}}},"UserLunch":{"title":"UserLunch","required":["lunch_wave"],"type":"object","properties":{"lunch_wave":{"title":"Lunch Wave","type":"integer"}}},"UserPermissions":{"title":"UserPermissions","type":"object","properties":{"admin":{"title":"Admin","type":"boolean","default":false},"owner":{"title":"Owner","type":"boolean","default":false},"waitlist":{"title":"Waitlist","type":"boolean","default":false}}},"UserUpdateView":{"title":"UserUpdateView","type":"object","properties":{"name":{"title":"Name","type":"string"},"public":{"title":"Public","type":"boolean"},"grade":{"title":"Grade","enum":[8,9,10,11,12],"type":"integer"},"birthday":{"title":"Birthday","type":"string","format":"date"},"gender":{"title":"Gender","enum":[1,2,3],"type":"integer"},"gender_preference":{"title":"Gender Preference","enum":[1,2,3],"type":"integer"},"phone_number":{"title":"Phone Number","pattern":"^[+]*[(]{0,1}[0-9]{1,4}[)]{0,1}[-\\s\\./0-9]*$","type":"string","format":"phone","example":"+14232863668"},"url_instagram":{"title":"Url Instagram","type":"string"},"url_vsco":{"title":"Url Vsco","type":"string"},"url_snapchat":{"title":"Url Snapchat","type":"string"}}},"UserView":{"title":"UserView","required":["id","email","name"],"type":"object","properties":{"created_at":{"title":"Created At","type":"string","format":"date-time","default":"2020-06-17T03:42:15.255585"},"updated_at":{"title":"Updated At","type":"string","format":"date-time","default":"2020-06-17T03:42:15.255613"},"id":{"title":"Id","type":"integer"},"email":{"title":"Email","type":"string","format":"email"},"name":{"title":"Name","type":"string"},"profile_pic_url":{"title":"Profile Pic Url","type":"string"},"birthday":{"title":"Birthday","type":"string","format":"date"},"grade":{"title":"Grade","type":"integer"},"gender":{"title":"Gender","type":"integer"},"gender_preference":{"title":"Gender Preference","type":"integer"},"public":{"title":"Public","type":"boolean","default":true},"is_ambassador":{"title":"Is Ambassador","type":"boolean","default":false},"phone_number":{"title":"Phone Number","pattern":"^[+]*[(]{0,1}[0-9]{1,4}[)]{0,1}[-\\s\\./0-9]*$","type":"string","format":"phone","example":"+14232863668"},"phone_validated":{"title":"Phone Validated","type":"boolean","default":false},"url_instagram":{"title":"Url Instagram","type":"string"},"url_vsco":{"title":"Url Vsco","type":"string"},"url_snapchat":{"title":"Url Snapchat","type":"string"},"waitlist_school_id":{"title":"Waitlist School Id","type":"string"},"school_id":{"title":"School Id","type":"string"},"profile_picture":{"$ref":"#/components/schemas/ContentView"}}},"UserViewBirthdays":{"title":"UserViewBirthdays","required":["id","name"],"type":"object","properties":{"id":{"title":"Id","type":"integer"},"name":{"title":"Name","type":"string"},"profile_pic_url":{"title":"Profile Pic Url","type":"string"},"birthday":{"title":"Birthday","type":"string","format":"date"},"profile_picture":{"$ref":"#/components/schemas/ContentView"}}},"UserViewFull":{"title":"UserViewFull","required":["id","email","name","courses","permissions"],"type":"object","properties":{"created_at":{"title":"Created At","type":"string","format":"date-time","default":"2020-06-17T03:42:15.255585"},"updated_at":{"title":"Updated At","type":"string","format":"date-time","default":"2020-06-17T03:42:15.255613"},"id":{"title":"Id","type":"integer"},"email":{"title":"Email","type":"string","format":"email"},"name":{"title":"Name","type":"string"},"profile_pic_url":{"title":"Profile Pic Url","type":"string"},"birthday":{"title":"Birthday","type":"string","format":"date"},"grade":{"title":"Grade","type":"integer"},"gender":{"title":"Gender","type":"integer"},"gender_preference":{"title":"Gender Preference","type":"integer"},"public":{"title":"Public","type":"boolean","default":true},"is_ambassador":{"title":"Is Ambassador","type":"boolean","default":false},"phone_number":{"title":"Phone Number","pattern":"^[+]*[(]{0,1}[0-9]{1,4}[)]{0,1}[-\\s\\./0-9]*$","type":"string","format":"phone","example":"+14232863668"},"phone_validated":{"title":"Phone Validated","type":"boolean","default":false},"url_instagram":{"title":"Url Instagram","type":"string"},"url_vsco":{"title":"Url Vsco","type":"string"},"url_snapchat":{"title":"Url Snapchat","type":"string"},"waitlist_school_id":{"title":"Waitlist School Id","type":"string"},"school_id":{"title":"School Id","type":"string"},"profile_picture":{"$ref":"#/components/schemas/ContentView"},"school_title":{"title":"School Title","type":"string"},"school":{"title":"School","type":"string"},"waitlist_school":{"title":"Waitlist School","type":"string"},"courses":{"title":"Courses","type":"array","items":{}},"permissions":{"$ref":"#/components/schemas/UserPermissions"}}},"UserViewPublic":{"title":"UserViewPublic","required":["id","email","name"],"type":"object","properties":{"id":{"title":"Id","type":"integer"},"email":{"title":"Email","type":"string","format":"email"},"name":{"title":"Name","type":"string"},"profile_pic_url":{"title":"Profile Pic Url","type":"string"},"grade":{"title":"Grade","type":"integer"},"public":{"title":"Public","type":"boolean"},"profile_picture":{"$ref":"#/components/schemas/ContentView"}}},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"type":"string"}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}},"WailtistLeaderboardView":{"title":"WailtistLeaderboardView","required":["id"],"type":"object","properties":{"id":{"title":"Id","type":"string"},"schools":{"title":"Schools","type":"array","items":{"$ref":"#/components/schemas/WaitlistSchoolPublicView"},"default":[]}}},"WaitlistSchoolConvert":{"title":"WaitlistSchoolConvert","required":["domains","timezone"],"type":"object","properties":{"domains":{"title":"Domains","type":"array","items":{"type":"string"}},"timezone":{"title":"Timezone","type":"string"},"convert_district":{"title":"Convert District","type":"boolean","default":false}}},"WaitlistSchoolCreate":{"title":"WaitlistSchoolCreate","required":["school_code"],"type":"object","properties":{"school_code":{"title":"School Code","type":"string"},"school_name":{"title":"School Name","type":"string"},"state":{"title":"State","type":"string"},"students_count":{"title":"Students Count","type":"integer"},"accepting_uploads":{"title":"Accepting Uploads","type":"boolean"},"schedule_tags":{"title":"Schedule Tags","type":"array","items":{"type":"string"}},"lat":{"title":"Lat","type":"number"},"lng":{"title":"Lng","type":"number"},"display":{"title":"Display","type":"boolean"},"private":{"title":"Private","type":"boolean","default":false}}},"WaitlistSchoolPublicView":{"title":"WaitlistSchoolPublicView","required":["school_code","school_name","state","private"],"type":"object","properties":{"school_code":{"title":"School Code","type":"string"},"school_name":{"title":"School Name","type":"string"},"state":{"title":"State","type":"string"},"district_name":{"title":"District Name","type":"string"},"private":{"title":"Private","type":"boolean"},"user_count":{"title":"User Count","type":"integer","default":0},"accepting_uploads":{"title":"Accepting Uploads","type":"boolean","default":true},"is_user_school":{"title":"Is User School","type":"boolean","default":false}}},"WaitlistSchoolUpdate":{"title":"WaitlistSchoolUpdate","type":"object","properties":{"school_name":{"title":"School Name","type":"string"},"state":{"title":"State","type":"string"},"students_count":{"title":"Students Count","type":"integer"},"accepting_uploads":{"title":"Accepting Uploads","type":"boolean"},"schedule_tags":{"title":"Schedule Tags","type":"array","items":{"type":"string"}},"lat":{"title":"Lat","type":"number"},"lng":{"title":"Lng","type":"number"},"display":{"title":"Display","type":"boolean"},"private":{"title":"Private","type":"boolean"}}},"WaitlistSchoolView":{"title":"WaitlistSchoolView","required":["school_code","school_name","state","usage_percentage","images","display","converted","private"],"type":"object","properties":{"school_code":{"title":"School Code","type":"string"},"school_name":{"title":"School Name","type":"string"},"state":{"title":"State","type":"string"},"district_code":{"title":"District Code","type":"string"},"students_count":{"title":"Students Count","type":"integer"},"user_count":{"title":"User Count","type":"integer","default":0},"usage_percentage":{"title":"Usage Percentage","type":"number"},"accepting_uploads":{"title":"Accepting Uploads","type":"boolean","default":true},"schedule_tags":{"title":"Schedule Tags","type":"array","items":{"type":"string"}},"images":{"title":"Images","anyOf":[{"type":"integer"},{"$ref":"#/components/schemas/ScheduleImageView"}]},"lat":{"title":"Lat","type":"number"},"lng":{"title":"Lng","type":"number"},"display":{"title":"Display","type":"boolean"},"converted":{"title":"Converted","type":"boolean"},"private":{"title":"Private","type":"boolean"},"district_school_count":{"title":"District School Count","type":"integer","default":0},"leaderboard":{"title":"Leaderboard","type":"array","items":{"$ref":"#/components/schemas/LeaderboardSchoolView"},"default":[]}}},"WaitlistSignupView":{"title":"WaitlistSignupView","required":["name","school","phone_number","email"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"school":{"title":"School","type":"string"},"phone_number":{"title":"Phone Number","type":"string"},"email":{"title":"Email","type":"string"},"referral_code":{"title":"Referral Code","type":"string"}}},"WaitlistUserUpdate":{"title":"WaitlistUserUpdate","type":"object","properties":{"name":{"title":"Name","type":"string"},"email":{"title":"Email","type":"string","format":"email"},"tags":{"title":"Tags","type":"array","items":{"type":"string"}}}},"WaitlistUserView":{"title":"WaitlistUserView","required":["id","name","waitlist_school_id","waitlist_count","created_at"],"type":"object","properties":{"id":{"title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"waitlist_school_id":{"title":"Waitlist School Id","type":"string"},"waitlist_count":{"title":"Waitlist Count","type":"integer"},"phone_number":{"title":"Phone Number","type":"string"},"email":{"title":"Email","type":"string"},"refers":{"title":"Refers","type":"integer","default":0},"tags":{"title":"Tags","type":"array","items":{"type":"string"},"default":[]},"image":{"$ref":"#/components/schemas/ScheduleImageView"},"created_at":{"title":"Created At","type":"string","format":"date-time"}}},"YearbookMemoryCreateView":{"title":"YearbookMemoryCreateView","required":["message"],"type":"object","properties":{"to_user_id":{"title":"To User Id","type":"integer"},"to_contact_id":{"title":"To Contact Id","type":"integer"},"message":{"title":"Message","type":"string"},"image_id":{"title":"Image Id","type":"string","format":"uuid"},"signature_id":{"title":"Signature Id","type":"string","format":"uuid"}}},"YearbookMemoryUpdateView":{"title":"YearbookMemoryUpdateView","required":["status"],"type":"object","properties":{"status":{"title":"Status","enum":["public","private","pending"],"type":"string"}}},"YearbookMemoryView":{"title":"YearbookMemoryView","required":["id","message","status","to_user","from_user"],"type":"object","properties":{"created_at":{"title":"Created At","type":"string","format":"date-time","default":"2020-06-17T03:42:19.678483"},"updated_at":{"title":"Updated At","type":"string","format":"date-time","default":"2020-06-17T03:42:19.678507"},"id":{"title":"Id","type":"integer"},"message":{"title":"Message","type":"string"},"status":{"title":"Status","enum":["public","private","pending"],"type":"string"},"curated":{"title":"Curated","type":"boolean","default":false},"signature":{"$ref":"#/components/schemas/ContentView"},"image":{"$ref":"#/components/schemas/ContentView"},"to_user":{"$ref":"#/components/schemas/YearbookUserShortView"},"from_user":{"$ref":"#/components/schemas/YearbookUserShortView"}}},"YearbookUserInfoEditView":{"title":"YearbookUserInfoEditView","type":"object","properties":{"senior_quote":{"title":"Senior Quote","type":"string"},"college_id":{"title":"College Id","type":"integer"}}},"YearbookUserInfoView":{"title":"YearbookUserInfoView","type":"object","properties":{"senior_quote":{"title":"Senior Quote","type":"string"},"yearbook_photo":{"$ref":"#/components/schemas/ContentView"},"college":{"$ref":"#/components/schemas/CollegeView"}}},"YearbookUserShortView":{"title":"YearbookUserShortView","required":["id","name","starred"],"type":"object","properties":{"id":{"title":"Id","type":"integer"},"name":{"title":"Name","type":"string"},"starred":{"title":"Starred","type":"boolean"}}},"YearbookUserView":{"title":"YearbookUserView","required":["id","email","name","starred"],"type":"object","properties":{"id":{"title":"Id","type":"integer"},"email":{"title":"Email","type":"string","format":"email"},"name":{"title":"Name","type":"string"},"profile_pic_url":{"title":"Profile Pic Url","type":"string"},"grade":{"title":"Grade","type":"integer"},"public":{"title":"Public","type":"boolean"},"profile_picture":{"$ref":"#/components/schemas/ContentView"},"yearbook_info":{"$ref":"#/components/schemas/YearbookUserInfoView"},"starred":{"title":"Starred","type":"boolean"},"starred_back":{"title":"Starred Back","type":"boolean","default":false}}}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}}}}