From 77e6474d029eb8ab5a869a6cc9422a0319b350dd Mon Sep 17 00:00:00 2001 From: nsheff Date: Wed, 26 Jul 2023 09:04:37 -0400 Subject: [PATCH] Add ADR for no metadata endpoint --- docs/decision_record.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/decision_record.md b/docs/decision_record.md index 9e2f537..496c331 100644 --- a/docs/decision_record.md +++ b/docs/decision_record.md @@ -8,6 +8,27 @@ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "S [TOC] +## 2023-07-26 There will be no metadata endpoint + +### Decision + +We have no need for a `/metadata` endpoint + +### Rationale + +At one point (issue #3), we debated whether there should be a `/metadata` endpoint or something like that as a way to retrieve information about a sequence that might not be part of the digested sequence. However, after we distinguised between `inherent` and `non-inherent` attributes, we have realized that this satisifes the earlier requirement for a `/metadata` endpoint; in fact, the metadata can be returned to the user through the normal endpoint, and just flagged as `non-inherent` in the schema to indicate that it's not digested, and therefore not part of the identity of the object + +We distinguished between two types of metadata: + +- server-scoped metadata, like the schema we described above, should be served by `/service-info` +- collection-scoped or sequence-scoped metadata don't fit under `/service-info`. For these, they will be served by the primary `/collection` endpoint, rather than by a separate `/metadata` endpoint. + +### Linked issues + +- https://github.com/ga4gh/seqcol-spec/issues/3 +- https://github.com/ga4gh/seqcol-spec/issues/39 +- https://github.com/ga4gh/seqcol-spec/issues/40 + ## 2023-06-28 Details of endpoints ### Decisions