@recaptime-dev's working patches + fork for Phorge, a community fork of Phabricator. (Upstream dev and stable branches are at upstream/main and upstream/stable respectively.) hq.recaptime.dev/wiki/Phorge
phorge phabricator

Conduit: Add some missing parameter descriptions

Summary: Add missing descriptions to parameters of (mostly) search related API endpoints.

Test Plan:
* Go to http://phorge.localhost/conduit/method/diffusion.uri.edit/, scroll to the "mfa" table, see a description for "value"
* Go to http://phorge.localhost/conduit/method/phurls.search/, scroll to the Constraints table, see missing parameter descriptions
* Go to http://phorge.localhost/conduit/method/maniphest.search/, scroll to the Constraints table, see missing parameters descriptions
* Repeat for the rest of the touched files

Reviewers: O1 Blessed Committers, valerio.bozzolan

Reviewed By: O1 Blessed Committers, valerio.bozzolan

Subscribers: tobiaswiese, valerio.bozzolan, Matthew, Cigaryno

Differential Revision: https://we.phorge.it/D26449

+106 -18
+2
src/applications/auth/engineextension/PhabricatorAuthMFAEditEngineExtension.php
··· 43 43 ->setActionDescription( 44 44 pht('You will be prompted to provide MFA when you submit.')) 45 45 ->setDescription(pht('Sign this transaction group with MFA.')) 46 + ->setConduitTypeDescription( 47 + pht('True to sign this transaction group with MFA.')) 46 48 ->setTransactionType($mfa_type); 47 49 48 50 return array(
+2
src/applications/badges/query/PhabricatorBadgesSearchEngine.php
··· 29 29 id(new PhabricatorSearchCheckboxesField()) 30 30 ->setKey('statuses') 31 31 ->setLabel(pht('Status')) 32 + ->setDescription( 33 + pht('Search for active or archived badges.')) 32 34 ->setOptions( 33 35 id(new PhabricatorBadgesBadge()) 34 36 ->getStatusNameMap()),
+9
src/applications/calendar/query/PhabricatorCalendarEventSearchEngine.php
··· 32 32 ->setLabel(pht('Hosts')) 33 33 ->setKey('hostPHIDs') 34 34 ->setAliases(array('host', 'hostPHID', 'hosts')) 35 + ->setDescription( 36 + pht('Search for events created by specific hosts.')) 35 37 ->setDatasource(new PhabricatorPeopleUserFunctionDatasource()), 36 38 id(new PhabricatorSearchDatasourceField()) 37 39 ->setLabel(pht('Invited')) 38 40 ->setKey('invitedPHIDs') 41 + ->setDescription( 42 + pht('Search for events with specific invited users.')) 39 43 ->setDatasource(new PhabricatorCalendarInviteeDatasource()), 40 44 id(new PhabricatorSearchDateControlField()) 41 45 ->setLabel(pht('Occurs After')) ··· 52 56 id(new PhabricatorSearchSelectField()) 53 57 ->setLabel(pht('Cancelled Events')) 54 58 ->setKey('isCancelled') 59 + ->setDescription(pht('Search for active or cancelled events.')) 55 60 ->setOptions($this->getCancelledOptions()) 56 61 ->setDefault('active'), 57 62 id(new PhabricatorPHIDsSearchField()) 58 63 ->setLabel(pht('Import Sources')) 59 64 ->setKey('importSourcePHIDs') 65 + ->setDescription( 66 + pht('Search for events with specific import sources.')) 60 67 ->setAliases(array('importSourcePHID')), 61 68 id(new PhabricatorSearchSelectField()) 62 69 ->setLabel(pht('Display Options')) 63 70 ->setKey('display') 71 + ->setDescription( 72 + pht('Display events in a certain display format.')) 64 73 ->setOptions($this->getViewOptions()) 65 74 ->setDefault('month'), 66 75 );
+2
src/applications/countdown/query/PhabricatorCountdownSearchEngine.php
··· 34 34 id(new PhabricatorUsersSearchField()) 35 35 ->setLabel(pht('Authors')) 36 36 ->setKey('authorPHIDs') 37 + ->setDescription( 38 + pht('Search for objects created by specific authors.')) 37 39 ->setAliases(array('author', 'authors')), 38 40 id(new PhabricatorSearchCheckboxesField()) 39 41 ->setKey('upcoming')
+1
src/applications/drydock/query/DrydockBlueprintSearchEngine.php
··· 38 38 id(new PhabricatorSearchThreeStateField()) 39 39 ->setLabel(pht('Disabled')) 40 40 ->setKey('isDisabled') 41 + ->setDescription(pht('Search for disabled or enabled blueprints.')) 41 42 ->setOptions( 42 43 pht('(Show All)'), 43 44 pht('Show Only Disabled Blueprints'),
+1
src/applications/drydock/query/DrydockLeaseSearchEngine.php
··· 56 56 id(new PhabricatorSearchCheckboxesField()) 57 57 ->setLabel(pht('Statuses')) 58 58 ->setKey('statuses') 59 + ->setDescription(pht('Search for objects with given statuses.')) 59 60 ->setOptions(DrydockLeaseStatus::getStatusMap()), 60 61 id(new PhabricatorPHIDsSearchField()) 61 62 ->setLabel(pht('Owners'))
+1
src/applications/drydock/query/DrydockResourceSearchEngine.php
··· 52 52 id(new PhabricatorSearchCheckboxesField()) 53 53 ->setLabel(pht('Statuses')) 54 54 ->setKey('statuses') 55 + ->setDescription(pht('Search for objects with given statuses.')) 55 56 ->setOptions(DrydockResourceStatus::getStatusMap()), 56 57 id(new PhabricatorPHIDsSearchField()) 57 58 ->setLabel(pht('Blueprints'))
+11 -3
src/applications/files/query/PhabricatorFileSearchEngine.php
··· 26 26 id(new PhabricatorUsersSearchField()) 27 27 ->setKey('authorPHIDs') 28 28 ->setAliases(array('author', 'authors')) 29 - ->setLabel(pht('Authors')), 29 + ->setLabel(pht('Authors')) 30 + ->setDescription( 31 + pht('Search for objects created by specific authors.')), 30 32 id(new PhabricatorSearchThreeStateField()) 31 33 ->setKey('explicit') 32 34 ->setLabel(pht('Upload Source')) 35 + ->setDescription( 36 + pht('Search for files which were explicitly uploaded.')) 33 37 ->setOptions( 34 38 pht('(Show All)'), 35 39 pht('Show Only Manually Uploaded Files'), 36 40 pht('Hide Manually Uploaded Files')), 37 41 id(new PhabricatorSearchDateField()) 38 42 ->setKey('createdStart') 39 - ->setLabel(pht('Created After')), 43 + ->setLabel(pht('Created After')) 44 + ->setDescription( 45 + pht('Search for files created after a certain date.')), 40 46 id(new PhabricatorSearchDateField()) 41 47 ->setKey('createdEnd') 42 - ->setLabel(pht('Created Before')), 48 + ->setLabel(pht('Created Before')) 49 + ->setDescription( 50 + pht('Search for files created before a certain date.')), 43 51 id(new PhabricatorSearchTextField()) 44 52 ->setLabel(pht('Name Contains')) 45 53 ->setKey('name')
+6 -2
src/applications/legalpad/query/LegalpadDocumentSearchEngine.php
··· 38 38 pht('Search for documents with given contributors.')), 39 39 id(new PhabricatorSearchDateField()) 40 40 ->setLabel(pht('Created After')) 41 - ->setKey('createdStart'), 41 + ->setKey('createdStart') 42 + ->setDescription( 43 + pht('Search for documents created after a certain date.')), 42 44 id(new PhabricatorSearchDateField()) 43 45 ->setLabel(pht('Created Before')) 44 - ->setKey('createdEnd'), 46 + ->setKey('createdEnd') 47 + ->setDescription( 48 + pht('Search for documents created before a certain date.')), 45 49 ); 46 50 } 47 51
+6 -2
src/applications/legalpad/query/LegalpadDocumentSignatureSearchEngine.php
··· 37 37 'given string.')), 38 38 id(new PhabricatorSearchDateField()) 39 39 ->setLabel(pht('Created After')) 40 - ->setKey('createdStart'), 40 + ->setKey('createdStart') 41 + ->setDescription( 42 + pht('Search for signatures created after a certain date.')), 41 43 id(new PhabricatorSearchDateField()) 42 44 ->setLabel(pht('Created Before')) 43 - ->setKey('createdEnd'), 45 + ->setKey('createdEnd') 46 + ->setDescription( 47 + pht('Search for signatures created before a certain date.')), 44 48 ); 45 49 } 46 50
+32 -9
src/applications/maniphest/query/ManiphestTaskSearchEngine.php
··· 89 89 id(new PhabricatorPHIDsSearchField()) 90 90 ->setLabel(pht('Columns')) 91 91 ->setKey('columnPHIDs') 92 - ->setAliases(array('column', 'columnPHID', 'columns')), 92 + ->setAliases(array('column', 'columnPHID', 'columns')) 93 + ->setDescription( 94 + pht('Search for tasks in specific workboard columns.')), 93 95 id(new PhabricatorSearchThreeStateField()) 94 96 ->setLabel(pht('Open Parents')) 95 97 ->setKey('hasParents') 96 98 ->setAliases(array('blocking')) 99 + ->setDescription( 100 + pht('Search for tasks which block open parent tasks.')) 97 101 ->setOptions( 98 102 pht('(Show All)'), 99 103 pht('Show Only Tasks With Open Parents'), ··· 102 106 ->setLabel(pht('Open Subtasks')) 103 107 ->setKey('hasSubtasks') 104 108 ->setAliases(array('blocked')) 109 + ->setDescription( 110 + pht('Search for tasks blocked by open subtasks.')) 105 111 ->setOptions( 106 112 pht('(Show All)'), 107 113 pht('Show Only Tasks With Open Subtasks'), ··· 109 115 id(new PhabricatorIDsSearchField()) 110 116 ->setLabel(pht('Parent IDs')) 111 117 ->setKey('parentIDs') 112 - ->setAliases(array('parentID')), 118 + ->setAliases(array('parentID')) 119 + ->setDescription( 120 + pht('Search for tasks which have specific parent tasks.')), 113 121 id(new PhabricatorIDsSearchField()) 114 122 ->setLabel(pht('Subtask IDs')) 115 123 ->setKey('subtaskIDs') 116 - ->setAliases(array('subtaskID')), 124 + ->setAliases(array('subtaskID')) 125 + ->setDescription( 126 + pht('Search for tasks which have specific subtasks.')), 117 127 id(new PhabricatorSearchSelectField()) 118 128 ->setLabel(pht('Group By')) 119 129 ->setKey('group') 130 + ->setDescription(pht('Group results by a certain parameter.')) 120 131 ->setOptions($this->getGroupOptions()), 121 132 id(new PhabricatorSearchDateField()) 122 133 ->setLabel(pht('Created After')) 123 - ->setKey('createdStart'), 134 + ->setKey('createdStart') 135 + ->setDescription( 136 + pht('Search for tasks created after a certain date.')), 124 137 id(new PhabricatorSearchDateField()) 125 138 ->setLabel(pht('Created Before')) 126 - ->setKey('createdEnd'), 139 + ->setKey('createdEnd') 140 + ->setDescription( 141 + pht('Search for tasks created before a certain date.')), 127 142 id(new PhabricatorSearchDateField()) 128 143 ->setLabel(pht('Updated After')) 129 - ->setKey('modifiedStart'), 144 + ->setKey('modifiedStart') 145 + ->setDescription( 146 + pht('Search for tasks updated after a certain date.')), 130 147 id(new PhabricatorSearchDateField()) 131 148 ->setLabel(pht('Updated Before')) 132 - ->setKey('modifiedEnd'), 149 + ->setKey('modifiedEnd') 150 + ->setDescription( 151 + pht('Search for tasks updated before a certain date.')), 133 152 id(new PhabricatorSearchDateField()) 134 153 ->setLabel(pht('Closed After')) 135 - ->setKey('closedStart'), 154 + ->setKey('closedStart') 155 + ->setDescription( 156 + pht('Search for tasks closed after a certain date.')), 136 157 id(new PhabricatorSearchDateField()) 137 158 ->setLabel(pht('Closed Before')) 138 - ->setKey('closedEnd'), 159 + ->setKey('closedEnd') 160 + ->setDescription( 161 + pht('Search for tasks closed before a certain date.')), 139 162 id(new PhabricatorUsersSearchField()) 140 163 ->setLabel(pht('Closed By')) 141 164 ->setKey('closerPHIDs')
+1
src/applications/phame/query/PhameBlogSearchEngine.php
··· 29 29 id(new PhabricatorSearchSelectField()) 30 30 ->setKey('statuses') 31 31 ->setLabel(pht('Status')) 32 + ->setDescription(pht('Search for blogs with given statuses.')) 32 33 ->setOptions(array( 33 34 '' => pht('All'), 34 35 PhameBlog::STATUS_ACTIVE => pht('Active'),
+1
src/applications/phame/query/PhamePostSearchEngine.php
··· 34 34 id(new PhabricatorSearchCheckboxesField()) 35 35 ->setKey('visibility') 36 36 ->setLabel(pht('Visibility')) 37 + ->setDescription(pht('Search for posts with specific visibility.')) 37 38 ->setOptions( 38 39 array( 39 40 PhameConstants::VISIBILITY_PUBLISHED => pht('Published'),
+7
src/applications/phriction/query/PhrictionDocumentSearchEngine.php
··· 43 43 id(new PhabricatorSearchCheckboxesField()) 44 44 ->setKey('statuses') 45 45 ->setLabel(pht('Status')) 46 + ->setDescription(pht('Search for objects with given statuses.')) 46 47 ->setOptions(PhrictionDocumentStatus::getStatusMap()), 47 48 id(new PhabricatorSearchStringListField()) 48 49 ->setKey('paths') 49 50 ->setIsHidden(true) 51 + ->setDescription( 52 + pht('Find documents with specified paths (slugs).')) 50 53 ->setLabel(pht('Paths')), 51 54 id(new PhabricatorSearchStringListField()) 52 55 ->setKey('parentPaths') 53 56 ->setIsHidden(true) 57 + ->setDescription( 58 + pht('Find documents beneath specified parent paths.')) 54 59 ->setLabel(pht('Parent Paths')), 55 60 id(new PhabricatorSearchStringListField()) 56 61 ->setKey('ancestorPaths') 57 62 ->setIsHidden(true) 63 + ->setDescription( 64 + pht('Find documents beneath specified ancestor paths.')) 58 65 ->setLabel(pht('Ancestor Paths')), 59 66 ); 60 67 }
+2
src/applications/phurl/query/PhabricatorPhurlURLSearchEngine.php
··· 24 24 id(new PhabricatorSearchDatasourceField()) 25 25 ->setLabel(pht('Created By')) 26 26 ->setKey('authorPHIDs') 27 + ->setDescription( 28 + pht('Search for Phurl URLs created by specific authors.')) 27 29 ->setDatasource(new PhabricatorPeopleUserFunctionDatasource()), 28 30 id(new PhabricatorSearchTextField()) 29 31 ->setLabel(pht('Name Contains'))
+2
src/applications/project/query/PhabricatorProjectColumnSearchEngine.php
··· 25 25 ->setLabel(pht('Projects')) 26 26 ->setKey('projectPHIDs') 27 27 ->setConduitKey('projects') 28 + ->setDescription( 29 + pht('Search for objects with specific project PHIDs.')) 28 30 ->setAliases(array('project', 'projects', 'projectPHID')), 29 31 ); 30 32 }
+4
src/applications/project/query/PhabricatorProjectSearchEngine.php
··· 44 44 ->setLabel(pht('Members')) 45 45 ->setKey('memberPHIDs') 46 46 ->setConduitKey('members') 47 + ->setDescription(pht('Search for projects with particular members.')) 47 48 ->setAliases(array('member', 'members')), 48 49 id(new PhabricatorUsersSearchField()) 49 50 ->setLabel(pht('Watchers')) 50 51 ->setKey('watcherPHIDs') 51 52 ->setConduitKey('watchers') 53 + ->setDescription(pht('Search for projects with particular watchers.')) 52 54 ->setAliases(array('watcher', 'watchers')), 53 55 id(new PhabricatorSearchSelectField()) 54 56 ->setLabel(pht('Status')) ··· 105 107 id(new PhabricatorSearchCheckboxesField()) 106 108 ->setLabel(pht('Icons')) 107 109 ->setKey('icons') 110 + ->setDescription(pht('Search for projects with particular icons.')) 108 111 ->setOptions($this->getIconOptions()), 109 112 id(new PhabricatorSearchCheckboxesField()) 110 113 ->setLabel(pht('Colors')) 111 114 ->setKey('colors') 115 + ->setDescription(pht('Search for projects with particular colors.')) 112 116 ->setOptions($this->getColorOptions()), 113 117 id(new PhabricatorPHIDsSearchField()) 114 118 ->setLabel(pht('Parent Projects'))
+14 -2
src/applications/repository/query/PhabricatorRepositorySearchEngine.php
··· 23 23 return array( 24 24 id(new PhabricatorSearchStringListField()) 25 25 ->setLabel(pht('Callsigns')) 26 - ->setKey('callsigns'), 26 + ->setKey('callsigns') 27 + ->setDescription( 28 + pht('Search for repositories with specific callsigns.')), 27 29 id(new PhabricatorSearchStringListField()) 28 30 ->setLabel(pht('Short Names')) 29 - ->setKey('shortNames'), 31 + ->setKey('shortNames') 32 + ->setDescription( 33 + pht('Search for repositories with specific short names.')), 30 34 id(new PhabricatorSearchSelectField()) 31 35 ->setLabel(pht('Status')) 32 36 ->setKey('status') 37 + ->setDescription( 38 + pht('Search for repositories with a specific status.')) 33 39 ->setOptions($this->getStatusOptions()), 34 40 id(new PhabricatorSearchSelectField()) 35 41 ->setLabel(pht('Hosted')) 36 42 ->setKey('hosted') 43 + ->setDescription( 44 + pht('Search for repositories which are hosted or remote.')) 37 45 ->setOptions($this->getHostedOptions()), 38 46 id(new PhabricatorSearchCheckboxesField()) 39 47 ->setLabel(pht('Types')) 40 48 ->setKey('types') 49 + ->setDescription( 50 + pht('Search for repositories of a specific VCS type.')) 41 51 ->setOptions(PhabricatorRepositoryType::getAllRepositoryTypes()), 42 52 id(new PhabricatorSearchStringListField()) 43 53 ->setLabel(pht('URIs')) ··· 47 57 id(new PhabricatorPHIDsSearchField()) 48 58 ->setLabel(pht('Services')) 49 59 ->setKey('almanacServicePHIDs') 60 + ->setDescription( 61 + pht('Search for repositories with a specific Almanac Service.')) 50 62 ->setAliases( 51 63 array( 52 64 'almanacServicePHID',
+2
src/applications/slowvote/query/PhabricatorSlowvoteSearchEngine.php
··· 42 42 id(new PhabricatorUsersSearchField()) 43 43 ->setKey('authorPHIDs') 44 44 ->setAliases(array('authors')) 45 + ->setDescription( 46 + pht('Search for objects created by specific authors.')) 45 47 ->setLabel(pht('Authors')), 46 48 id(new PhabricatorSearchCheckboxesField()) 47 49 ->setKey('voted')