Updated note on x_by columns to be clearer

refs: https://github.com/TryGhost/Toolbox/issues/229
refs: https://github.com/TryGhost/Toolbox/issues/407

- x_by columns are deprecated in favour of actions
This commit is contained in:
Hannah Wolfe 2022-09-09 20:12:42 +01:00
parent bf134efa1f
commit e2f69f7a4e
No known key found for this signature in database
GPG Key ID: AB586C3B5AE5C037

View File

@ -39,13 +39,11 @@ module.exports = function (Bookshelf) {
/**
* @NOTE:
*
* This is a dirty hotfix for v0.1 only.
* The `x_by` columns are getting deprecated soon (https://github.com/TryGhost/Ghost/issues/10286).
* This is a dirty fix until we get rid of all the x_by columns
* @deprecated x_by columns are deprecated as of v1.0 - instead we should use the actions table
* see https://github.com/TryGhost/Ghost/issues/10286.
*
* We return the owner ID '1' in case an integration updates or creates
* resources. v0.1 will continue to use the `x_by` columns. v0.1 does not support integrations.
* API v2 will introduce a new feature to solve inserting/updating resources
* from users or integrations. API v2 won't expose `x_by` columns anymore.
* We return the owner ID '1' in case an integration updates or creates resources.
*
* ---
*