on master help sign in
changes to scry ref per @Fang- recommendations

- remove x from beginning of scry paths - make explanation about @ta-encoded @t clearer and accurate - truncate long example

commit93ab53d0d8ab533ba2e7bf11197871e04d33c26d authortinnus-napbus <admin@tinnus-napbus.xyz> dateFri 25 Jun 2021, 13:40 (5 years ago) parent984bf30
2 files changed+20−39
arvo/eyre/examples.md+3−3 arvo/eyre/scry.md+17−36
arvo/eyre/examples.md+3−3
@@ -592,7 +592,7 @@ First, using `|pass` in the dojo, let's approve the origin `http://foo.example`
592592|pass [%e [%approve-origin 'http://foo.example']]
593593```
594594
595−Now if we scry for the [approved](@/docs/arvo/eyre/scry.md#x-cors-approved) CORS `set`:
595+Now if we scry for the [approved](@/docs/arvo/eyre/scry.md#cors-approved) CORS `set`:
596596
597597```
598598> .^(approved=(set @t) %ex /=//=/cors/approved)
@@ -630,7 +630,7 @@ Now we'll try rejecting an `origin`. Back in the dojo, let's `|pass` Eyre a `%re
630630|pass [%e [%reject-origin 'http://bar.example']]
631631```
632632
633−If we scry for the [rejected](@/docs/arvo/eyre/scry.md#x-cors-rejected) CORS `set`:
633+If we scry for the [rejected](@/docs/arvo/eyre/scry.md#cors-rejected) CORS `set`:
634634
635635```
636636> .^(rejected=(set @t) %ex /=//=/cors/rejected)
@@ -679,7 +679,7 @@ Connection: close
679679Server: urbit/vere-1.5
680680```
681681
682−Now if we scry for the [requests](@/docs/arvo/eyre/scry.md#x-cors-requests) CORS `set`:
682+Now if we scry for the [requests](@/docs/arvo/eyre/scry.md#cors-requests) CORS `set`:
683683
684684```
685685> .^(requests=(set @t) %ex /=//=/cors/requests)
arvo/eyre/scry.md+17−36
@@ -7,13 +7,13 @@ template = "doc.html"
77## Contents
88
99- [Introduction](#introduction)
10−- [/x/cors](#xcors) - CORS settings.
11− - [/x/cors/requests](#xcorsrequests) - Requested origins.
12− - [/x/cors/approved](#xcorsapproved) - Approved origins.
13− - [/x/cors/approved/\<origin\>](#xcorsapprovedorigin) - Check if origin approved.
14− - [/x/cors/rejected](#xcorsrejected) - Rejected origins.
15− - [/x/cors/rejected/\<origin\>](#xcorsrejectedorigin) - Check if origin rejected.
16−- [/x/authenticated/cookie/\<cookie\>](#xauthenticatedcookiecookie) - Check if cookie authenticated.
10+- [/cors](#cors) - CORS settings.
11+ - [/cors/requests](#cors-requests) - Requested origins.
12+ - [/cors/approved](#cors-approved) - Approved origins.
13+ - [/cors/approved/\<origin\>](#cors-approved-origin) - Check if origin approved.
14+ - [/cors/rejected](#cors-rejected) - Rejected origins.
15+ - [/cors/rejected/\<origin\>](#cors-rejected-origin) - Check if origin rejected.
16+- [/authenticated/cookie/\<cookie\>](#authenticated-cookie-cookie) - Check if cookie authenticated.
1717- [bindings](#bindings) - URL path bindings.
1818- [connections](#connections) - Open http connections.
1919- [authentication-state](#authentication-state) - Authentication details.
@@ -24,11 +24,11 @@ template = "doc.html"
2424
2525Here are all of Eyre's scry endpoints. There's not too many and they mostly deal with either CORS settings or aspects of the state of connections.
2626
27−The first few with a `care` of `x` are a scry like `.^(<type> %ex /=//=/<some-path>)` (note the empty `desk`). The rest have no `care` and the tag replaces the `desk` like `.^(<type> %e /=<something>=)`.
27+The first few have a `care` of `x` and are a scry like `.^(<type> %ex /=//=/<some-path>)` (note the empty `desk`). The rest have no `care` and the tag replaces the `desk` like `.^(<type> %e /=<something>=)`.
2828
2929All examples are from the dojo.
3030
31−# `/x/cors`
31+# `/cors`
3232
3333An `x` scry with a `path` of `/cors` will return Eyre's CORS origin registry. The type returned is a [cors-registry](@/docs/arvo/eyre/data-types.md#cors-registry) which contains the `set`s of approved, rejected and requested origins.
3434
@@ -42,7 +42,7 @@ Example:
4242]
4343```
4444
45−## `/x/cors/requests`
45+## `/cors/requests`
4646
4747An `x` scry with a `path` of `/cors/requests` will return the `set` of pending origin requests. These are origins that were in an `Origin: ...` HTTP header but weren't in the existing approved or rejected sets. The type returned is a `(set origin:eyre)`.
4848
@@ -53,7 +53,7 @@ Example:
5353requests={~~http~3a.~2f.~2f.baz~.example}
5454```
5555
56−## `/x/cors/approved`
56+## `/cors/approved`
5757
5858An `x` scry with a `path` of `/cors/approved` will return the `set` of approved CORS origins. The type returned is a `(set origin:eyre)`.
5959
@@ -64,11 +64,11 @@ Example:
6464approved={~~http~3a.~2f.~2f.foo~.example}
6565```
6666
67−## `/x/cors/approved/<origin>`
67+## `/cors/approved/<origin>`
6868
6969An `x` scry whose `path` is `/cors/approved/<origin>` tests whether the given origin URL is in the `approved` set of the CORS registry. The type returned is a simple `?`.
7070
71−The origin URL must be a cord-encoded `@t` rather than just the plain `@t`, so you'll have to do something like `(scot %t 'foo')` rather than just `'foo'`.
71+The origin URL is a `@t`, but since `@t` may not be valid in a path, it must be encoded in a `@ta` using `+scot` like `(scot %t 'foo')` rather than just `'foo'`.
7272
7373Examples:
7474
@@ -82,7 +82,7 @@ Examples:
8282%.n
8383```
8484
85−## `/x/cors/rejected`
85+## `/cors/rejected`
8686
8787An `x` scry with a `path` of `/cors/rejected` will return the `set` of rejected CORS origins. The type returned is a `(set origin:eyre)`.
8888
@@ -93,7 +93,7 @@ Example:
9393rejected={~~http~3a.~2f.~2f.bar~.example}
9494```
9595
96−## `/x/cors/rejected/<origin>`
96+## `/cors/rejected/<origin>`
9797
9898An `x` scry whose `path` is `/cors/rejected/<origin>` tests whether the given origin URL is in the `rejected` set of the CORS registry. The type returned is a simple `?`.
9999
@@ -111,7 +111,7 @@ Examples:
111111%.n
112112```
113113
114−# `/x/authenticated/cookie/<cookie>`
114+# `/authenticated/cookie/<cookie>`
115115
116116An `x` scry whose `path` is `/authenticated/cookies/<cookie>` tests whether the given cookie is currently valid. The type returned is a `?`.
117117
@@ -146,26 +146,7 @@ Example:
146146 ~[/gall/use/file-server/0w2.EijQB/~zod/~landscape /dill //term/1]
147147 [%app app=%file-server]
148148 ]
149− [ [site=~ path=<|~chat|>]
150− ~[/gall/use/file-server/0w2.EijQB/~zod/~chat /dill //term/1]
151− [%app app=%file-server]
152− ]
153− [[site=~ path=<|~ scry|>] ~[/dill //term/1] [%scry ~]]
154− [[site=~ path=<|~ logout|>] ~[/dill //term/1] [%logout ~]]
155− [[site=~ path=<|~ login|>] ~[/dill //term/1] [%authentication ~]]
156− [[site=~ path=<|~ channel|>] ~[/dill //term/1] [%channel ~]]
157− [ [site=~ path=<|spider|>]
158− ~[/gall/use/spider/0w2.EijQB/~zod/bind /dill //term/1]
159− [%app app=%spider]
160− ]
161− [ [site=~ path=<|.well-known acme-challenge|>]
162− ~[/gall/use/acme/0w2.EijQB/~zod/acme /dill //term/1]
163− [%gen generator=[desk=%home path=<|gen acme domain-validation hoon|> args=0]]
164− ]
165− [ [site=~ path=<||>]
166− ~[/gall/use/file-server/0w2.EijQB/~zod /dill //term/1]
167− [%app app=%file-server]
168− ]
149+ ...(truncated for brevity)...
169150]
170151```
171152