Document unique identifiers for all reports (#182)

* Document unique identifiers for all reports * Fix codacy issue
BIBSYSDEV · Oct 4, 2024 · d363d54 · d363d54
1 parent f60c565
commit d363d54
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 0 deletions.
diff --git a/documentation/affiliationReport.md b/documentation/affiliationReport.md
@@ -1,5 +1,9 @@
 # Report: affiliation
 
+## Unique identifier
+
+Combination of `publicationId`, `contributorId` and `affiliationId`
+
 ## Description
 
 - `publicationId`

diff --git a/documentation/contributorReport.md b/documentation/contributorReport.md
@@ -1,5 +1,9 @@
 # Report: contributor
 
+## Unique identifier
+
+Combination of `publicationId` and `contributorId`
+
 ## Description
 
 - `publicationId`

diff --git a/documentation/fundingReport.md b/documentation/fundingReport.md
@@ -1,5 +1,9 @@
 # Report: funding
 
+## Unique identifier
+
+Combination of `publicationId` and `fundingId`
+
 ## Description
 
 - `publicationId`

diff --git a/documentation/identifierReport.md b/documentation/identifierReport.md
@@ -1,5 +1,9 @@
 # Report: identifier
 
+## Unique identifier
+
+Combination of `publicationId` and `additionalIdentifier`
+
 ## Description
 
 - `publicationId`

diff --git a/documentation/nviReport.md b/documentation/nviReport.md
@@ -1,5 +1,9 @@
 # Report: nvi
 
+## Unique identifier
+
+Combination of `publicationId`, `contributorIdentifier` and `affiliationId`
+
 ## Description
 
 - `publicationId`

diff --git a/documentation/publicationReport.md b/documentation/publicationReport.md
@@ -1,5 +1,14 @@
 # Report: publication
 
+## Unique identifier
+
+Combination of `publicationId` and `channelIdentifier`.
+
+NB! We have noticed deviations where `channelIdentifier` is not unique.
+We are working to fix this.
+In the meantime, the unique identifier is the combination
+of `publicationId` and `channelType`.
+
 ## Description
 
 - `publicationId`