API: Allow accessing revision data

.eslintignore

@@ -803,6 +803,7 @@ packages/lib/services/rest/routes/master_keys.js
 packages/lib/services/rest/routes/notes.js
 packages/lib/services/rest/routes/ping.js
 packages/lib/services/rest/routes/resources.js
+packages/lib/services/rest/routes/revisions.js
 packages/lib/services/rest/routes/search.js
 packages/lib/services/rest/routes/tags.js
 packages/lib/services/rest/utils/collectionToPaginatedResults.js

.gitignore

@@ -789,6 +789,7 @@ packages/lib/services/rest/routes/master_keys.js
 packages/lib/services/rest/routes/notes.js
 packages/lib/services/rest/routes/ping.js
 packages/lib/services/rest/routes/resources.js
+packages/lib/services/rest/routes/revisions.js
 packages/lib/services/rest/routes/search.js
 packages/lib/services/rest/routes/tags.js
 packages/lib/services/rest/utils/collectionToPaginatedResults.js

packages/app-cli/app/command-apidoc.js

@@ -50,6 +50,9 @@ class Command extends BaseCommand {
 			{
 				type: BaseModel.TYPE_TAG,
 			},
+			{
+				type: BaseModel.TYPE_REVISION,
+			},
 		];
 
 		const lines = [];
@@ -411,7 +414,7 @@ async function fetchAllNotes() {
 			lines.push('');
 			lines.push('If no `cursor` property is provided, the API will respond with the latest change ID. That can be used to retrieve future events later on.');
 			lines.push('');
-			lines.push('The results are paginated so will need to may multiple calls to retrieve all the events. Use the `has_more` property to know if more can be retrieved.');
+			lines.push('The results are paginated so you may need multiple calls to retrieve all the events. Use the `has_more` property to know if more can be retrieved.');
 			lines.push('');
 			lines.push('## GET /events/:id');
 			lines.push('');

packages/lib/services/rest/Api.ts

@@ -10,6 +10,7 @@ import route_search from './routes/search';
 import route_ping from './routes/ping';
 import route_auth from './routes/auth';
 import route_events from './routes/events';
+import route_revisions from './routes/revisions';
 
 const { ltrimSlashes } = require('../../path-utils');
 const md5 = require('md5');
@@ -113,6 +114,7 @@ export default class Api {
 			services: this.action_services.bind(this),
 			auth: route_auth,
 			events: route_events,
+			revisions: route_revisions,
 		};
 
 		this.dispatch = this.dispatch.bind(this);

packages/lib/services/rest/routes/revisions.ts

@@ -0,0 +1,7 @@
+import defaultAction from '../utils/defaultAction';
+import { ModelType } from '../../../BaseModel';
+import { Request } from '../Api';
+
+export default async function(request: Request, id: string = null, link: string = null) {
+	return defaultAction(ModelType.Revision, request, id, link, ['id']);
+}

packages/lib/services/rest/utils/defaultAction.ts

@@ -6,7 +6,7 @@ import readonlyProperties from './readonlyProperties';
 import requestFields from './requestFields';
 import BaseItem from '../../../models/BaseItem';
 
-export default async function(modelType: number, request: Request, id: string = null, link: string = null) {
+export default async function(modelType: number, request: Request, id: string = null, link: string = null, defaultFields: string[] = null) {
 	if (link) throw new ErrorNotFound(); // Default action doesn't support links at all for now
 
 	const ModelClass = BaseItem.getClassByItemType(modelType);
@@ -20,10 +20,10 @@ export default async function(modelType: number, request: Request, id: string =
 	if (request.method === 'GET') {
 		if (id) {
 			return getOneModel({
-				fields: requestFields(request, modelType),
+				fields: requestFields(request, modelType, defaultFields),
 			});
 		} else {
-			return paginatedResults(modelType, request);
+			return paginatedResults(modelType, request, null, defaultFields);
 		}
 	}
 

packages/lib/services/rest/utils/paginatedResults.ts

@@ -5,9 +5,9 @@ import requestPaginationOptions from './requestPaginationOptions';
 import paginatedFeed, { WhereQuery, ModelFeedPage } from '../../../models/utils/paginatedFeed';
 import BaseItem from '../../../models/BaseItem';
 
-export default async function(modelType: number, request: Request, whereQuery: WhereQuery = null): Promise<ModelFeedPage> {
+export default async function(modelType: number, request: Request, whereQuery: WhereQuery = null, defaultFields: string[] = null): Promise<ModelFeedPage> {
 	const ModelClass = BaseItem.getClassByItemType(modelType);
-	const fields = requestFields(request, modelType);
+	const fields = requestFields(request, modelType, defaultFields);
 	const pagination = requestPaginationOptions(request);
 	return paginatedFeed(BaseModel.db(), ModelClass.tableName(), pagination, whereQuery, fields);
 }

readme/api/references/rest_api.md

@@ -418,6 +418,45 @@ Deletes the tag with ID :id
 
 Remove the tag from the note.
 
+# Revisions
+
+## Properties
+
+| Name  | Type  | Description |
+| ----- | ----- | ----- |
+| id    | text  |       |
+| parent_id | text  |       |
+| item_type | int   |       |
+| item_id | text  |       |
+| item_updated_time | int   |       |
+| title_diff | text  |       |
+| body_diff | text  |       |
+| metadata_diff | text  |       |
+| encryption_cipher_text | text  |       |
+| encryption_applied | int   |       |
+| updated_time | int   |       |
+| created_time | int   |       |
+
+## GET /revisions
+
+Gets all revisions
+
+## GET /revisions/:id
+
+Gets revision with ID :id
+
+## POST /revisions
+
+Creates a new revision
+
+## PUT /revisions/:id
+
+Sets the properties of the revision with ID :id
+
+## DELETE /revisions/:id
+
+Deletes the revision with ID :id
+
 # Events
 
 This end point can be used to retrieve the latest note changes. Currently only note changes are tracked.
@@ -440,7 +479,7 @@ Returns a paginated list of recent events. A `cursor` property should be provide
 
 If no `cursor` property is provided, the API will respond with the latest change ID. That can be used to retrieve future events later on.
 
-The results are paginated so will need to may multiple calls to retrieve all the events. Use the `has_more` property to know if more can be retrieved.
+The results are paginated so you may need multiple calls to retrieve all the events. Use the `has_more` property to know if more can be retrieved.
 
 ## GET /events/:id