From 9c419b0d5f611ed2fe0b0a236b73c2f68b1354b3 Mon Sep 17 00:00:00 2001 From: cylkee Date: Tue, 15 Dec 2020 17:40:18 +0000 Subject: [PATCH] Add note that Entries plugin requires 'index' Page After I couple of hours of testing, head-scratching, head-banging, I noticed the comment here https://github.com/symphonists/rest_api/blob/30ad34a934f79ab1a91628edd88d3291efb0e3f7/plugins/entries/rest.entries.php#L88 I was testing in a new installation without any pages yet, wondering why a 404 was being thrown, that wasn't an API formatted 404. --- README.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index 66e1514..17e36f8 100644 --- a/README.markdown +++ b/README.markdown @@ -82,6 +82,8 @@ Incomplete documentation. Eventually similar documentation to Section Schemas ex The Entries plugin provides the same functionality of data sources (read entries) and events (create and update entries). +Please note, this plugin assumes your Symphony installation has at least a Page assigned the type index. + To **list entries** from a section: /symphony/api/entries/:section_handle @@ -227,4 +229,4 @@ An explanation of the above: * `rest_api request` is saying use the `request` script from the `rest_api` extension * `-path the/path/here` passes the REST URL as if you were using the REST API via HTTP * `-format json` is the equivalent of `?format=json` -* `-method get` is the equivalent of an HTTP GET \ No newline at end of file +* `-method get` is the equivalent of an HTTP GET