diff --git a/.divinerconfig b/.divinerconfig index e20237a757..415bf4e95f 100644 --- a/.divinerconfig +++ b/.divinerconfig @@ -12,6 +12,7 @@ "diffusion" : "Diffusion (Repository Browser)", "maniphest" : "Maniphest (Task Tracking)", "herald" : "Herald (Notifications)", + "conduit" : "Conduit (Phabricator HTTP API)", "celerity" : "Celerity (CSS/JS Management)", "aphront" : "Aphront (Web Stack)", "console" : "DarkConsole (Debugging Console)", diff --git a/src/applications/conduit/controller/api/PhabricatorConduitAPIController.php b/src/applications/conduit/controller/api/PhabricatorConduitAPIController.php index 35a10d9d4b..cad7fa289c 100644 --- a/src/applications/conduit/controller/api/PhabricatorConduitAPIController.php +++ b/src/applications/conduit/controller/api/PhabricatorConduitAPIController.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class PhabricatorConduitAPIController extends PhabricatorConduitController { diff --git a/src/applications/conduit/controller/base/PhabricatorConduitController.php b/src/applications/conduit/controller/base/PhabricatorConduitController.php index 2af8cdbd54..3bf54fa81f 100644 --- a/src/applications/conduit/controller/base/PhabricatorConduitController.php +++ b/src/applications/conduit/controller/base/PhabricatorConduitController.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ abstract class PhabricatorConduitController extends PhabricatorController { public function buildStandardPageResponse($view, array $data) { diff --git a/src/applications/conduit/controller/console/PhabricatorConduitConsoleController.php b/src/applications/conduit/controller/console/PhabricatorConduitConsoleController.php index 4ffb6087fb..d0a2608b59 100644 --- a/src/applications/conduit/controller/console/PhabricatorConduitConsoleController.php +++ b/src/applications/conduit/controller/console/PhabricatorConduitConsoleController.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class PhabricatorConduitConsoleController extends PhabricatorConduitController { diff --git a/src/applications/conduit/controller/log/PhabricatorConduitLogController.php b/src/applications/conduit/controller/log/PhabricatorConduitLogController.php index 0b9433cb11..74206aa9aa 100644 --- a/src/applications/conduit/controller/log/PhabricatorConduitLogController.php +++ b/src/applications/conduit/controller/log/PhabricatorConduitLogController.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class PhabricatorConduitLogController extends PhabricatorConduitController { public function processRequest() { diff --git a/src/applications/conduit/controller/token/PhabricatorConduitTokenController.php b/src/applications/conduit/controller/token/PhabricatorConduitTokenController.php index 4fe6a55942..d340af76fd 100644 --- a/src/applications/conduit/controller/token/PhabricatorConduitTokenController.php +++ b/src/applications/conduit/controller/token/PhabricatorConduitTokenController.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class PhabricatorConduitTokenController extends PhabricatorConduitController { public function processRequest() { diff --git a/src/applications/conduit/method/base/ConduitAPIMethod.php b/src/applications/conduit/method/base/ConduitAPIMethod.php index 5f38e4220f..7f04f9cb69 100644 --- a/src/applications/conduit/method/base/ConduitAPIMethod.php +++ b/src/applications/conduit/method/base/ConduitAPIMethod.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ abstract class ConduitAPIMethod { abstract public function getMethodDescription(); diff --git a/src/applications/conduit/method/conduit/connect/ConduitAPI_conduit_connect_Method.php b/src/applications/conduit/method/conduit/connect/ConduitAPI_conduit_connect_Method.php index b6723c7938..6637c8a2f4 100644 --- a/src/applications/conduit/method/conduit/connect/ConduitAPI_conduit_connect_Method.php +++ b/src/applications/conduit/method/conduit/connect/ConduitAPI_conduit_connect_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_conduit_connect_Method extends ConduitAPIMethod { public function shouldRequireAuthentication() { diff --git a/src/applications/conduit/method/conduit/getcertificate/ConduitAPI_conduit_getcertificate_Method.php b/src/applications/conduit/method/conduit/getcertificate/ConduitAPI_conduit_getcertificate_Method.php index 7c4101169e..f7f90d5938 100644 --- a/src/applications/conduit/method/conduit/getcertificate/ConduitAPI_conduit_getcertificate_Method.php +++ b/src/applications/conduit/method/conduit/getcertificate/ConduitAPI_conduit_getcertificate_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_conduit_getcertificate_Method extends ConduitAPIMethod { public function shouldRequireAuthentication() { diff --git a/src/applications/conduit/method/conduit/ping/ConduitAPI_conduit_ping_Method.php b/src/applications/conduit/method/conduit/ping/ConduitAPI_conduit_ping_Method.php index 137348ea21..f3c33b6963 100644 --- a/src/applications/conduit/method/conduit/ping/ConduitAPI_conduit_ping_Method.php +++ b/src/applications/conduit/method/conduit/ping/ConduitAPI_conduit_ping_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_conduit_ping_Method extends ConduitAPIMethod { public function shouldRequireAuthentication() { diff --git a/src/applications/conduit/method/daemon/launched/ConduitAPI_daemon_launched_Method.php b/src/applications/conduit/method/daemon/launched/ConduitAPI_daemon_launched_Method.php index fb27edbfd4..6c7b3e02e2 100644 --- a/src/applications/conduit/method/daemon/launched/ConduitAPI_daemon_launched_Method.php +++ b/src/applications/conduit/method/daemon/launched/ConduitAPI_daemon_launched_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_daemon_launched_Method extends ConduitAPIMethod { public function shouldRequireAuthentication() { diff --git a/src/applications/conduit/method/daemon/log/ConduitAPI_daemon_log_Method.php b/src/applications/conduit/method/daemon/log/ConduitAPI_daemon_log_Method.php index 4847e4b260..f7ba004d09 100644 --- a/src/applications/conduit/method/daemon/log/ConduitAPI_daemon_log_Method.php +++ b/src/applications/conduit/method/daemon/log/ConduitAPI_daemon_log_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_daemon_log_Method extends ConduitAPIMethod { public function shouldRequireAuthentication() { diff --git a/src/applications/conduit/method/differential/creatediff/ConduitAPI_differential_creatediff_Method.php b/src/applications/conduit/method/differential/creatediff/ConduitAPI_differential_creatediff_Method.php index 324cb40d03..52342b534c 100644 --- a/src/applications/conduit/method/differential/creatediff/ConduitAPI_differential_creatediff_Method.php +++ b/src/applications/conduit/method/differential/creatediff/ConduitAPI_differential_creatediff_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_differential_creatediff_Method extends ConduitAPIMethod { public function getMethodDescription() { diff --git a/src/applications/conduit/method/differential/createrevision/ConduitAPI_differential_createrevision_Method.php b/src/applications/conduit/method/differential/createrevision/ConduitAPI_differential_createrevision_Method.php index 29a9cf4f5c..dd4ff2e4f2 100644 --- a/src/applications/conduit/method/differential/createrevision/ConduitAPI_differential_createrevision_Method.php +++ b/src/applications/conduit/method/differential/createrevision/ConduitAPI_differential_createrevision_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_differential_createrevision_Method extends ConduitAPIMethod { public function getMethodDescription() { diff --git a/src/applications/conduit/method/differential/find/ConduitAPI_differential_find_Method.php b/src/applications/conduit/method/differential/find/ConduitAPI_differential_find_Method.php index 9983150496..a6084762c4 100644 --- a/src/applications/conduit/method/differential/find/ConduitAPI_differential_find_Method.php +++ b/src/applications/conduit/method/differential/find/ConduitAPI_differential_find_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_differential_find_Method extends ConduitAPIMethod { public function getMethodDescription() { diff --git a/src/applications/conduit/method/differential/getalldiffs/ConduitAPI_differential_getalldiffs_Method.php b/src/applications/conduit/method/differential/getalldiffs/ConduitAPI_differential_getalldiffs_Method.php index 93eb01d22b..527f0c146b 100644 --- a/src/applications/conduit/method/differential/getalldiffs/ConduitAPI_differential_getalldiffs_Method.php +++ b/src/applications/conduit/method/differential/getalldiffs/ConduitAPI_differential_getalldiffs_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_differential_getalldiffs_Method extends ConduitAPIMethod { public function getMethodDescription() { diff --git a/src/applications/conduit/method/differential/getcommitmessage/ConduitAPI_differential_getcommitmessage_Method.php b/src/applications/conduit/method/differential/getcommitmessage/ConduitAPI_differential_getcommitmessage_Method.php index a61e5db669..b5b9b0c9c5 100644 --- a/src/applications/conduit/method/differential/getcommitmessage/ConduitAPI_differential_getcommitmessage_Method.php +++ b/src/applications/conduit/method/differential/getcommitmessage/ConduitAPI_differential_getcommitmessage_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_differential_getcommitmessage_Method extends ConduitAPIMethod { public function getMethodDescription() { diff --git a/src/applications/conduit/method/differential/getcommitpaths/ConduitAPI_differential_getcommitpaths_Method.php b/src/applications/conduit/method/differential/getcommitpaths/ConduitAPI_differential_getcommitpaths_Method.php index 8511b8fd54..cf39f4de71 100644 --- a/src/applications/conduit/method/differential/getcommitpaths/ConduitAPI_differential_getcommitpaths_Method.php +++ b/src/applications/conduit/method/differential/getcommitpaths/ConduitAPI_differential_getcommitpaths_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_differential_getcommitpaths_Method extends ConduitAPIMethod { public function getMethodDescription() { diff --git a/src/applications/conduit/method/differential/getdiff/ConduitAPI_differential_getdiff_Method.php b/src/applications/conduit/method/differential/getdiff/ConduitAPI_differential_getdiff_Method.php index 48428e18a2..f49ab8db04 100644 --- a/src/applications/conduit/method/differential/getdiff/ConduitAPI_differential_getdiff_Method.php +++ b/src/applications/conduit/method/differential/getdiff/ConduitAPI_differential_getdiff_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_differential_getdiff_Method extends ConduitAPIMethod { public function getMethodDescription() { diff --git a/src/applications/conduit/method/differential/getrevision/ConduitAPI_differential_getrevision_Method.php b/src/applications/conduit/method/differential/getrevision/ConduitAPI_differential_getrevision_Method.php index be5b6a016f..a633d3e6d1 100644 --- a/src/applications/conduit/method/differential/getrevision/ConduitAPI_differential_getrevision_Method.php +++ b/src/applications/conduit/method/differential/getrevision/ConduitAPI_differential_getrevision_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_differential_getrevision_Method extends ConduitAPIMethod { public function getMethodDescription() { diff --git a/src/applications/conduit/method/differential/getrevisionfeedback/ConduitAPI_differential_getrevisionfeedback_Method.php b/src/applications/conduit/method/differential/getrevisionfeedback/ConduitAPI_differential_getrevisionfeedback_Method.php index fcd351d309..253d1b8c90 100644 --- a/src/applications/conduit/method/differential/getrevisionfeedback/ConduitAPI_differential_getrevisionfeedback_Method.php +++ b/src/applications/conduit/method/differential/getrevisionfeedback/ConduitAPI_differential_getrevisionfeedback_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_differential_getrevisionfeedback_Method extends ConduitAPIMethod { diff --git a/src/applications/conduit/method/differential/markcommitted/ConduitAPI_differential_markcommitted_Method.php b/src/applications/conduit/method/differential/markcommitted/ConduitAPI_differential_markcommitted_Method.php index ccc959a173..d06253b663 100644 --- a/src/applications/conduit/method/differential/markcommitted/ConduitAPI_differential_markcommitted_Method.php +++ b/src/applications/conduit/method/differential/markcommitted/ConduitAPI_differential_markcommitted_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_differential_markcommitted_Method extends ConduitAPIMethod { public function getMethodDescription() { diff --git a/src/applications/conduit/method/differential/parsecommitmessage/ConduitAPI_differential_parsecommitmessage_Method.php b/src/applications/conduit/method/differential/parsecommitmessage/ConduitAPI_differential_parsecommitmessage_Method.php index 2e4058a4c6..b3feedabbb 100644 --- a/src/applications/conduit/method/differential/parsecommitmessage/ConduitAPI_differential_parsecommitmessage_Method.php +++ b/src/applications/conduit/method/differential/parsecommitmessage/ConduitAPI_differential_parsecommitmessage_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_differential_parsecommitmessage_Method extends ConduitAPIMethod { diff --git a/src/applications/conduit/method/differential/setdiffproperty/ConduitAPI_differential_setdiffproperty_Method.php b/src/applications/conduit/method/differential/setdiffproperty/ConduitAPI_differential_setdiffproperty_Method.php index 07afed39d6..44e1840227 100644 --- a/src/applications/conduit/method/differential/setdiffproperty/ConduitAPI_differential_setdiffproperty_Method.php +++ b/src/applications/conduit/method/differential/setdiffproperty/ConduitAPI_differential_setdiffproperty_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_differential_setdiffproperty_Method extends ConduitAPIMethod { public function getMethodDescription() { diff --git a/src/applications/conduit/method/differential/updaterevision/ConduitAPI_differential_updaterevision_Method.php b/src/applications/conduit/method/differential/updaterevision/ConduitAPI_differential_updaterevision_Method.php index 7acc5824c9..633761b4ed 100644 --- a/src/applications/conduit/method/differential/updaterevision/ConduitAPI_differential_updaterevision_Method.php +++ b/src/applications/conduit/method/differential/updaterevision/ConduitAPI_differential_updaterevision_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_differential_updaterevision_Method extends ConduitAPIMethod { public function getMethodDescription() { diff --git a/src/applications/conduit/method/differential/updatetaskrevisionassoc/ConduitAPI_differential_updatetaskrevisionassoc_Method.php b/src/applications/conduit/method/differential/updatetaskrevisionassoc/ConduitAPI_differential_updatetaskrevisionassoc_Method.php index 45a3a6829b..9bc2f54712 100644 --- a/src/applications/conduit/method/differential/updatetaskrevisionassoc/ConduitAPI_differential_updatetaskrevisionassoc_Method.php +++ b/src/applications/conduit/method/differential/updatetaskrevisionassoc/ConduitAPI_differential_updatetaskrevisionassoc_Method.php @@ -16,8 +16,12 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_differential_updatetaskrevisionassoc_Method extends ConduitAPIMethod { + public function getMethodDescription() { return "Given a task together with its original and new associated ". "revisions, update the revisions for their attached_tasks."; diff --git a/src/applications/conduit/method/differential/updateunitresults/ConduitAPI_differential_updateunitresults_Method.php b/src/applications/conduit/method/differential/updateunitresults/ConduitAPI_differential_updateunitresults_Method.php index 97eb8b3d84..5c2b498022 100644 --- a/src/applications/conduit/method/differential/updateunitresults/ConduitAPI_differential_updateunitresults_Method.php +++ b/src/applications/conduit/method/differential/updateunitresults/ConduitAPI_differential_updateunitresults_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_differential_updateunitresults_Method extends ConduitAPIMethod { diff --git a/src/applications/conduit/method/diffusion/getcommits/ConduitAPI_diffusion_getcommits_Method.php b/src/applications/conduit/method/diffusion/getcommits/ConduitAPI_diffusion_getcommits_Method.php index 29800e95de..e78db350eb 100644 --- a/src/applications/conduit/method/diffusion/getcommits/ConduitAPI_diffusion_getcommits_Method.php +++ b/src/applications/conduit/method/diffusion/getcommits/ConduitAPI_diffusion_getcommits_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_diffusion_getcommits_Method extends ConduitAPIMethod { public function getMethodDescription() { diff --git a/src/applications/conduit/method/diffusion/getrecentcommitsbypath/ConduitAPI_diffusion_getrecentcommitsbypath_Method.php b/src/applications/conduit/method/diffusion/getrecentcommitsbypath/ConduitAPI_diffusion_getrecentcommitsbypath_Method.php index 0bafc2aaa2..d5f9bb8378 100644 --- a/src/applications/conduit/method/diffusion/getrecentcommitsbypath/ConduitAPI_diffusion_getrecentcommitsbypath_Method.php +++ b/src/applications/conduit/method/diffusion/getrecentcommitsbypath/ConduitAPI_diffusion_getrecentcommitsbypath_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_diffusion_getrecentcommitsbypath_Method extends ConduitAPIMethod { diff --git a/src/applications/conduit/method/file/download/ConduitAPI_file_download_Method.php b/src/applications/conduit/method/file/download/ConduitAPI_file_download_Method.php index 989b26c941..14d8be1f83 100644 --- a/src/applications/conduit/method/file/download/ConduitAPI_file_download_Method.php +++ b/src/applications/conduit/method/file/download/ConduitAPI_file_download_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_file_download_Method extends ConduitAPIMethod { public function getMethodDescription() { diff --git a/src/applications/conduit/method/file/upload/ConduitAPI_file_upload_Method.php b/src/applications/conduit/method/file/upload/ConduitAPI_file_upload_Method.php index 308852418a..4dd4897277 100644 --- a/src/applications/conduit/method/file/upload/ConduitAPI_file_upload_Method.php +++ b/src/applications/conduit/method/file/upload/ConduitAPI_file_upload_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_file_upload_Method extends ConduitAPIMethod { public function getMethodDescription() { diff --git a/src/applications/conduit/method/maniphest/info/ConduitAPI_maniphest_info_Method.php b/src/applications/conduit/method/maniphest/info/ConduitAPI_maniphest_info_Method.php index 0abd32faa3..d6f15cc48d 100644 --- a/src/applications/conduit/method/maniphest/info/ConduitAPI_maniphest_info_Method.php +++ b/src/applications/conduit/method/maniphest/info/ConduitAPI_maniphest_info_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_maniphest_info_Method extends ConduitAPIMethod { public function getMethodDescription() { diff --git a/src/applications/conduit/method/paste/info/ConduitAPI_paste_info_Method.php b/src/applications/conduit/method/paste/info/ConduitAPI_paste_info_Method.php index 45cbde1882..fea93f258b 100644 --- a/src/applications/conduit/method/paste/info/ConduitAPI_paste_info_Method.php +++ b/src/applications/conduit/method/paste/info/ConduitAPI_paste_info_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_paste_info_Method extends ConduitAPIMethod { public function getMethodDescription() { diff --git a/src/applications/conduit/method/path/getowners/ConduitAPI_path_getowners_Method.php b/src/applications/conduit/method/path/getowners/ConduitAPI_path_getowners_Method.php index be28ce67b9..98130633d1 100644 --- a/src/applications/conduit/method/path/getowners/ConduitAPI_path_getowners_Method.php +++ b/src/applications/conduit/method/path/getowners/ConduitAPI_path_getowners_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_path_getowners_Method extends ConduitAPIMethod { public function getMethodDescription() { diff --git a/src/applications/conduit/method/user/find/ConduitAPI_user_find_Method.php b/src/applications/conduit/method/user/find/ConduitAPI_user_find_Method.php index 4659e0d570..06b98f7294 100644 --- a/src/applications/conduit/method/user/find/ConduitAPI_user_find_Method.php +++ b/src/applications/conduit/method/user/find/ConduitAPI_user_find_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_user_find_Method extends ConduitAPIMethod { public function getMethodDescription() { diff --git a/src/applications/conduit/method/user/whoami/ConduitAPI_user_whoami_Method.php b/src/applications/conduit/method/user/whoami/ConduitAPI_user_whoami_Method.php index f2feb82856..904b867fa3 100644 --- a/src/applications/conduit/method/user/whoami/ConduitAPI_user_whoami_Method.php +++ b/src/applications/conduit/method/user/whoami/ConduitAPI_user_whoami_Method.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPI_user_whoami_Method extends ConduitAPIMethod { public function getMethodDescription() { diff --git a/src/applications/conduit/protocol/exception/ConduitException.php b/src/applications/conduit/protocol/exception/ConduitException.php index 069d0a8ab8..a168a77ad4 100644 --- a/src/applications/conduit/protocol/exception/ConduitException.php +++ b/src/applications/conduit/protocol/exception/ConduitException.php @@ -16,5 +16,8 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitException extends Exception { } diff --git a/src/applications/conduit/protocol/request/ConduitAPIRequest.php b/src/applications/conduit/protocol/request/ConduitAPIRequest.php index 1393f35908..d22099f3e0 100644 --- a/src/applications/conduit/protocol/request/ConduitAPIRequest.php +++ b/src/applications/conduit/protocol/request/ConduitAPIRequest.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class ConduitAPIRequest { protected $params; diff --git a/src/applications/conduit/storage/base/PhabricatorConduitDAO.php b/src/applications/conduit/storage/base/PhabricatorConduitDAO.php index 15b79793ff..117059f8ae 100644 --- a/src/applications/conduit/storage/base/PhabricatorConduitDAO.php +++ b/src/applications/conduit/storage/base/PhabricatorConduitDAO.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ abstract class PhabricatorConduitDAO extends PhabricatorLiskDAO { public function getApplicationName() { diff --git a/src/applications/conduit/storage/connectionlog/PhabricatorConduitConnectionLog.php b/src/applications/conduit/storage/connectionlog/PhabricatorConduitConnectionLog.php index e1de62be0c..deb4462966 100644 --- a/src/applications/conduit/storage/connectionlog/PhabricatorConduitConnectionLog.php +++ b/src/applications/conduit/storage/connectionlog/PhabricatorConduitConnectionLog.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class PhabricatorConduitConnectionLog extends PhabricatorConduitDAO { protected $client; diff --git a/src/applications/conduit/storage/methodcalllog/PhabricatorConduitMethodCallLog.php b/src/applications/conduit/storage/methodcalllog/PhabricatorConduitMethodCallLog.php index 7a79d47ade..a44aa9c522 100644 --- a/src/applications/conduit/storage/methodcalllog/PhabricatorConduitMethodCallLog.php +++ b/src/applications/conduit/storage/methodcalllog/PhabricatorConduitMethodCallLog.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class PhabricatorConduitMethodCallLog extends PhabricatorConduitDAO { protected $connectionID; diff --git a/src/applications/conduit/storage/token/PhabricatorConduitCertificateToken.php b/src/applications/conduit/storage/token/PhabricatorConduitCertificateToken.php index 7cdc414313..f8578a3e79 100644 --- a/src/applications/conduit/storage/token/PhabricatorConduitCertificateToken.php +++ b/src/applications/conduit/storage/token/PhabricatorConduitCertificateToken.php @@ -16,6 +16,9 @@ * limitations under the License. */ +/** + * @group conduit + */ class PhabricatorConduitCertificateToken extends PhabricatorConduitDAO { protected $userPHID; diff --git a/src/docs/technical/conduit.diviner b/src/docs/technical/conduit.diviner new file mode 100644 index 0000000000..a5c3523bb3 --- /dev/null +++ b/src/docs/technical/conduit.diviner @@ -0,0 +1,57 @@ +@title Conduit Technical Documentation +@group conduit + +Technical overview of the Conduit API. + += Overview = + +Conduit is an informal mechanism for transferring ad-hoc JSON blobs around on +the internet. + +Theoretically, it provides an API to Phabricator so external scripts (including +scripts written in other languages) can interface with the applications in the +Phabricator suite. It technically does this, sort of, but it is unstable and +incomplete so you should keep your expectations very low if you choose to build +things on top of it. + +NOTE: Hopefully, this should improve over time, but making Conduit more robust +isn't currently a major project priority because there isn't much demand for it +outside of internal scripts. If you want to use Conduit to build things on top +of Phabricator, let us know so we can adjust priorities. + +Conduit provides an authenticated HTTP API for Phabricator. It is informal and +extremely simple: you post a JSON blob and you get a JSON blob back. You can +access Conduit in PHP with @{class@libphutil:ConduitClient}, or in any language +by executing ##arc call-conduit method## (see ##arc help call-conduit## for +more information). You can see and test available methods at ##/conduit/## in +the web interface. + +Arcanist is implemented using Conduit, and @{class:PhabricatorIRCBot} is +intended as a practical example of how to write a program which interfaces with +Phabricator over Conduit. + += Class Relationships = + +The primary Conduit workflow is exposed at ##/api/##, which routes to +@{class:PhabricatorConduitAPIController}. This controller builds a +@{class:ConduitAPIRequest} representing authentication information and POST +parameters, instantiates an appropriate subclass of @{class:ConduitAPIMethod}, +and passes the request to it. Subclasses of @{class:ConduitAPIMethod} implement +the actual methods which Conduit exposes. + +Conduit calls which fail throw @{class:ConduitException}, which the controller +handles. + +There is a web interface for viewing and testing Conduit called the "Conduit +Console", implemented by @{class:PhabricatorConduitConsoleController} at +##/conduit/##. + +A log of connections and calls is stored by +@{class:PhabriatorConduitConnectionLog} and +@{class:PhabricatorConduitMethodCallLog}, and can be accessed on the web via +@{class:PhabricatorConduitLogController} at ##/conduit/log/##. + +Conduit provides a token-based handshake mechanism used by +##arc install-certificate## at ##/conduit/token/##, implemented by +@{class:PhabricatorConduitTokenController} which stores generated tokens using +@{class:PhabricatorConduitCertificateToken}. \ No newline at end of file diff --git a/src/storage/queryfx/queryfx.php b/src/storage/queryfx/queryfx.php index 6195d9c88e..39fd5be254 100644 --- a/src/storage/queryfx/queryfx.php +++ b/src/storage/queryfx/queryfx.php @@ -57,6 +57,9 @@ function queryfx_one($conn, $sql/*, ... */) { return null; } +/** + * @group storage + */ function vqueryfx_all($conn, $sql, array $argv) { array_unshift($argv, $conn, $sql); call_user_func_array('queryfx', $argv);