@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
Fix two minor display issues with the Conduit "*.search" API documentation
Summary:
Depends on D20685. Ref T13350. Currently:
- When a SearchEngine parameter is marked as hidden from Conduit, we may still render a table of possible values. Instead, only render the table if the parameter is actually usable.
- The table header is hard-coded to say `'statuses'`, which is just a silly mistake. (Most commonly, this table does have `statuses` constants.)
Test Plan: Viewed the Conduit API documentation for the new "slowvote.poll.search" API method, saw more sensible display behavior.
Maniphest Tasks: T13350
Differential Revision: https://secure.phabricator.com/D20686
+4
-2
+4
-2
src/applications/search/engine/PhabricatorSearchEngineAPIMethod.php
+4
-2
src/applications/search/engine/PhabricatorSearchEngineAPIMethod.php
···
198
198
$label = $field->getLabel();
199
199
200
200
$constants = $field->newConduitConstants();
201
+
$show_table = false;
201
202
202
203
$type_object = $field->getConduitParameterType();
203
204
if ($type_object) {
···
209
210
' ',
210
211
phutil_tag('em', array(), pht('(See table below.)')),
211
212
);
213
+
$show_table = true;
212
214
}
213
215
} else {
214
216
$type = null;
···
222
224
$description,
223
225
);
224
226
225
-
if ($constants) {
227
+
if ($show_table) {
226
228
$constant_lists[] = $this->newRemarkupDocumentationView(
227
229
pht(
228
230
'Constants supported by the `%s` constraint:',
229
-
'statuses'));
231
+
$key));
230
232
231
233
$constants_rows = array();
232
234
foreach ($constants as $constant) {