on master help sign in
Merge pull request #1115 from tinnus-napbus/fix-arvo-headers

fix remaining arvo headers

commitc21b47bececf2a1161c03a089991ff6452cee78a authortinnus-napbus <77721746+tinnus-napbus@users.noreply.github.com> dateSat 11 Sep 2021, 23:27 (5 years ago) parenta8d3a539c68bd0
2 files changed+18−18
content/docs/arvo/eyre/tasks.md+15−15 content/docs/arvo/iris/tasks.md+3−3
content/docs/arvo/eyre/tasks.md+15−15
@@ -20,7 +20,7 @@ This `task` notifies Eyre of the listening HTTPS and HTTP ports. It is automatic
2020
2121The `insecure` field is the HTTP port and `secure` is the optional HTTPS port.
2222
23−### Returns
23+#### Returns
2424
2525Eyre returns no `gift` in response to a `%live` `task`.
2626
@@ -34,7 +34,7 @@ This `task` either configures HTTPS with a certificate and keypair, or configure
3434
3535The [$http-rule](/docs/arvo/eyre/data-types#http-rule) is either tagged with `%cert` or `%turf`. A `%cert` `http-rule` sets an HTTPS certificate and keypair or removes it if null. A `%turf` `http-rule` either adds or removes a DNS binding depending on whether the `action` is `%put` or `%del`. Note that using `%turf` will automatically cause the system to try and obtain a certificate and keypair via Letsencrypt.
3636
37−### Returns
37+#### Returns
3838
3939Eyre returns no `gift` in response to a `%rule` `task`.
4040
@@ -48,7 +48,7 @@ This `task` is how Eyre receives an inbound HTTP request. It will ordinarily be
4848
4949The `secure` field says whether it's over HTTPS. The `address` is the IP address from which the request originated. The [$request:http](/docs/arvo/eyre/data-types#requesthttp) is the HTTP request itself containing the method, URL, headers, and body.
5050
51−### Returns
51+#### Returns
5252
5353Eyre may `pass` a `%response` `gift` on the appropriate `duct` depending on the contents of the `%request`, state of the connection, and other factors.
5454
@@ -60,7 +60,7 @@ Eyre may `pass` a `%response` `gift` on the appropriate `duct` depending on the
6060
6161This `task` is how Eyre receives an inbound HTTP request over the local loopback port. It behaves the same and takes the same arguments as in the [%request](#request) example except it skips any normally required authentication. Just like for a [%request](#request) `task`, you'd not normally use this manually.
6262
63−### Returns
63+#### Returns
6464
6565Eyre may `pass` a `%response` `gift` on the appropriate `duct` depending on the contents of the `%request`, state of the connection, and other factors.
6666
@@ -74,7 +74,7 @@ This `task` is sent to Eyre by the runtime when an HTTP client closes its previo
7474
7575This `task` takes no arguments.
7676
77−### Returns
77+#### Returns
7878
7979Eyre may `pass` a `%response` `gift` on the appropriate `duct` depending on the state of the connection and other factors.
8080
@@ -98,7 +98,7 @@ The `cage` of the second and subsequent `fact`s must have a `mark` of `%http-res
9898
9999Finally, once you've sent all the `fact`s you want, you can `kick` Eyre's subscription and it will complete the response and close the connection to the HTTP client.
100100
101−### Returns
101+#### Returns
102102
103103Eyre will respond with a `%bound` `gift` which says whether the binding was successful and looks like:
104104
@@ -108,7 +108,7 @@ Eyre will respond with a `%bound` `gift` which says whether the binding was succ
108108
109109The `accepted` field says whether the binding succeeded and the `binding` is the requested binding described above.
110110
111−### Example
111+#### Example
112112
113113See the [Direct HTTP Handling With Gall Agents](/docs/arvo/eyre/examples#direct-http-handling-with-gall-agents) section of the [Examples](/docs/arvo/eyre/examples) document for an example.
114114
@@ -140,11 +140,11 @@ The `?` says whether the HTTP request contained a valid session cookie and the [
140140
141141The `simple-payload:http` returned by the generator is similar to the response described in the [%connect](#connect) section except the HTTP headers and body are all contained in the one response rather than staggered across several.
142142
143−### Returns
143+#### Returns
144144
145145Eyre will return a `%bound` `gift` as described at the end of the [%connect](#connect) section.
146146
147−### Example
147+#### Example
148148
149149See the [Generators](/docs/arvo/eyre/examples#generators) section of the [Examples](/docs/arvo/eyre/examples) document for an example.
150150
@@ -158,7 +158,7 @@ This `task` deletes a URL binding previously set by a `%connect` or `%serve` `ta
158158
159159The [$binding](/docs/arvo/eyre/data-types#binding) is the URL path and domain of the binding you want to delete.
160160
161−### Returns
161+#### Returns
162162
163163Eyre returns no `gift` in response to a `%disconnect` `task`.
164164
@@ -172,7 +172,7 @@ This `task` tells Eyre that the web login code has changed, causing Eyre to thro
172172
173173This `task` takes no arguments.
174174
175−### Returns
175+#### Returns
176176
177177Eyre returns no `gift` in response to a `%code-changed` `task`.
178178
@@ -186,11 +186,11 @@ This `task` tells Eyre to start responding positively to CORS requests for the s
186186
187187The [$origin](/docs/arvo/eyre/data-types#origin) is a CORS origin like `http://foo.example` you want to approve.
188188
189−### Returns
189+#### Returns
190190
191191Eyre returns no `gift` in response to a `%approve-origin` `task`.
192192
193−### Example
193+#### Example
194194
195195See the [Managing CORS Origins](/docs/arvo/eyre/examples#managing-cors-origins) section of the [Examples](/docs/arvo/eyre/examples) document for an example.
196196
@@ -204,10 +204,10 @@ This `task` tells Eyre to start responding negatively to CORS requests for the s
204204
205205The [$origin](/docs/arvo/eyre/data-types#origin) is a CORS origin like `http://foo.example` you want want to reject.
206206
207−### Returns
207+#### Returns
208208
209209Eyre returns no `gift` in response to a `%reject-origin` `task`.
210210
211−### Example
211+#### Example
212212
213213See the [Managing CORS Origins](/docs/arvo/eyre/examples#managing-cors-origins) section of the [Examples](/docs/arvo/eyre/examples) document for an example.
content/docs/arvo/iris/tasks.md+3−3
@@ -18,7 +18,7 @@ The [$request:http](/docs/arvo/eyre/data-types#requesthttp) is the request itsel
1818
1919The [$outbound-config](/docs/arvo/iris/data-types#outbound-config) specifies the number of redirects to follow before failing and the number of retries to attempt before giving up. The default values are `5` and `3` respectively. As of writing, **retries and auto-following redirects are not implemented**, so what you specify here is irrelevant and you can just use the bunt value of `outbound-config`.
2020
21−### Returns
21+#### Returns
2222
2323Iris returns a `%http-response` `gift` in response to a `%request` task. A `%response` `gift` looks like:
2424
@@ -32,7 +32,7 @@ The `client-response` structure specifies three kinds of responses - `%progress`
3232
3333Note that neither `%progress` partial messages nor `%cancel` responses have been implemented in Vere at the time of writing, so **you will only ever receive a single `%http-response` `gift` with a `%finished` `client-response`**. If the request fails for some reason, you'll still get an empty `%finished` `client-response` with a `504` status code.
3434
35−### Example
35+#### Example
3636
3737See the [Example](/docs/arvo/iris/example) document.
3838
@@ -46,7 +46,7 @@ Cancel a previous request to fetch a remote HTTP resource.
4646
4747A `%cancel-request` `task` does not take any arguments, the [request](#request) to cancel is determined implicitly.
4848
49−### Returns
49+#### Returns
5050
5151Iris does not return any `gift` in response to a `%cancel-request` `task`. You will also not receive any `gift` back from the original `%request` `task` you've cancelled.
5252