summaryrefslogtreecommitdiff
path: root/issues/edit-rif-metadata.gmi
blob: 64107533e01812ff243347d6f51cad59aedb01ea (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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# Edit RIF Metadata in GN2

## Tags

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

### Tasks

* [ ] Update GeneRIF metadata to contain the VersionId. 
* [ ] Update GeneRIF metadata to add a dct:identifier for each comment (for the GeneRIF table this is the table id since this is the only way to group comments historically). 
* [ ] Update GeneRIF metadata to add a "initial" for each comment. 

* [ ] Get wiki-entry: Get's the latest wiki entry from RDF: 
,----
| GET /wiki/<comment-id>
`----

```
{
    "symbol": "XXXX",
    "reason": "XXXX",
    "species": "XXXX",
    "pmid": ["XXXX", "XXXX"], // Optional
    "web-url": "XXXX" // Optional
    "wiki-entry": "XXXX",
    "e-mail": "XXXX",
    "user-code": "XXXX", // Optional
    "category": ["XXXX", "XXXX"], // Enumeration
    "version": "XXXX",
    "initial": "XXXX", // Optional user or project code or your initials.
}
```

* [ ] Get wiki-entry history: Get's the previous versions of the comment from RDF: 

,----
| GET /wiki/<comment-id>/history
`----

```
[{
    "symbol": "XXXX",
    "reason": "XXXX",
    "species": "XXXX",
    "pmid": ["XXXX", "XXXX"], // Optional
    "web-url": "XXXX" // Optional
    "wiki-entry": "XXXX",
    "e-mail": "XXXX",
    "user-code": "XXXX", // Optional
    "category": ["XXXX", "XXXX"], // Enumeration
    "version": "XXXX",
    "initial": "XXXX", // Optional user or project code or your initials.
}]
```

* [ ] Editing data:  An edit will insert a new comment (SQL+RDF) that has the same comment identifier. 

,----
| POST /wiki/<comment-id>/edit
`----


```
{
    "symbol": "XXXX",
    "reason": "XXXX",
    "species": "XXXX",
    "pmid": ["XXXX", "XXXX"], // Optional
    "web-url": "XXXX" // Optional
    "wiki-entry": "XXXX",
    "e-mail": "XXXX",
    "user-code": "XXXX", // Optional
    "category": ["XXXX", "XXXX"], // Enumeration
    "version": "XXXX",
    "initial": "XXXX", // Optional user or project code or your initials.
}
```

* [ ] Add new comment -- Inserts (RDF+SQL) a new gene-entry for the symbol. 

,----
| POST /wiki/add
`----


```
{
    "symbol": "XXXX",
    "species": "XXXX",
    "pmid": ["XXXX", "XXXX"], // Optional
    "web-url": "XXXX" // Optional
    "wiki-entry": "XXXX",
    "e-mail": "XXXX",
    "user-code": "XXXX", // Optional
    "category": ["XXXX", "XXXX"], // Enumeration
    "version": "XXXX",
    "initial": "XXXX", // Optional user or project code or your initials.
}
```

* [ ] UI Work 
* [ ] Weave in Auth