Просмотр исходного кода

API/service layout deprecation warning

James Allen 11 лет назад
Родитель
Сommit
1a4b8f4269
1 измененных файлов с 6 добавлено и 1 удалено
  1. 6 1
      services/track-changes/app/coffee/WebApiManager.coffee

+ 6 - 1
services/track-changes/app/coffee/WebApiManager.coffee

@@ -2,6 +2,11 @@ request = require "request"
 logger = require "logger-sharelatex"
 Settings = require "settings-sharelatex"
 
+# DEPRECATED! This method of getting user details via track-changes is deprecated
+# in the way we lay out our services.
+# Instead, web should be responsible for collecting the raw data (user_ids) and
+# filling it out with calls to other services. All API calls should create a
+# tree-like structure as much as possible, with web as the root.
 module.exports = WebApiManager =
 	sendRequest: (url, callback = (error, body) ->) ->
 		request.get {
@@ -56,4 +61,4 @@ module.exports = WebApiManager =
 				project = JSON.parse(body)
 			catch error
 				return callback(error)
-			callback null, project
+			callback null, project