summaryrefslogtreecommitdiff
path: root/doc/dev
Commit message (Collapse)AuthorAgeFilesLines
...
* | dev docs: Add key manager API sketch.Gabriela Moldovan2023-04-251-0/+239
| | | | | | | | | | | | | | | | | | | | | | | | This is the first draft of the key manager API. I don't expect this to be the final version of the API, and I'm sure there are plenty of improvements to be made. This is mostly a request for comments. Closes #834 Signed-off-by: Gabriela Moldovan <[email protected]>
* | rpc spec: define method namespacing.Nick Mathewson2023-04-131-5/+29
| | | | | | | | Closes #822
* | Merge branch 'rpc_conformance' into 'main'Nick Mathewson2023-04-131-13/+26
|\ \ | | | | | | | | | | | | | | | | | | RPC: Terminology and error-handling conformance Closes #826 and #825 See merge request tpo/core/arti!1136
| * | rpc, spec: Document current ObjectError, RequestError behavior as correct.Nick Mathewson2023-04-131-2/+2
| | |
| * | rpc: Change `id=<SYNTAX>` to "no id".Nick Mathewson2023-04-131-3/+5
| | | | | | | | | | | | | | | | | | | | | Now instead of hoping that buggy clients will detect a magic `id`, we can simply tell them that they will get no `id` at all. If they can't handle that case, no major harm is done: the connection will get closed anyway.
| * | rpc spec: Allocate a special ID for syntax errors.Nick Mathewson2023-04-121-0/+6
| | |
| * | rpc spec: Change arti_kinds => kinds per discussion.Nick Mathewson2023-04-121-6/+11
| | |
| * | rpc: terminology edits around "method" in spec draftNick Mathewson2023-04-121-4/+4
| | | | | | | | | | | | | | | | | | Always "method", never "command". Always "authentication scheme", never "authentication method".
* | | Merge branch 'devdoc' into 'main'Nick Mathewson2023-04-121-3/+36
|\ \ \ | |/ / |/| | | | | | | | Document some properties of semver See merge request tpo/core/arti!1129
| * | dev docs: Reference semver trickIan Jackson2023-04-121-0/+4
| | | | | | | | | | | | | | | Discussion https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1129#note_2895839
| * | dev docs: Adding missing footnoteIan Jackson2023-04-121-0/+2
| | | | | | | | | | | | | | | Discussion https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1129#note_2895837
| * | dev docs: Avoid main-verb-less sentenceIan Jackson2023-04-121-3/+2
| | | | | | | | | | | | | | | Discussion https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1129#note_2895835
| * | dev docs: Add missing wordIan Jackson2023-04-121-1/+1
| | | | | | | | | | | | | | | As per https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1129#note_2895834
| * | dev docs: Clarify that it's two instances of the crateNick Mathewson2023-04-121-1/+1
| | |
| * | dev docs: Clarify wording re who is exporting whatNick Mathewson2023-04-121-2/+3
| | |
| * | dev docs: Make some explanation about semverIan Jackson2023-04-111-0/+32
| | |
| * | dev docs: Make a heading a subheadingIan Jackson2023-04-111-1/+1
| | |
| * | 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
| | |