Add /revisions endpoint #84

rijkvanzanten · 2018-04-23T15:28:51Z

There is currently no way of accessing the revisions from the API. The application needs this to be able to render / make available the rollback functionality

Ref: #84

wellingguzman · 2018-04-25T21:19:54Z

Four endpoints:

GET /revisions - Fetch all revisions from directus_revisions collection.
GET /revisions/<id> - Fetch the revision with the given id from directus_revisions collection.
GET /revisions/collection/<collection> - Fetch all revisions from a given collection.
GET /revisions/collection/<collection>/<id> - Fetch all revisions of a given item id and collection.

rijkvanzanten · 2018-04-25T21:38:04Z

@benhaynes Add to reference please 😄?

benhaynes · 2018-04-25T21:48:42Z

Sure! But first, do we want /items/[collection-name]/[pk]/revisions (or something like that)? Worth an alias? Seems more natural, like: I'm looking for an item... now I'm looking for a different revision of that item.

Thoughts? @wellingguzman @rijkvanzanten

wellingguzman · 2018-04-25T22:07:25Z

I believe /revisions/collection/<collection>/<id>, instead of using /items/[collection-name]/[pk]/revisions, as it wraps everything on revisions.

But I also like having it on items because of this: /items/[collection-name]/[pk]/revisions/<revision> which makes more sense to use alongside with /items/[collection-name]/[pk]/revisions

benhaynes · 2018-04-25T22:13:04Z

Exactly.

I think we could make the item revision endpoint more useful... using an 0-based offset instead of the revision id. Like this:

Syntax:
/items/[collection-name]/[pk]/revisions/<revision-offset>

Example2:

/items/projects/1/revisions (fetches all revisions for this item)
/items/projects/1/revisions/2 (fetches SECOND FROM CREATION revision from this item)
/items/projects/1/revisions/-2 (fetches SECOND BACK FROM CURRENT revision from this item)

rijkvanzanten · 2018-04-25T22:15:35Z

All in favor of this? Aye

benhaynes · 2018-04-25T22:17:34Z

Aye!

I think we keep the current ones in system (using revision.id)... but add the /items revisions with the offset too.

wellingguzman · 2018-04-25T22:18:28Z

Are we getting rid of All /revisions endpoints or are we going to add items revisions as extra for fetching revision offset?

benhaynes · 2018-04-25T22:19:28Z

Add extra...

wellingguzman · 2018-04-25T22:20:57Z

Final endpoints?

GET /revisions - Fetch all revisions from directus_revisions collection.
GET /revisions/<id> - Fetch the revision with the given id from directus_revisions collection.
~~GET /revisions/collection/<collection> - Fetch all revisions from a given collection.~~
~~GET /revisions/collection/<collection>/<id> - Fetch all revisions of a given item id and collection.~~
GET /items/<collection>/revisions - Fetch all revisions from a given collection.
GET /items/<collection>/<id>/revisions - Fetch all revisions from an item.
GET /items/<collection>/<id>/revisions/<offset> - Fetch the revision at <offset>.

benhaynes · 2018-04-25T22:23:50Z

I updated your comment to keep this clean... that should be accurate. @rijkvanzanten ??

benhaynes · 2018-04-25T22:26:10Z

Hmm, would this mean we also need to reserve revisions as a primary key string? If so, maybe we move THAT endpoint back to the System one at /revisions.

GET /items/<collection>/revisions

benhaynes · 2018-04-25T22:29:00Z

Lastly, do we want to combine /revisions/[collection-name] and /revisions and use filters param instead? That would make it more like the other endpoints.

wellingguzman · 2018-04-25T22:40:14Z

Hmm, would this mean we also need to reserve revisions as a primary key string? If so, maybe we move THAT endpoint back to the System one at /revisions.

What do you mean? directus_revisions will be a integer primary key, why would we need to change it string?

Lastly, do we want to combine /revisions/[collection-name] and /revisions and use filters param instead? That would make it more like the other endpoints.

Agreed! that's why I believe we should remove the /revisions/[collection-name] and /revisions/[collection-name]/[revision-id] endpoints.

benhaynes · 2018-04-25T22:42:07Z

No no, if I have a projects table where the primary key is a string... and one of my pk is revisions... that would break this endpoint:

GET /items/<collection>/revisions
GET /items/<collection>/revisions/revisions

wellingguzman · 2018-04-25T22:46:05Z

Oh! True! I prefer moving back to the system endpoint, where we know we have integer as primary key.

@rijkvanzanten?

wellingguzman · 2018-04-25T22:48:41Z

oh wait, what about getting rid of GET /items/<collection>/revisions and just use GET /revisions?filter=<filter collection>?

benhaynes · 2018-04-25T22:48:46Z

I agree!

This seems like the final endpoints:

GET /revisions - Fetch all revisions. Can use filter param to get only one collection
GET /revisions/<id> - Fetch the revision with the given id from directus_revisions collection
GET /items/<collection>/<id>/revisions - Fetch all revisions from an item
GET /items/<collection>/<id>/revisions/<offset> - Fetch the revision at <offset>

benhaynes · 2018-04-25T22:50:18Z

Awesome. If it helps, I've already tried to update the new API Docs with these endpoints 😀

wellingguzman · 2018-04-25T23:02:58Z

So it's official! I'm going to update the endpoints.

* Return object in delete after hook instead of onli ID (#882) * Add fix for big file sizes Closes #750 * Add migrations for hash and single-file * Show correct fields in roles.users For some reason the database column for options was empty Closes https://github.com/directus/app/issues/1471 * Delete ISSUE_TEMPLATE.md * security notice * Add check for mod_php before setting php_value for upload size This will prevent errors on systems that don't allow overriding the php values from within the .htaccess files. This will only check for php 7+ though, as the mod_php directive is version specific. This is okay for now, as we officially only support PHP 7.1+ * Change field width from integer to string This will allow the app to render the fields in the correct widths starting with v7.2. * Issue fix #854 (#896) * Add migrations for setting field notes and widths Lays out the settings a bit nicer and adds setting descriptions. Fixes https://github.com/directus/app/issues/1379 * Fix sort order of fields on install * Increase specificity of migrations so it doesn't target non-settings * Move collection notes to the DB I'm aware that this makes them english only for the time being. Once we implement the using the translation column in the app, we can make them properly translatable. * Fix abstraction name * Add migrations for misc fields Sorting of files, making a couple interfaces required, etc * Bump version * Fix: Wrong MIME for extentions in uppercase (#895) * FEAT more events that invalidate the cache (#892) * Allowing string relations (#800) * emoji support for comments and bookmark names * Use JSON interface for system collections * Fixing custom primary key primary key column name (#881) Swapping this variable seems to resolve the issue. * Bump version * Issue #885 (#898) * Test cases : AUthentication - Auth, Forgot Password, Collections - Create, Delete * Issue#885 - Done * #885 Removed Test cases * Issue #886 (#899) * Test cases : AUthentication - Auth, Forgot Password, Collections - Create, Delete * Issue#885 - Done * Issue#886 - Done * #886 Reverted unwanted code * Issue #884 (#901) * Test cases : AUthentication - Auth, Forgot Password, Collections - Create, Delete * #884 Done * #884 Removed Test cases * Issue #884 - Change (#907) * Test cases : AUthentication - Auth, Forgot Password, Collections - Create, Delete * #884 Done * #884 Removed Test cases * #884 change * Fix#810 (#908) * Test cases : AUthentication - Auth, Forgot Password, Collections - Create, Delete * #810 done * #810 Reverting Test Cases * Issue Fix #902 (#909) * Issue fix #902 * Add migration for allow value nullable in settings table * Set texttype for value field * Doc issue fix #84 (#910) * Issue fix #841 (#911) * Increase expiry time of tokens from 5 to 20 minutes (#913) It should still be pretty secure. This allows the app to go easier on the refreshing, and it makes sure that you can upload large files without having the token expire halfway through. * Fix missing ref to 5 min exp * Issue Fix #863 (#916) * Issue fix #853 (#918) * Issue Fix #920 (#922) * Issue Fix #920 * Issue Fix #920 * Generate GraphQL schema file which support primary-key, text-input and numeric interfaces. * Implement graphql-php server. * GraphQL type for DirectUs files * Code cleanup. * Adding custom scalar support for Date, Datetime, JSON * Adding support for the m2o type in schema generation. * Adding support for m2o type. * Support for O2M. GraphQL type for Directus Role. Rename GraphQL types for Directus user, files. * Adding pagination support. * Code cleanup. * Adding time scalar type. * Adding meta support. * Search filter approach 1. * Search result. * Adding support for AND and OR logical filter. * Rebase with master. * Adding support for Activity, Collection Preset, Collection, Field type. Change the naming convention. Adding pascal case function in string utils. * Adding support for setting collection. * Adding support for Folder, Permission, Relation, Revision collection. * Adding README.md * Update README.md * Change naming convention to snake_case.

* Return object in delete after hook instead of onli ID (#882) * Add fix for big file sizes Closes #750 * Add migrations for hash and single-file * Show correct fields in roles.users For some reason the database column for options was empty Closes https://github.com/directus/app/issues/1471 * Delete ISSUE_TEMPLATE.md * security notice * Add check for mod_php before setting php_value for upload size This will prevent errors on systems that don't allow overriding the php values from within the .htaccess files. This will only check for php 7+ though, as the mod_php directive is version specific. This is okay for now, as we officially only support PHP 7.1+ * Change field width from integer to string This will allow the app to render the fields in the correct widths starting with v7.2. * Issue fix #854 (#896) * Add migrations for setting field notes and widths Lays out the settings a bit nicer and adds setting descriptions. Fixes https://github.com/directus/app/issues/1379 * Fix sort order of fields on install * Increase specificity of migrations so it doesn't target non-settings * Move collection notes to the DB I'm aware that this makes them english only for the time being. Once we implement the using the translation column in the app, we can make them properly translatable. * Fix abstraction name * Add migrations for misc fields Sorting of files, making a couple interfaces required, etc * Bump version * Fix: Wrong MIME for extentions in uppercase (#895) * FEAT more events that invalidate the cache (#892) * Allowing string relations (#800) * emoji support for comments and bookmark names * Use JSON interface for system collections * Fixing custom primary key primary key column name (#881) Swapping this variable seems to resolve the issue. * Bump version * Issue #885 (#898) * Test cases : AUthentication - Auth, Forgot Password, Collections - Create, Delete * Issue#885 - Done * #885 Removed Test cases * Issue #886 (#899) * Test cases : AUthentication - Auth, Forgot Password, Collections - Create, Delete * Issue#885 - Done * Issue#886 - Done * #886 Reverted unwanted code * Issue #884 (#901) * Test cases : AUthentication - Auth, Forgot Password, Collections - Create, Delete * #884 Done * #884 Removed Test cases * Issue #884 - Change (#907) * Test cases : AUthentication - Auth, Forgot Password, Collections - Create, Delete * #884 Done * #884 Removed Test cases * #884 change * Fix#810 (#908) * Test cases : AUthentication - Auth, Forgot Password, Collections - Create, Delete * #810 done * #810 Reverting Test Cases * Issue Fix #902 (#909) * Issue fix #902 * Add migration for allow value nullable in settings table * Set texttype for value field * Doc issue fix #84 (#910) * Issue fix #841 (#911) * Increase expiry time of tokens from 5 to 20 minutes (#913) It should still be pretty secure. This allows the app to go easier on the refreshing, and it makes sure that you can upload large files without having the token expire halfway through. * Fix missing ref to 5 min exp * Issue Fix #863 (#916) * Issue fix #853 (#918) * Issue Fix #920 (#922) * Issue Fix #920 * Issue Fix #920 * Issue fix #879 (#924) * [thumbnailer] Support for files in subdirectories (#856) Many websites store images in a complex directory structure. This PR makes it possible to use thumbnailer in such cases. For instance : `/thumbnail/_/100/100/crop/good/complex/path/to/some-image.jpg * defaults cors.max-age to 600 (#921) * Bump version * Generate GraphQL schema file which support primary-key, text-input and numeric interfaces. * Implement graphql-php server. * GraphQL type for DirectUs files * Code cleanup. * Adding custom scalar support for Date, Datetime, JSON * Adding support for the m2o type in schema generation. * Adding support for m2o type. * Support for O2M. GraphQL type for Directus Role. Rename GraphQL types for Directus user, files. * Adding pagination support. * Code cleanup. * Adding time scalar type. * Adding meta support. * Search filter approach 1. * Search result. * Adding support for AND and OR logical filter. * Rebase with master. * Adding support for Activity, Collection Preset, Collection, Field type. Change the naming convention. Adding pascal case function in string utils. * Adding support for setting collection. * Adding support for Folder, Permission, Relation, Revision collection. * Adding README.md * Update README.md * Change naming convention to snake_case. * Change in naming convention. Merge list and single query into list query by adding additional arg `id`.

* pgsql 10 initial support * email_notification column must be set as a boolean * Handle unique column collisions * BUG delta in revisions can be null * BUG transformed the remaining lastInsertValue into getLastGeneratedId() * Pass new item flag to o2m new items Closes https://github.com/directus/app/issues/1418 * Don't show popover for 0 items / no template Closes https://github.com/directus/app/issues/1397 * Bug fix (#848) * Merge conflict resolve * Handle item not found exception in collection detail API * Extended the list of safe tags (#849) As described in issue #832 * Issue fix #819 (#851) * Mark adding new item as new in m2m * Bump version * Revert composer changes * Issue fix #843 (#852) * BUG searches with LIKE on non-textual columns * Remove the extensions from the API * Issue fix #847 (#857) * Issue fix #833 (#859) * Initial commit for documentation (#844) * Revert "Initial commit for documentation (#844)" (#868) This reverts commit 6e85d59. * BUG Bypass Zend-db choice not to allow nullable boolean fields * BUG field length were not taken into account * CHORE dupliacted line * BUG o2m working + post-alter table event dispatching * Return object in delete after hook instead of onli ID (#882) * Add fix for big file sizes Closes #750 * Add migrations for hash and single-file * Show correct fields in roles.users For some reason the database column for options was empty Closes https://github.com/directus/app/issues/1471 * Delete ISSUE_TEMPLATE.md * security notice * Add check for mod_php before setting php_value for upload size This will prevent errors on systems that don't allow overriding the php values from within the .htaccess files. This will only check for php 7+ though, as the mod_php directive is version specific. This is okay for now, as we officially only support PHP 7.1+ * Change field width from integer to string This will allow the app to render the fields in the correct widths starting with v7.2. * Issue fix #854 (#896) * Add migrations for setting field notes and widths Lays out the settings a bit nicer and adds setting descriptions. Fixes https://github.com/directus/app/issues/1379 * Fix sort order of fields on install * Increase specificity of migrations so it doesn't target non-settings * Move collection notes to the DB I'm aware that this makes them english only for the time being. Once we implement the using the translation column in the app, we can make them properly translatable. * Fix abstraction name * Add migrations for misc fields Sorting of files, making a couple interfaces required, etc * Bump version * Fix: Wrong MIME for extentions in uppercase (#895) * FEAT more events that invalidate the cache (#892) * Allowing string relations (#800) * emoji support for comments and bookmark names * Use JSON interface for system collections * Fixing custom primary key primary key column name (#881) Swapping this variable seems to resolve the issue. * Bump version * Issue #885 (#898) * Test cases : AUthentication - Auth, Forgot Password, Collections - Create, Delete * Issue#885 - Done * #885 Removed Test cases * Issue #886 (#899) * Test cases : AUthentication - Auth, Forgot Password, Collections - Create, Delete * Issue#885 - Done * Issue#886 - Done * #886 Reverted unwanted code * Issue #884 (#901) * Test cases : AUthentication - Auth, Forgot Password, Collections - Create, Delete * #884 Done * #884 Removed Test cases * Issue #884 - Change (#907) * Test cases : AUthentication - Auth, Forgot Password, Collections - Create, Delete * #884 Done * #884 Removed Test cases * #884 change * Fix#810 (#908) * Test cases : AUthentication - Auth, Forgot Password, Collections - Create, Delete * #810 done * #810 Reverting Test Cases * Issue Fix #902 (#909) * Issue fix #902 * Add migration for allow value nullable in settings table * Set texttype for value field * Doc issue fix #84 (#910) * Issue fix #841 (#911) * Increase expiry time of tokens from 5 to 20 minutes (#913) It should still be pretty secure. This allows the app to go easier on the refreshing, and it makes sure that you can upload large files without having the token expire halfway through. * Fix missing ref to 5 min exp * Issue Fix #863 (#916) * Issue fix #853 (#918) * Issue Fix #920 (#922) * Issue Fix #920 * Issue Fix #920 * Issue fix #879 (#924) * [thumbnailer] Support for files in subdirectories (#856) Many websites store images in a complex directory structure. This PR makes it possible to use thumbnailer in such cases. For instance : `/thumbnail/_/100/100/crop/good/complex/path/to/some-image.jpg * defaults cors.max-age to 600 (#921) * Bump version * Fix 943 (#947) * Test cases : AUthentication - Auth, Forgot Password, Collections - Create, Delete * #943 * Fix 717 (#944) * Test cases : AUthentication - Auth, Forgot Password, Collections - Create, Delete * #717 * Fix 576 (#926) * Test cases : AUthentication - Auth, Forgot Password, Collections - Create, Delete * #576 - In progress * #576 O2M and M20 nested filters * #576 Fix O2M and M2O nested filters * get proper string length (#933) Not tested... I only based this PR on: Ref: 0fce6a4#commitcomment-33408113 * fixed settings logo (#940) * added collection/table to InvalidFieldException (#956) * Fix 931 (#936) * Test cases : AUthentication - Auth, Forgot Password, Collections - Create, Delete * #931 * #931 * Issue fix #917 (#960) * reuse item service instead of using a new instance (#959) * Issue fix 762 (#961) * Plain text mail issu resolve (#966) * Bump version

rijkvanzanten added the enhancement New feature or request label Apr 23, 2018

wellingguzman closed this as completed in 9c640e7 Apr 25, 2018

wellingguzman added a commit that referenced this issue Apr 25, 2018

fix revisions endpoint name

925348c

Ref: #84

rijkvanzanten reopened this Apr 25, 2018

wellingguzman closed this as completed in 9589d22 Apr 26, 2018

binal-7span added a commit to binal-7span/api that referenced this issue Apr 26, 2019

Doc issue fix directus#84

b8a6b6b

binal-7span added a commit that referenced this issue Apr 26, 2019

Doc issue fix #84 (#910)

080ceea

Lapsus pushed a commit to Lapsus/api that referenced this issue May 8, 2019

Doc issue fix directus#84 (directus#910)

219d5d3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add /revisions endpoint #84

Add /revisions endpoint #84

rijkvanzanten commented Apr 23, 2018

wellingguzman commented Apr 25, 2018

rijkvanzanten commented Apr 25, 2018

benhaynes commented Apr 25, 2018

wellingguzman commented Apr 25, 2018

benhaynes commented Apr 25, 2018

rijkvanzanten commented Apr 25, 2018

benhaynes commented Apr 25, 2018

wellingguzman commented Apr 25, 2018

benhaynes commented Apr 25, 2018

wellingguzman commented Apr 25, 2018 •

edited by benhaynes

Loading

benhaynes commented Apr 25, 2018

benhaynes commented Apr 25, 2018

benhaynes commented Apr 25, 2018

wellingguzman commented Apr 25, 2018

benhaynes commented Apr 25, 2018

wellingguzman commented Apr 25, 2018

wellingguzman commented Apr 25, 2018

benhaynes commented Apr 25, 2018

benhaynes commented Apr 25, 2018

wellingguzman commented Apr 25, 2018

Add /revisions endpoint #84

Add /revisions endpoint #84

Comments

rijkvanzanten commented Apr 23, 2018

wellingguzman commented Apr 25, 2018

rijkvanzanten commented Apr 25, 2018

benhaynes commented Apr 25, 2018

wellingguzman commented Apr 25, 2018

benhaynes commented Apr 25, 2018

rijkvanzanten commented Apr 25, 2018

benhaynes commented Apr 25, 2018

wellingguzman commented Apr 25, 2018

benhaynes commented Apr 25, 2018

wellingguzman commented Apr 25, 2018 • edited by benhaynes Loading

benhaynes commented Apr 25, 2018

benhaynes commented Apr 25, 2018

benhaynes commented Apr 25, 2018

wellingguzman commented Apr 25, 2018

benhaynes commented Apr 25, 2018

wellingguzman commented Apr 25, 2018

wellingguzman commented Apr 25, 2018

benhaynes commented Apr 25, 2018

benhaynes commented Apr 25, 2018

wellingguzman commented Apr 25, 2018

wellingguzman commented Apr 25, 2018 •

edited by benhaynes

Loading