aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRasmus Dahlberg <rasmus@mullvad.net>2022-02-13 14:22:19 +0100
committerRasmus Dahlberg <rasmus@mullvad.net>2022-02-13 14:22:19 +0100
commitfa9b6fa1e4aa20d05032f126415ddd648d61a219 (patch)
tree8b74b22c587c59db1a9f4792a1f774210302589e /doc
parent9025b56a458e1d7d4060f391c8fdc6381fcda441 (diff)
minor edits to the accepted log url proposal
- Remove final "/" from log URL definition (more readable API doc) - Resolve XXX that ln5 looked in to a while back (don't be strict).
Diffstat (limited to 'doc')
-rw-r--r--doc/proposals/2022-01-log-url13
1 files changed, 5 insertions, 8 deletions
diff --git a/doc/proposals/2022-01-log-url b/doc/proposals/2022-01-log-url
index 598fb43..0ec67c0 100644
--- a/doc/proposals/2022-01-log-url
+++ b/doc/proposals/2022-01-log-url
@@ -8,19 +8,16 @@ URL". It is any valid HTTP(S) URL that can end with "/sigsum/v0/<endpoint>".
Proposal
---
Remove the term "base URL" and instead define "log URL". A log URL is a valid
-HTTP(S) URL that ends with "/sigsum/v0/". Example of a valid log URL:
+HTTP(S) URL that ends with "/sigsum/v0". Example of a valid log URL:
- https://example.com:4711/opposum/sigsum/v0/
+ https://example.com:4711/opposum/sigsum/v0
This means that a named sigsum endpoint can be appended to a log's URL. For
-example, if the endpoint is "get-tree-head-quickly" the resulting "endpoint URL"
+example, if the endpoint is "get-tree-head-cosigned" the resulting "endpoint URL"
would be:
- https://example.com:4711/opposum/sigsum/v0/get-tree-head-quickly/
+ https://example.com:4711/opposum/sigsum/v0/get-tree-head-cosigned
And with input parameters for "get-leaves":
- https://example.com:4711/opposum/sigsum/v0/get-leaves/42/4711/
-
-Note the final slash in all of the above URLs. Should that be enforced (?).
- * XXX: Need to check in URL specification(s). Defer for now.
+ https://example.com:4711/opposum/sigsum/v0/get-leaves/42/4711