Skip to content
Snippets Groups Projects

Update Readme

Merged Lena Heizmann requested to merge readme into master
1 file
+ 6
6
Compare changes
  • Side-by-side
  • Inline
+ 6
6
# Sheets api
A dam simple server to return data from a google spread sheet. The server can fetch data from a google spread sheet and saves the links in the sheet in a memory-cache. It will then return other urls in the same row.
A simple server to return data from a google spreadsheet. The server fetches data from a google spreadsheet and saves the links stored in the sheet in a memory-cache. The sheet with the links has to be created by hand. See below for details. It will then return other urls stored in the same row of the spreadsheet.
## Configuration
You can configure the app over env vars, args or the config.json file.
@@ -16,18 +16,18 @@ You can configure the app over env vars, args or the config.json file.
```
## Google Sheet
As a data provider the app uses [google sheets](https://www.google.com/sheets/about/). You can upload a sheet and use it in the api. To do so, you need to follow two simple rules
* The first row is the description of the cols. If you use the keyword url or url1-9 you define a relevant col for the api.
As a data provider the app uses [google sheets](https://www.google.com/sheets/about/). You can upload a sheet and use it in the api. To do so, you need to follow two simple rules:
* The first row is the description of the columns. If you use the keyword url or url1-9 you define a relevant column for the api.
* The second row is a description of the data provenance. We use this description as a provider name in the api
* All other rows are data. You can have empty and null fields.
| Keyword | Dodis Url1 | HLS URL |
| ------------- |:-------------:| -----:|
| The keyword | Diplomatic documents of switzerland | Historical lexicon of switzerland |
| The keyword | Diplomatic Documents of Switzerland | Historical Lexicon of Switzerland |
| Aussenpolitik | https://dodis.ch/T171 | https://hls-dhs-dss.ch/articles/026455/2012-05-24/ |
## Endpoints
### GET /v1/update
Update the current in memory DB with the new data from the google sheet
Update the current in memory DB with the new data from the google sheet.
### GET /v1/sameas/{url}
Get sameas resources from the memory DB
Get sameas resources from the memory DB.
\ No newline at end of file
Loading