Skip to content

Commit

Permalink
#560: Document the JSON model used for "funding" objects
Browse files Browse the repository at this point in the history
  • Loading branch information
matthew-morris-cessda committed Apr 15, 2024
1 parent a131139 commit 111e6e7
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 10 deletions.
26 changes: 17 additions & 9 deletions DEVELOPER_DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand All @@ -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 |
Expand All @@ -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 |
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion OPERATIONS_DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 111e6e7

Please sign in to comment.