ufosc / GatorWiki

A student-managed wiki for the the Department of CISE at the University of Florida

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Document API

awhigham9 opened this issue · comments

Implement a REST API for accessing and modifying documents within the backend.

Features from Arch.md

This API must support the following operations:

Accessing the contents of Document and returning them. (GET)
Creating a new Document entry, and first performing all pre-processing steps. (POST)
Deleting a Document entry.

Modification requests should be queued for review by a moderator or admin prior to completion. This might require the development of a new type of model to store requested modifications.

TODO: To solve the issue of concurrent modification, it might be best to store requested modifications as diffs or through another method.

Solving the issue of multi-client editing is particularly important. Ideas to solve it are welcome.

The listed features are not exhaustive - any other functionality to build a good RESTful API is welcome.