summaryrefslogtreecommitdiffstats
path: root/proposals/20190911_v04_schema_tweaks.md
blob: f525351990afe486a9698275b892cf67665068a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

Status: planned

## Schema Changes for v0.4 Release

Proposed schema changes for next fatcat iteration (v0.4? v0.5?).

SQL (and API, and elasticsearch):

- container:`container_status` as a string enum: eg, "stub",
  "out-of-print"/"ended" (?), "active", "new"/"small" (?).  Particularly to
  deal with disambiguation of multiple containers by the same title but
  separate ISSN-L. For example, "The Lancet".
- release: `release_month` (to complement `release_date` and `release_year`)
- file: `file_scope` as a string enum indicating how much content this file
  includes. Eg, `book`, `chapter`, `article`/`work`, `issue`, `volume`,
  `abstract`, `component`. Unclear how to initialize this field; default to
  `article`/`work`?
- TODO: release: switch how pages work? first/last?
- TODO: indication of peer-review process? at release or container level?
- TODO: container: separate canonical and disambiguating titles (?)
- TODO: container: "imprint" field?
- TODO: release inter-references using SCHOLIX/Datacite schema
    https://zenodo.org/record/1120265
    https://support.datacite.org/docs/connecting-research-outputs#section-related-identifiers

API tweaks:

- add regex restrictions on more `ext_ids`, especially `wikidata_qid`
- add explicit enums for more keyword fields

API endpoints:

- `GET /auth/token/<editor_id>` endpoint to generate new API token for given
  editor. Used by web interface, or bot wranglers.
- create editor endpoint, to allow bot account creation
- `GET /editor/<ident>/bots` (?) endpoint to enumerate bots wrangled by a
  specific editor

See `2020_search_improvements` for elasticsearch-only schema updates.