From 111e6e72aa252c8dd3676d274caf7be855d02bd8 Mon Sep 17 00:00:00 2001
From: Matthew Morris <matthew.morris@cessda.eu>
Date: Mon, 15 Apr 2024 11:11:43 +0200
Subject: [PATCH] #560: Document the JSON model used for "funding" objects

---
 DEVELOPER_DOCUMENTATION.md  | 26 +++++++++++++++++---------
 OPERATIONS_DOCUMENTATION.md |  2 +-
 2 files changed, 18 insertions(+), 10 deletions(-)

diff --git a/DEVELOPER_DOCUMENTATION.md b/DEVELOPER_DOCUMENTATION.md
index 79d2d1f..d51fcd8 100644
--- a/DEVELOPER_DOCUMENTATION.md
+++ b/DEVELOPER_DOCUMENTATION.md
@@ -67,6 +67,7 @@ See <https://github.com/cessda/cessda.cdc.osmh-indexer.cmm/blob/main/src/main/re
 | `studyUrl` | The URL of the study description page in the SP's catalogue |
 | `studyNumber` | |
 | `fileLanguages` | A string array of the languages that the source data file is available in |
+| `funding` | An array of objects describing the funding information of the study |
 | `typeOfTimeMethods` | An array of vocabulary objects describing the type of time methods used |
 | `typeOfSamplingProcedures` | An array of vocabulary objects describing the sampling procedures used in the study |
 | `publisher` | A publisher object describing the publisher of the study |
@@ -78,15 +79,6 @@ See <https://github.com/cessda/cessda.cdc.osmh-indexer.cmm/blob/main/src/main/re
 | `studyXmlSourceUrl` | The URL of the OAI-PMH repository where the source of the metadata is located |
 | `universes` | The universes that were studied in the study |
 
-### Vocabulary Object Definition
-
-| Field Name | Description |
-| ---------- | ----------- |
-| `vocab` | The name of the vocabulary |
-| `vocabUri` | The URI of the vocabulary (but not the URI of the item) |
-| `id` | The ID of the item in the vocabulary being referenced |
-| `term` | The text content of the item in the vocabulary |
-
 ### Country Object Definition
 
 | Field Name | Description |
@@ -102,6 +94,13 @@ See <https://github.com/cessda/cessda.cdc.osmh-indexer.cmm/blob/main/src/main/re
 | `dataCollectionFreeText` | The text describing the data collection |
 | `event` | The event corresponding to this data collection |
 
+### Funding Object Definition
+
+| Field Name | Description |
+| ---------- | ----------- |
+| `agency` | The agency responsible for the funding |
+| `grantNumber` | The grant number of the studies's funding |
+
 ### Persistent Identifier Object Definition
 
 | Field Name | Description |
@@ -116,6 +115,15 @@ See <https://github.com/cessda/cessda.cdc.osmh-indexer.cmm/blob/main/src/main/re
 | `abbr` | The short name or abbreviation of the publisher |
 | `publisher` | The full name of the publisher |
 
+### Vocabulary Object Definition
+
+| Field Name | Description |
+| ---------- | ----------- |
+| `vocab` | The name of the vocabulary |
+| `vocabUri` | The URI of the vocabulary (but not the URI of the item) |
+| `id` | The ID of the item in the vocabulary being referenced |
+| `term` | The text content of the item in the vocabulary |
+
 ## Adding a new field to the CDC
 
 ### Indexer
diff --git a/OPERATIONS_DOCUMENTATION.md b/OPERATIONS_DOCUMENTATION.md
index 6724b25..6cdee76 100644
--- a/OPERATIONS_DOCUMENTATION.md
+++ b/OPERATIONS_DOCUMENTATION.md
@@ -23,7 +23,7 @@ See <https://github.com/cessda/cessda.metadata.harvester/blob/main/README.md> fo
 
 ## Managing the Elasticsearch (ES) indices
 
-The Elasticsearch cluster used to run the Data Catalogue is available on the catalogues endpoint, i.e. at <https://datacatalogue.cessda.eu/es/>. This endpoint is password protected (the password can be found in 1Password).
+The Elasticsearch cluster used to run the Data Catalogue is available on the catalogues endpoint, i.e. at `https://datacatalogue.cessda.eu/es/`. This endpoint is password protected (the password can be found in 1Password).
 
 To check that language indexes have been created, perform a `GET /_cat/indices` request to Elasticsearch (`https://datacatalogue.cessda.eu/es/_cat/indices`). This should return a result that looks like this.