on master help sign in
api doc fixes
2c95e0bPhilip C Monk
docs/programming/advanced/arvo/system/api.md+13−2
@@ -65,7 +65,7 @@ drifts out of sync with this doc).
65We'll go over the two parts to an API connector (one-time reading vs listening
65We'll go over the two parts to an API connector (one-time reading vs listening
66for events) separately.
66for events) separately.
67
67
68−# Reading
68+## Reading
69
69
70A connector exposes a tree of data. Every read request has a
70A connector exposes a tree of data. Every read request has a
71`care`, which is generally either `%x` or `%y. `%x` is a request
71`care`, which is generally either `%x` or `%y. `%x` is a request
@@ -156,7 +156,12 @@ control. There are four functions we need to define:
156That's really all there is to the reading portion of API
156That's really all there is to the reading portion of API
157connectors.
157connectors.
158
158
159+One of the most accessbile ways to jump into Arvo programming is
160+to just add more places to an existing API connector. It's
161+useful, small in scope, and comes in bite-sized chunks since most
162+places are less than ten lines of code.
163+
159−# Listening
164+## Listening
160
165
161Listening for events is fairly service-specific. In some
166Listening for events is fairly service-specific. In some
162services, we poll for changes. For an example of that, check out
167services, we poll for changes. For an example of that, check out
@@ -200,6 +205,12 @@ standardized, so even if your chosen service is powered by
200webhooks, your listening code might look rather different. The
205webhooks, your listening code might look rather different. The
201point is to expose the correct interface.
206point is to expose the correct interface.
202
207
208+
209+## Github API Connector Code
210+
211+In case the code in `/=home=/app/gh/hoon` drifts out of sync with
212+this doc:
213+
203```
214```
204:: This is a connector for the Github API v3.
215:: This is a connector for the Github API v3.
205::
216::