diff options
| -rw-r--r-- | issues/edit-rif-metadata.gmi | 62 |
1 files changed, 30 insertions, 32 deletions
diff --git a/issues/edit-rif-metadata.gmi b/issues/edit-rif-metadata.gmi index e261f40..23da938 100644 --- a/issues/edit-rif-metadata.gmi +++ b/issues/edit-rif-metadata.gmi @@ -6,33 +6,14 @@ * priority: high * status: in-progress -### Tasks +## 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 EndPoints -> GET /wiki/<comment-id> +### UI +* [ ] API: Get WIKI/RIF by symbol from rdf. -``` -{ - "symbol": "XXXX", - "reason": "XXXX", - "species": "XXXX", - "pubmed_ids": ["XXXX", "XXXX"], // Optional - "web_url": "XXXX" // Optional - "comments": "XXXX", - "email": "XXXX", - "categories": ["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 +> GET /wiki/<symbol> ``` [{ @@ -41,7 +22,7 @@ "species": "XXXX", "pubmed_ids": ["XXXX", "XXXX"], // Optional "web_url": "XXXX" // Optional - "comment": "XXXX", + "comments": "XXXX", "email": "XXXX", "categories": ["XXXX", "XXXX"], // Enumeration "version": "XXXX", @@ -49,7 +30,13 @@ }] ``` -* [ ] Editing data: An edit will insert a new comment (SQL+RDF) that has the same comment identifier. +* [ ] UI: Modify traits page to have "GN2 (GeneWiki)" +* [ ] UI: Integrate with API + +### Editing + +* [ ] API: Edit comment by id in mysql/rdf: modifies GeneRIF and GeneRIFXRef tables. +* [ ] API: Modify edit comments by id to include RDF changes. > POST /wiki/<comment-id>/edit @@ -66,23 +53,34 @@ "initial": "XXXX", // Optional user or project code or your initials. } ``` +* [ ] UI: Add buttons that edit various relevant sections. +* [ ] UI: Edit page needs to fetch categories from GeneCategory tabl. When comment write fails, alert with error. When comment write success, update the comment on the page, and alert with success. +* [ ] API: Modify edit comments by id to include RDF changes. +* [ ] GN auth integration -* [ ] Add new comment -- Inserts (RDF+SQL) a new gene-entry for the symbol. +### History -> POST /wiki/add +* [ ] API: End-point to fetch all the historical data +* [ ] 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. -} +}] ``` -* [ ] UI Work -* [ ] Weave in Auth +### Ops + +* [ ] RDF synchronization with SQL (gn-machines). +* [ ] Update RDF in tux01 and tux02. |