diff options
author | Rasmus Dahlberg <rasmus@mullvad.net> | 2022-01-31 15:36:29 +0100 |
---|---|---|
committer | Rasmus Dahlberg <rasmus@mullvad.net> | 2022-01-31 15:36:29 +0100 |
commit | f8d61a93109656e89cbbdeae56ca778127a0eafe (patch) | |
tree | d1f935122336a93254fc869ebf63c7636a7d56ba /doc/proposals/2022-01-log-url | |
parent | 9d5eee35a5fd7f145916043de3e94e14044946a7 (diff) |
moved some persisted pads to proposal directory
See doc/proposals/2022-01-how-to-use-proposal-folder for details.
Diffstat (limited to 'doc/proposals/2022-01-log-url')
-rw-r--r-- | doc/proposals/2022-01-log-url | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/proposals/2022-01-log-url b/doc/proposals/2022-01-log-url new file mode 100644 index 0000000..598fb43 --- /dev/null +++ b/doc/proposals/2022-01-log-url @@ -0,0 +1,26 @@ +Redefine "base URL" as "log URL" proposal + +Background +--- +The current api.md specification requires that a log has a fixed unique "base +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: + + 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" +would be: + + https://example.com:4711/opposum/sigsum/v0/get-tree-head-quickly/ + +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. |