CiviCRM

Docs for v2 API are incomplete

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed/Completed
  • Affects Version/s: 2.0
  • Fix Version/s: 2.1
  • Component/s: Documentation
  • Labels:
    None

Description

Several API functions from 1.x changed or were removed after early releases of 2.0. CRM-2691 requested the removal of several 1.x API functions but their replacements are either not yet available, or not immediately obvious.

Some of the new API docs are not yet complete, making it difficult to migrate to the new API. Where no 2.x API function will be made available to replace the 1.x equivalent, it would be very helpful to have a documented method of using the internal functions to achieve the same functionality.

Several forum threads indicate that there is demand for this to be resolved:
 * http://forum.civicrm.org/index.php/topic,2577.0.html
 * http://forum.civicrm.org/index.php/topic,2970.0.html
 * http://forum.civicrm.org/index.php/topic,2925.0.html
 * http://forum.civicrm.org/index.php/topic,2551.0.html
 * http://forum.civicrm.org/index.php/topic,2804.0.html
 * http://forum.civicrm.org/index.php/topic,2956.0.html
 * http://forum.civicrm.org/index.php/topic,2852.0.html

Several 1.x API functions were removed a couple of weeks after 2.0 went beta, and we didn't anticipate API functions would be removed at that point.

I'd be really happy to contribute docs where possible for this issue, but I don't feel I'm familiar enough yet with CiviCRM internals to identify the best way to achieve replacement functionality for the functions which have gone, so I'd want to liaise with other developers who can advise on the best way to document them.

Activity

Hide
Donald A. Lobo added a comment -

1. we'll go clean up the documentation and remove deprecated functions

2. Can you be more specific and let us know what functions you want the equivalent of? Most of them should be present in the respective BAO's. lets chat on IRC about this
Show
Donald A. Lobo added a comment - 1. we'll go clean up the documentation and remove deprecated functions 2. Can you be more specific and let us know what functions you want the equivalent of? Most of them should be present in the respective BAO's. lets chat on IRC about this
Hide
Donald A. Lobo added a comment -

manish: please clean up the docs and remove stuff that is not currently supported
Show
Donald A. Lobo added a comment - manish: please clean up the docs and remove stuff that is not currently supported
Hide
Manish Zope added a comment -
Fixed the docs
If, still, I am missing any changes, sorry for that
Please let me know such cases
Show
Manish Zope added a comment - Fixed the docs If, still, I am missing any changes, sorry for that Please let me know such cases
Hide
David Greenberg added a comment -
I've made a bunch of corrections in the Public API page - so we're getting closer. Issues needing to be fixed are:

1. There's no documentation for the new Membership APIs. I've created a stub page for this at:
http://wiki.civicrm.org/confluence/display/CRMDOC/Membership+APIs

2. No doc for new Note APIs. Stub page at:
http://wiki.civicrm.org/confluence/display/CRMDOC/Note+APIs

3. What's the status of the Profile APIs? http://wiki.civicrm.org/confluence/display/CRMDOC/Profile+APIs
I assume they're deprecated - if so, rename and move that page to (deprecated) section - and add a short new page giving a quick idea of what folks are supposed to do (I assume use BAO's - so we could point them to BAO's and unit tests).
Show
David Greenberg added a comment - I've made a bunch of corrections in the Public API page - so we're getting closer. Issues needing to be fixed are: 1. There's no documentation for the new Membership APIs. I've created a stub page for this at: http://wiki.civicrm.org/confluence/display/CRMDOC/Membership+APIs 2. No doc for new Note APIs. Stub page at: http://wiki.civicrm.org/confluence/display/CRMDOC/Note+APIs 3. What's the status of the Profile APIs? http://wiki.civicrm.org/confluence/display/CRMDOC/Profile+APIs I assume they're deprecated - if so, rename and move that page to (deprecated) section - and add a short new page giving a quick idea of what folks are supposed to do (I assume use BAO's - so we could point them to BAO's and unit tests).
Hide
Junia Biswas added a comment -
documented all APIs with example
Show
Junia Biswas added a comment - documented all APIs with example

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: