Page MenuHomePhorge

Show the API summary on the top of each Conduit API page
ClosedPublic

Authored by valerio.bozzolan on Feb 8 2023, 00:57.
Tags
None
Referenced Files
Unknown Object (File)
Tue, Apr 16, 14:50
Unknown Object (File)
Wed, Apr 10, 18:58
Unknown Object (File)
Sun, Apr 7, 06:54
Unknown Object (File)
Mon, Apr 1, 00:49
Unknown Object (File)
Mon, Apr 1, 00:49
Unknown Object (File)
Mon, Apr 1, 00:49
Unknown Object (File)
Mon, Apr 1, 00:49
Unknown Object (File)
Thu, Mar 28, 09:59

Details

Summary

Show the API summary on the top of each Conduit API page.

Before this change, the summary was only displayed from the Conduit APIs list.

Closes T15141

Test Plan

I've opened 20 random Conduit API pages from the web
interface and I checked that now there is an amazing
"Summary" field.
I also double-checked that there were not green peppers.

Diff Detail

Repository
rP Phorge
Branch
master
Lint
Lint Passed
Unit
Test Failures
Build Status
Buildable 106
Build 106: arc lint + arc unit

Unit TestsFailed

TimeTest
269 msPhabricatorLibraryTestCase::testLibraryMap
Assertion failed, expected 'true' (at PhutilLibraryTestCase.php:51): The library map is out of date. Rebuild it with `arc liberate`. These entries differ: class.ManiphestSearchConduitAPIMethodSingle, xmap.ManiphestSearchConduitAPIMethodSingle.
84 msPhabricatorCelerityTestCase::testCelerityMaps
1 assertion passed.
10 msPhabricatorConduitTestCase::testConduitMethods
1 assertion passed.
0 msPhabricatorInfrastructureTestCase::testApplicationsInstalled
1 assertion passed.
1 msPhabricatorInfrastructureTestCase::testRejectMySQLNonUTF8Queries
1 assertion passed.
View Full Test Results (1 Failed · 6 Passed)

Event Timeline

valerio.bozzolan retitled this revision from Show the API summary on the top of each Conduit API page Closes T15141 to Show the API summary on the top of each Conduit API page.Feb 8 2023, 01:00
valerio.bozzolan edited the summary of this revision. (Show Details)

I don't think that it's the best UX improvement in the universe but at least it's an useful information that now it's visible somewhere

Render spoiler:

Conduit API proposed Summary field.png (572×831 px, 88 KB)

(Peppers not included)

This revision is now accepted and ready to land.Feb 10 2023, 21:17