summaryrefslogtreecommitdiff
path: root/issues/edit-rif-metadata.gmi
blob: 4207c4be45fa169646a2496e497eaf59a2f374bb (about) (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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# Edit RIF Metadata in GN2

## Tags

* assigned: bonfacem, jnduli
* priority: high
* status: in-progress

## Tasks

### Viewing
* [X] API: Get WIKI/RIF by symbol from rdf.

> GET /wiki/<symbol>

```
[{
    "symbol": "XXXX",
    "reason": "XXXX",
    "species": "XXXX",
    "pubmed_ids": ["XXXX", "XXXX"], // empty array when non-existent
    "web_url": "XXXX" // Optional
    "comment": "XXXX",
    "email": "XXXX",
    "categories": ["XXXX", "XXXX"], // Enumeration
    "version": "XXXX",
    "initial": "XXXX", // Optional user or project code or your initials.
}]
```

* [X] UI: Modify traits page to have "GN2 (GeneWiki)"
* [X] UI: Integrate with API

### Editing

* [X] API: Edit comment by id in mysql/rdf: modifies GeneRIF and GeneRIFXRef tables.
* [X] API: Modify edit comments by id to include RDF changes.

> POST /wiki/<comment-id>/edit

```
{
    "symbol": "XXXX",
    "reason": "XXXX",
    "species": "XXXX",
    "pubmed_ids": ["XXXX", "XXXX"], // Optional
    "web_url": "XXXX" // Optional
    "comment": "XXXX",
    "email": "XXXX",
    "categories": ["XXXX", "XXXX"], // Enumeration
    "initial": "XXXX", // Optional user or project code or your initials.
}
```
* [X] UI: Add buttons that edit various relevant sections.
* [X] UI: Edit page needs to fetch categories from GeneCategory table.  When comment write fails, alert with error.  When comment write success, update the comment on the page, and alert with success.
* [X] API: Modify edit comments by id to include RDF changes.
* [X] GN auth integration

### History

* [X] API: End-point to fetch all the historical data
* [X] UI: Page that contains history for how comments changes.

> GET /wiki/<comment-id>/history

```
[{
    "symbol": "XXXX",
    "reason": "XXXX",
    "species": "XXXX",
    "pubmed_ids": ["XXXX", "XXXX"], // Optional
    "web_url": "XXXX" // Optional
    "comment": "XXXX",
    "email": "XXXX",
    "categories": ["XXXX", "XXXX"], // Enumeration
    "version": "XXXX",
    "initial": "XXXX", // Optional user or project code or your initials.
}]
```

### Misc ToDos:

* [X] Review performance of query used in 72d9a24e8e65 [Genenetwork3]

### Ops

* [ ] RDF synchronization with SQL (gn-machines).
* [ ] Update RDF in tux01 and tux02.
* [ ] UI: Add "edit" button after testing.