Page MenuHomePhabricator
Files F14037067

D14791.diff
No OneTemporary
Actions

D14791.diff
View Options

diff --git a/src/applications/owners/editor/PhabricatorOwnersPackageEditEngine.php b/src/applications/owners/editor/PhabricatorOwnersPackageEditEngine.php
--- a/src/applications/owners/editor/PhabricatorOwnersPackageEditEngine.php
+++ b/src/applications/owners/editor/PhabricatorOwnersPackageEditEngine.php
@@ -44,6 +44,35 @@
}
protected function buildCustomEditFields($object) {
+
+ $paths_help = pht(<<<EOTEXT
+When updating the paths for a package, pass a list of dictionaries like
+this as the `value` for the transaction:
+
+```lang=json, name="Example Paths Value"
+[
+ {
+ "repositoryPHID": "PHID-REPO-1234",
+ "path": "/path/to/directory/",
+ "excluded": false
+ },
+ {
+ "repositoryPHID": "PHID-REPO-1234",
+ "path": "/another/example/path/",
+ "excluded": false
+ }
+]
+```
+
+This transaction will set the paths to the list you provide, overwriting any
+previous paths.
+
+Generally, you will call `owners.search` first to get a list of current paths
+(which are provided in the same format), make changes, then update them by
+applying a transaction of this type.
+EOTEXT
+ );
+
return array(
id(new PhabricatorTextEditField())
->setKey('name')
@@ -95,7 +124,8 @@
->setLabel(pht('Paths'))
->setDescription(pht('Set paths for this package.'))
->setIsConduitOnly(true)
- ->setTransactionType(PhabricatorOwnersPackageTransaction::TYPE_PATHS),
+ ->setTransactionType(PhabricatorOwnersPackageTransaction::TYPE_PATHS)
+ ->setConduitDocumentation($paths_help),
);
}
diff --git a/src/applications/transactions/editengine/PhabricatorEditEngineAPIMethod.php b/src/applications/transactions/editengine/PhabricatorEditEngineAPIMethod.php
--- a/src/applications/transactions/editengine/PhabricatorEditEngineAPIMethod.php
+++ b/src/applications/transactions/editengine/PhabricatorEditEngineAPIMethod.php
@@ -173,6 +173,12 @@
$type->getTransactionType());
$section[] = null;
+ $type_documentation = $type->getConduitDocumentation();
+ if ($type_documentation) {
+ $section[] = $type_documentation;
+ $section[] = null;
+ }
+
$type_description = pht(
'Use `%s` to select this edit type.',
$type->getEditType());
diff --git a/src/applications/transactions/editfield/PhabricatorEditField.php b/src/applications/transactions/editfield/PhabricatorEditField.php
--- a/src/applications/transactions/editfield/PhabricatorEditField.php
+++ b/src/applications/transactions/editfield/PhabricatorEditField.php
@@ -15,6 +15,7 @@
private $description;
private $editTypeKey;
private $isRequired;
+ private $conduitDocumentation;
private $commentActionLabel;
private $commentActionValue;
@@ -553,7 +554,8 @@
->setEditType($type_key)
->setTransactionType($transaction_type)
->setDescription($this->getDescription())
- ->setMetadata($this->getMetadata());
+ ->setMetadata($this->getMetadata())
+ ->setConduitDocumentation($this->getConduitDocumentation());
}
public function getConduitEditTypes() {
@@ -677,4 +679,13 @@
return $edit_type->generateTransactions($template, $spec);
}
+ public function setConduitDocumentation($conduit_documentation) {
+ $this->conduitDocumentation = $conduit_documentation;
+ return $this;
+ }
+
+ public function getConduitDocumentation() {
+ return $this->conduitDocumentation;
+ }
+
}
diff --git a/src/applications/transactions/edittype/PhabricatorEditType.php b/src/applications/transactions/edittype/PhabricatorEditType.php
--- a/src/applications/transactions/edittype/PhabricatorEditType.php
+++ b/src/applications/transactions/edittype/PhabricatorEditType.php
@@ -9,6 +9,7 @@
private $description;
private $summary;
private $metadata = array();
+ private $conduitDocumentation;
public function setDescription($description) {
$this->description = $description;
@@ -58,6 +59,15 @@
return $this->editType;
}
+ public function setConduitDocumentation($conduit_documentation) {
+ $this->conduitDocumentation = $conduit_documentation;
+ return $this;
+ }
+
+ public function getConduitDocumentation() {
+ return $this->conduitDocumentation;
+ }
+
public function setMetadata($metadata) {
$this->metadata = $metadata;
return $this;

File Metadata

Mime Type
text/plain
Expires
Mon, Nov 11, 1:41 PM (1 w, 21 h ago)
Storage Engine
blob
Storage Format
Encrypted (AES-256-CBC)
Storage Handle
6739349
Default Alt Text
D14791.diff (4 KB)

Event Timeline

Phabricator · Built by Phacility