_apidoc.js 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. // ------------------------------------------------------------------------------------------
  2. // General apiDoc documentation blocks and old history blocks.
  3. // ------------------------------------------------------------------------------------------
  4. // ------------------------------------------------------------------------------------------
  5. // Current Success.
  6. // ------------------------------------------------------------------------------------------
  7. // ------------------------------------------------------------------------------------------
  8. // Current Errors.
  9. // ------------------------------------------------------------------------------------------
  10. /**
  11. * @apiDefine ServerError
  12. * @apiVersion 0.0.1
  13. *
  14. * @apiErrorExample Response (example):
  15. * HTTP/1.1 200
  16. * {
  17. * "status":"1",
  18. * "data":{},
  19. * "msg":"error_1002"
  20. * }
  21. */
  22. // ------------------------------------------------------------------------------------------
  23. // Current Permissions.
  24. // ------------------------------------------------------------------------------------------
  25. /**
  26. * @apiDefine ServerSUCCESS
  27. * @apiVersion 0.0.1
  28. *
  29. * @apiErrorExample Response (example):
  30. * HTTP/1.1 200
  31. * {
  32. * "status":"0",
  33. * "data":{},
  34. * "msg":""
  35. * }
  36. */