recaptime.dev
@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
1@title Conduit API Overview
2@group conduit
3
4Overview of the Conduit API.
5
6Overview
7========
8
9Conduit is the HTTP API for Phorge. It is roughly JSON-RPC: you usually
10pass a JSON blob, and usually get a JSON blob back, although both call and
11result formats are flexible in some cases.
12
13API Clients
14===========
15
16The primary ways to make Conduit calls are:
17
18**Web Console**: The {nav Conduit} application provides a web UI for exploring
19the API and making calls. This is the best starting point for learning about
20the API. See the next section for details.
21
22`ConduitClient`: This is the official client available in `arcanist`.
23
24`arc call-conduit`: You can use this `arc` command to execute low-level
25Conduit calls by piping JSON in to stdin. This can provide a simple way
26to explore the API, or a quick way to get API access from a script written
27in another language without needing a real client.
28
29`curl`: You can format a call with basic HTTP parameters and cURL. The console
30includes examples which show how to format calls.
31
32**Other Clients**: There are also clients available in other languages. You
33can check the [[ https://we.phorge.it/w/community_resources/ |
34Community Resources ]] page for links.
35
36API Console
37===========
38
39The easiest way to begin exploring Conduit is by visiting {nav Conduit} in the
40web UI. The application provides an API console which you can use to explore
41available methods, make calls, read documentation, and see examples.
42
43The API console has details about how to construct calls and generate API
44tokens for authentication.
45
46
47Querying and Reading Objects
48============================
49
50For information on searching for objects and reading their properties and
51information, see @{article:Conduit API: Using Search Endpoints}.
52
53
54Creating and Editing Objects
55============================
56
57For information on creating, editing and updating objects, see
58@{article:Conduit API: Using Edit Endpoints}.
59
60
61Next Steps
62==========
63
64Continue by:
65
66 - reading recommendations on responding to API changes in
67 @{article:Managing Conduit Changes}.