dev/financial#79 minimal deprecation of Contribution.transact. #15564
Conversation
|
(Standard links)
|
|
I'd like to see this merged in conjunction with #15504 which helps sites manage their transition away from this API |
|
@mattwire the way for them to ease their transition is to read the docs I wrote & implement it civicrm/civicrm-dev-docs#705 - I didn't go further with the deprecation (as I believe we should) to ease the transition |
It's great that we've now got docs and we're making progress on this. But we still need the outreach and it's still going catch some sites by surprise. The result of that surprise is potentially a loss of lot's of money for the organisation when payments fail and a need to do dev work to get it working again. Yes, they should plan their upgrades better, but we all know that doesn't happen! My position here is that either we merge both #15504 and #15564 or neither. Because I feel strongly that we need to allow time for admins to transition away from this (broken) API. |
|
@mattwire right stopping advertising the api in the explorer is the first step towards discouraging people from using / adopting it! ie this is part of the outreach It should never have been advertised in api explorer & this rectifies that. Really I'd rather add the noisy notices. I would note I've been telling people publicly for over a year not to use it (as documented) - so noisy notices would probably be better. But I agree we should make not changes that make it work less than it currently does - deprecation doesn't break it but fully removing it would! |
api/v3/Contribution.php
Outdated
| * Array of deprecated actions | ||
| */ | ||
| function _civicrm_api3_contribution_deprecation() { | ||
| return ['transact' => 'Contribute.transact is ureliable & unsupported - see https://github.com/civicrm/civicrm-dev-docs/pull/705 for how to move on']; |
There was a problem hiding this comment.
| return ['transact' => 'Contribute.transact is ureliable & unsupported - see https://github.com/civicrm/civicrm-dev-docs/pull/705 for how to move on']; | |
| return ['transact' => 'Contribute.transact is ureliable & unsupported - see https://docs.civicrm.org/dev/en/latest/financial/OrderAPI/#transitioning-from-contributiontransact-api-to-order-api']; |
|
I've merged the docs PR so the link here can reference something more permanent. See suggestion above @eileenmcnaughton In general I think this is fine to merge as it's a NFC basically just changes how the api is documented. |
|
@colemanw this is NFC but since we've merged a PR that I was strongly opposed to I think we had better merge this ASAP AND merge a PR that noisily deprecates it |
It seems urgent that we so some deprecation of this api - this is the absolute minimum. More would involve creating some noise when people use it but there is a separate issue for that. This is just to geet it out of being 'promoted' by the api explorer
eileenmcnaughton
force-pushed
the
deprectate
branch
from
08a0ebe to
779cb42
Compare
|
Test fail unrelated merging |
Overview
Mark unsupported, flawed Contribution.transact api as deprecated in api explorer
Before
No messaging to tell people not to use this api
After
Technical Details
It seems urgent that we so some deprecation of this api - this is the absolute minimum.
More would involve creating some noise when people use it but there
is a separate issue for that. This is just to get it out of being 'promoted'
by the api explorer
Comments