aboutsummaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
| * | dev docs: Remove an obsolete comment.Ian Jackson2023-04-111-5/+0
| | | | | | | | | | | | I think we've bedded in the new process.
* | | Merge branch 's101-q1' into 'main'Nick Mathewson2023-04-121-0/+26
|\ \ \ | | | | | | | | | | | | | | | | Update s101 values. See merge request tpo/core/arti!1128
| * | | Update s101 values.Alexander Færøy2023-04-111-0/+26
| |/ /
* | | Add notes on how to test the RPC engineNick Mathewson2023-04-121-0/+1
| | |
* | | Add notes on how to test the RPC engineNick Mathewson2023-04-121-0/+27
| | |
* | | rpc: Fix typos/grammar errorsNick Mathewson2023-04-111-2/+2
| | |
* | | rpc: Rewrite `data` spec in JSON termsIan Jackson2023-04-111-4/+12
| | |
* | | rpc: Clarify that error formatting display is indicativeIan Jackson2023-04-111-0/+4
| | |
* | | Use non-JSON-RPC-reserved values for our own errorsIan Jackson2023-04-111-2/+4
| | |
* | | rpc: Fix mistake in "JSON-RPC compatibility" section for errorsIan Jackson2023-04-111-1/+2
| | |
* | | rpc: Discourage use of `code`Ian Jackson2023-04-111-1/+8
| | |
* | | rpc: Warn about relying too much about `data`Ian Jackson2023-04-111-0/+5
| | |
* | | rpc: Provide example of an error responseIan Jackson2023-04-111-0/+18
| | |
* | | rpc: Provide a list of ErrorKind stringsIan Jackson2023-04-111-2/+17
| | | | | | | | | | | | | | | Prompted by https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1107#note_2893078
* | | rpc: Be more explicit about what the string error message is for (typo)Ian Jackson2023-04-111-1/+1
| | |
* | | rpc: Be more explicit about what the string error message is forNick Mathewson2023-04-111-1/+3
| | |
* | | rpc: Proposed error formatIan Jackson2023-04-111-0/+52
|/ /
* | Merge branch 'release' into 'main'Nick Mathewson2023-04-051-0/+87
|\ \ | | | | | | | | | | | | doc/dev/Release.md: patch release workflow See merge request tpo/core/arti!1111
| * | doc/dev/Release.md: patch release workflowIan Jackson2023-04-041-0/+87
| | | | | | | | | | | | | | | | | | | | | | | | | | | We did roughly this today. We put the CHANGELOG.md change in its own MR, so it didn't end up in the tor-llcrypto-v0.4.4 tag. It would have been better to do it the other way so that's what I've documented. I couldn't test-format this with pandoc because it got tricked by some of the `$` into trying to run TeX.
* | | Merge branch 'rpc' into 'main'Ian Jackson2023-04-041-43/+122
|\ \ \ | |/ / |/| | | | | | | | Proposed rpc protocol edits and tightenings-up See merge request tpo/core/arti!1078
| * | rpc: Fix typosNick Mathewson2023-04-041-2/+2
| | |
| * | rpc: Speak of "Arti" rather than "arti"Ian Jackson2023-04-031-2/+2
| | | | | | | | | | | | | | | As per https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1078#note_2889618
| * | rpc: State the integer round-trip range limitsIan Jackson2023-04-031-1/+5
| | | | | | | | | | | | | | | As per https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1078#note_2889617
| * | rpc: Don't talk about "properties" of objects: rather, "members"Ian Jackson2023-04-031-1/+1
| | | | | | | | | | | | | | | As per https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1078#note_2889616
| * | rpc: Move notes about cancellation to right sectionIan Jackson2023-04-031-7/+7
| | | | | | | | | | | | | | | As per https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1078#note_2889614
| * | rpc: Be clearer about updates contentIan Jackson2023-04-031-2/+3
| | | | | | | | | | | | | | | | | | | | | | | | You can't parse an update without knowing the request method (this was already stated elsewhere). Prompted by https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1078#note_2889613
| * | rpc: Change how we talk about objectsIan Jackson2023-04-031-1/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | Use just "object" in the introduction, but be specific that the abstract data type is I-JSON, even if we later invent other representations. Prompted by https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1078#note_2889612
| * | rpc: Right at top, say I-JSONIan Jackson2023-04-031-1/+1
| | | | | | | | | | | | | | | Prompted by https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1078#note_2889612
| * | rpc: Change wording about responsesIan Jackson2023-04-031-1/+1
| | | | | | | | | | | | | | | Prompted by https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1078#note_2889611
| * | rpc: Start on a list of the differences with JSON-RPCIan Jackson2023-03-241-0/+23
| | |
| * | rpc: Discuss ordering and bufferingIan Jackson2023-03-241-0/+13
| | |
| * | rpc: Define term `field`Ian Jackson2023-03-241-0/+2
| | |
| * | rpc: Discuss cancellation request objIan Jackson2023-03-241-0/+9
| | |
| * | rpc: Clarify what precisely the responses depend onIan Jackson2023-03-241-2/+4
| | | | | | | | | | | | | | | | | | | | | | | | The format of an update or result depends on the *method* but not the parameters or the subject. Declare that the format of an error is uniform. (It could have an enum in it.)
| * | rpc: State that we're using I-JSONIan Jackson2023-03-241-0/+8
| | |
| * | rpc: Forbid troublesome numbers as idsIan Jackson2023-03-241-2/+4
| | | | | | | | | | | | | | | This is a bit sad but I think we should have a conservative JSON profile.
| * | rpc: Be more explicit about ignoring JSON fieldsIan Jackson2023-03-241-1/+4
| | |
| * | rpc: Clarify/restate method definition requirementsIan Jackson2023-03-241-9/+10
| | | | | | | | | | | | | | | | | | | | | In particular, abolish the notion of a "response type". Since responses don't come with a discriminant, each method may have only one success response format (although of course that format might itself have optional fields or be an enum or something).
| * | rpc: Use Object for method targets and JSON object for document objectsIan Jackson2023-03-241-29/+31
| | |
| * | rpc: Make `params` in a request non-optionalIan Jackson2023-03-241-1/+5
| | | | | | | | | | | | | | | | | | *If* it is optional that would depend on the request, which is a bit complicated to specify precisely. And making it mandatory is more orthogonal.
* | | Fix typoDimitris Apostolou2023-03-241-1/+1
|/ /
* | rpc-meta-draft: Sketch an even-lower-level API.Nick Mathewson2023-03-241-0/+11
| |
* | rpc-draft: Sketch out more commands to add, start sketching APIsNick Mathewson2023-03-241-1/+112
| |
* | rpc-meta: clarify when "object" means "JSON object".Nick Mathewson2023-03-241-8/+7
| |
* | rpc-meta: expand on handle/reference semantics.Nick Mathewson2023-03-241-5/+24
| |
* | rpc-meta: Use "will" for what Arti does, "must" for what client does.Nick Mathewson2023-03-241-4/+4
| |
* | rpc-meta: Rename intermediate response to "update".Nick Mathewson2023-03-241-25/+23
| |
* | rpc-meta-draft: consistently say "request" or "method", not "command".Nick Mathewson2023-03-241-15/+15
| |
* | rpc-meta-draft: make a number of localized changes from the review.Nick Mathewson2023-03-241-21/+103
| |
* | Start drafting a dev note about a JSON-based OO RPC design.Nick Mathewson2023-03-241-0/+348
| |