Skip to content

Instantly share code, notes, and snippets.

@tylershuster

tylershuster/urbit-api-documentation.md

Last active November 10, 2020 01:12
Show Gist options
  • Save tylershuster/74d69e09650df5a86c4d8d8f00101b42 to your computer and use it in GitHub Desktop.
Save tylershuster/74d69e09650df5a86c4d8d8f00101b42 to your computer and use it in GitHub Desktop.
Download ZIP
Urbit API Documentation
@liam-fitzgerald
Copy link

An authenticated POST request on /spider/inputmark/threadname/outputmark.json will attempt to run the threadname thread. It will attempt to convert the JSON in the POST body to inputmark and then use that as the parameters for the thread. Once the thread has completed, spider will attempt to convert the return value of the thread from outputmark to JSON. In the general case, if the thread fails it will return 500. However, if the thread fails with certain messages, it will return a corresponding HTTP status code (see ++thread-http-fail in app/spider.hoon for the mapping and ted/graph/join.hoon for an example of this in use).

@tylershuster
Copy link
Author

Thanks. Considering that graph-store uses this I'm going to have to get my head wrapped around it but it seems a bit...messy for the user just getting started. Do you have simpler examples than the ones I can see in graph.ts? It seems like pretty high cognitive overhead and setup for something that will take a while to use.

I mean, I guess graph-store really eats the world you'll want to know how to interact with it, but hopefully the libraries take care of it for you.

@tylershuster
Copy link
Author

tylershuster commented Oct 5, 2020 •
edited

Other than that I think I accounted for y'all's feedback.

https://gist.github.com/tylershuster/74d69e09650df5a86c4d8d8f00101b42/revisions?short_path=04f1ac0#diff-04f1ac0c5d238ec84b738bc88c095d6b

@Fang-
Copy link

Fang- commented Oct 5, 2020

spidering

lol, might be more clear to say "running threads" or "starting asynchronous operations" or whatever?

Great work. (:

@tylershuster
Copy link
Author

@liam-fitzgerald, @Fang-, do you have some beginner examples of spidering? thinking of just cutting it if not

@tylershuster
Copy link
Author

Er, "running threads"

@Beasta
Copy link

Beasta commented Oct 7, 2020

🚀

@Fang-
Copy link

Fang- commented Oct 8, 2020

idk if there's any threads you can "just like kick off" super easily, none of the simple ones like -hi etc have mars matching their input...

@tylershuster
Copy link
Author

Well then I will probably just leave a basic syntax and a “here there be monsters” warning. Time to PR

@dclelland
Copy link

Additional airlock in Swift here: https://github.com/dclelland/UrsusAirlock

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment