kindergarten_java/reading-platform-frontend/api-spec.json

1 line
215 KiB
JSON
Raw Normal View History

{"openapi":"3.0.1","info":{"title":"Reading Platform API","description":"Reading Platform Backend Service API Documentation","contact":{"name":"Reading Platform Team","email":"support@reading-platform.com"},"version":"1.0.0"},"servers":[{"url":"http://localhost:3002","description":"Generated server url"}],"security":[{"Bearer":[]}],"tags":[{"name":"School - Course Packages","description":"Course Packages for School"},{"name":"Admin - Operation Logs","description":"Operation Log Management for Admin"},{"name":"School - School Courses","description":"School Custom Course Management"},{"name":"School - Task","description":"Task Management APIs for School"},{"name":"Admin - Settings","description":"Admin System Settings Management"},{"name":"Parent - Task","description":"Task APIs for Parent"},{"name":"Auth","description":"Authentication APIs"},{"name":"Admin - Tenant","description":"Tenant Management APIs for Admin"},{"name":"Teacher - Schedule","description":"Teacher Schedule View"},{"name":"Admin - Stats","description":"Admin Statistics Dashboard"},{"name":"Admin - Resources","description":"Resource Library Management for Admin"},{"name":"Admin - Course","description":"System Course Management APIs for Admin"},{"name":"Teacher - School Courses","description":"School Courses for Teacher"},{"name":"School - Operation Logs","description":"Operation Log for School"},{"name":"School - Stats","description":"School Statistics Dashboard"},{"name":"School - Schedule","description":"School Schedule Management"},{"name":"School - Parent","description":"Parent Management APIs for School"},{"name":"Parent - Child","description":"Child Information APIs for Parent"},{"name":"Teacher - Task","description":"Task APIs for Teacher"},{"name":"School - Export","description":"School Data Export"},{"name":"Teacher - Notification","description":"Notification APIs for Teacher"},{"name":"School - Student","description":"Student Management APIs for School"},{"name":"School - Class","description":"Class Management APIs for School"},{"name":"Parent - Growth Record","description":"Growth Record APIs for Parent"},{"name":"Teacher - Course","description":"Course APIs for Teacher"},{"name":"Admin - Themes","description":"Theme Management for Admin"},{"name":"Admin - Course Lessons","description":"Course Lesson Management for Admin"},{"name":"School - Settings","description":"School Settings Management"},{"name":"Teacher - Course Lessons","description":"Course Lessons for Teacher"},{"name":"Teacher - Dashboard","description":"Teacher Dashboard"},{"name":"Admin - Course Packages","description":"Course Package Management for Admin"},{"name":"School - Teacher","description":"Teacher Management APIs for School"},{"name":"File Upload","description":"File Upload APIs"},{"name":"Teacher - Growth Record","description":"Growth Record APIs for Teacher"},{"name":"Teacher - Lesson","description":"Lesson APIs for Teacher"},{"name":"School - Growth Record","description":"Growth Record Management APIs for School"},{"name":"Parent - Notification","description":"Notification APIs for Parent"}],"paths":{"/api/v1/teacher/tasks/{id}":{"get":{"tags":["Teacher - Task"],"summary":"Get task by ID","operationId":"getTask","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"405":{"description":"Method Not Allowed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultTask"}}