From 23edc59074b778559cfed96fc6ccff3f948af65c Mon Sep 17 00:00:00 2001 From: Michael Barz Date: Thu, 28 Oct 2021 11:42:20 +0200 Subject: [PATCH 1/2] document decision outcome --- docs/ocis/adr/0011-global-url-format.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/ocis/adr/0011-global-url-format.md b/docs/ocis/adr/0011-global-url-format.md index cc9d432420..fa535e3179 100644 --- a/docs/ocis/adr/0011-global-url-format.md +++ b/docs/ocis/adr/0011-global-url-format.md @@ -97,17 +97,18 @@ This ADR is limited to the scope of "how will a web client deal with the browser ## Decision Outcome -Chosen option: "[option 1]", because [justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force force | … | comes out best (see below)]. +Chosen option: "Mixed global URLs", because it meets the reuirement to contain a path and a stable identifier. ### Positive Consequences -* [e.g., improvement of quality attribute satisfaction, follow-up decisions required, …] -* … +* The path makes it "human readable" +* The URL can be bookmarked +* The bookmarked URLs remain stable even if the path changes +* All urls can be shortened to hide any metadata like path, resource name and query parameters ### Negative Consequences -* [e.g., compromising quality attribute, follow-up decisions required, …] -* … +* the web UI needs to look up the space alias in a registry to build an API request for the `/dav/space` endpoint ## Pros and Cons of the Options From dd1e7dfe06dbd98a4aab1c015ab9a64e9bf334dc Mon Sep 17 00:00:00 2001 From: Michael Barz Date: Thu, 28 Oct 2021 12:05:46 +0200 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Benedikt Kulmann --- docs/ocis/adr/0011-global-url-format.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/ocis/adr/0011-global-url-format.md b/docs/ocis/adr/0011-global-url-format.md index fa535e3179..ce46f32236 100644 --- a/docs/ocis/adr/0011-global-url-format.md +++ b/docs/ocis/adr/0011-global-url-format.md @@ -97,14 +97,14 @@ This ADR is limited to the scope of "how will a web client deal with the browser ## Decision Outcome -Chosen option: "Mixed global URLs", because it meets the reuirement to contain a path and a stable identifier. +Chosen option: "Mixed global URLs", because it meets the requirement to contain a path and a stable identifier. ### Positive Consequences * The path makes it "human readable" * The URL can be bookmarked * The bookmarked URLs remain stable even if the path changes -* All urls can be shortened to hide any metadata like path, resource name and query parameters +* All URLs can be shortened to hide any metadata like path, resource name and query parameters ### Negative Consequences