on master help sign in
add summary table of agent interfaces
81d390bTinnus Napbus
content/docs/userspace/http-api-guide.md+7−1
@@ -42,7 +42,7 @@ the marks in question do not contain appropriate JSON conversion functions, it
42will fail. Not all [scry endpoints](#scry-endpoints), [subscription
42will fail. Not all [scry endpoints](#scry-endpoints), [subscription
43paths](#subscriptions), pokes, etc, are intended to be used from a front-end, so
43paths](#subscriptions), pokes, etc, are intended to be used from a front-end, so
44not all use marks which can be converted to and from JSON (the `noun` mark for
44not all use marks which can be converted to and from JSON (the `noun` mark for
45−example). If documentation is available for the agent or thread in question, is
45+example). If documentation is available for the agent or thread in question, it
46should note in some fashion whether it can take or produce JSON. The majority of
46should note in some fashion whether it can take or produce JSON. The majority of
47things you'll want to interact with through Eyre _will_ work with JSON.
47things you'll want to interact with through Eyre _will_ work with JSON.
48
48
@@ -54,6 +54,12 @@ has `graph-store`, `group-store`, `contact-store`, and others in its desk.
54Agents are the main thing you'll interact with through Eyre. They have a simple
54Agents are the main thing you'll interact with through Eyre. They have a simple
55interface with three main parts:
55interface with three main parts:
56
56
57+| Interface | Description |
58+| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
59+| Pokes | One-off message to an agent. Pokes often represent actions, commands, requests, etc. |
60+| Subscriptions | An agent may have a number of different paths to which you may subscribe. If a subscription request is accepted, you'll continue to receive update/events the agent sends out on that path until you either cancel the subscription or are kicked by the agent. |
61+| Scries | Scries are one-off requests for data. Like subscriptions, they are organized by path. Scry requests will be fulfilled immediately. Scries are "read-only", they cannot alter the state of an agent. |
62+
57#### Pokes
63#### Pokes
58
64
59Pokes are single, stand-alone messages to agents. Pokes are how you send data
65Pokes are single, stand-alone messages to agents. Pokes are how you send data