kindergarten_java/reading-platform-frontend/openapi.json

1 line
204 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:8080","description":"Generated server url"}],"security":[{"Bearer":[]}],"tags":[{"name":"Teacher - Notification","description":"Notification APIs for Teacher"},{"name":"School - Task","description":"Task Management APIs for School"},{"name":"Parent - Task","description":"Task APIs for Parent"},{"name":"School - Student","description":"Student Management APIs for School"},{"name":"Auth","description":"Authentication APIs"},{"name":"Admin - Tenant","description":"Tenant Management APIs for Admin"},{"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 - Course","description":"System Course Management APIs for Admin"},{"name":"School - Teacher","description":"Teacher Management APIs for School"},{"name":"School - Parent","description":"Parent Management APIs for School"},{"name":"Parent - Child","description":"Child Information APIs for Parent"},{"name":"Teacher - Growth Record","description":"Growth Record APIs for Teacher"},{"name":"Teacher - Task","description":"Task 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/admin/themes/{id}":{"get":{"tags":["超管端 - 主题字典"],"summary":"查询主题详情","operationId":"findOne","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"405":{"description":"Method Not Allowed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultTheme"}}}}}},"put":{"tags":["超管端 - 主题字典"],"summary":"更新主题","operationId":"update","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeCreateRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"405":{"description":"Method Not Allowed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultTheme"}}}}}},"delete":{"tags":["超管端 - 主题字典"],"summary":"删除主题","operationId":"delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/component