CiviCRM Community Forums (archive)

*

News:

Have a question about CiviCRM?
Get it answered quickly at the new
CiviCRM Stack Exchange Q+A site
This forum was archived on 25 November 2017. Learn more.
How to get involved.
What to do if you think you've found a bug.



  • CiviCRM Community Forums (archive) »
  • Old sections (read-only, deprecated) »
  • Developer Discussion »
  • APIs and Hooks (Moderator: Donald Lobo) »
  • Where to find API Documentation Updated?
Pages: [1]

Author Topic: Where to find API Documentation Updated?  (Read 793 times)

Luciano S.

  • I post occasionally
  • **
  • Posts: 83
  • Karma: 2
  • iXiam Team Leader
  • CiviCRM version: 4.2+ / 4.3+ / 4.4+
  • CMS version: Drupal
  • MySQL version: 5.1+ / 5.5+
  • PHP version: 5.3+ / 5.4+
Where to find API Documentation Updated?
August 07, 2012, 06:05:58 am
Hi guys,

I am aware that the API has improved a lot lately, specially for the 4.2 release.
And I know this is the question of the million dollar, but where can I find updated documentation about it?
Developer book (http://en.flossmanuals.net/CiviCRM/DevelopAPI) and api automated generated code (http://api.civicrm.org/v3/) looks like more than 5 months without changes.

This wiki topic seems to be the ultimate resource (http://wiki.civicrm.org/confluence/display/CRMDOC41/CiviCRM+Public+APIs) and forum posts as well with some of the latest changes (sequential, filter operators, etc). But I don't find any consolidated source of information about the api status.
Any other recommendation?

cheers!

xavier

  • Forum Godess / God
  • I’m (like) Lobo ;)
  • *****
  • Posts: 4453
  • Karma: 161
    • Tech To The People
  • CiviCRM version: yes probably
  • CMS version: drupal
Re: Where to find API Documentation Updated?
August 07, 2012, 06:29:49 am
Hi,

We need to update the book indeed. Might be something to work on in the next sprint if we can get enough people behind the task.

Otherwise, In tests we trust http://tests.dev.civicrm.org/trunk/results-api_v3/
and Eileen implemented a soution that generates examples from the test.
http://svn.civicrm.org/civicrm/branches/v4.2/api/v3/

If it isn't tested, it isn't "documented for real enough so it won't change", if you use an api option/parameter that isn't tested, I would suggest you to contribute the tests, will be useful for everyone.

For the filters and options, it's mostly implemented and that's what we want to promote, but it isn't 100% working on 100% of the entities, that for historical reasons might have had a different syntax (eg. option limit vs rowCount). Not sure how to document the 'old way' without 'endorsing' it

btw, sequential has been there since the start of api v3, just not very well promoted ;)

The wiki should be more or less up to date. Do you see something missing?

Quote
Any other recommendation?

You know it's a collaborative task and that since you are offering... ;) Don't hesitate to update the wiki. If you are not sure, you can write what you think is right and post a message here to ask us to check if it's correct.

X+
« Last Edit: August 07, 2012, 06:33:26 am by xavier »
-Hackathon and data journalism about the European parliament 24-26 jan. Watch out the result

Eileen

  • Forum Godess / God
  • I’m (like) Lobo ;)
  • *****
  • Posts: 4195
  • Karma: 218
    • Fuzion
Re: Where to find API Documentation Updated?
August 07, 2012, 01:53:16 pm
I don't think anyone has run the phpdoc since Michal left :-(.

Make today the day you step up to support CiviCRM and all the amazing organisations that are using it to improve our world - http://civicrm.org/contribute

Luciano S.

  • I post occasionally
  • **
  • Posts: 83
  • Karma: 2
  • iXiam Team Leader
  • CiviCRM version: 4.2+ / 4.3+ / 4.4+
  • CMS version: Drupal
  • MySQL version: 5.1+ / 5.5+
  • PHP version: 5.3+ / 5.4+
Re: Where to find API Documentation Updated?
August 08, 2012, 08:01:44 am
Tx Xavier!
I can help you guys with the documentation.

By the way, I've implemented a new api functionality for a project I'm working on. It's a simple Contribution Type get.
It isnt part of the api (as far as I know the entity ContributionType doesn't exists now a days) and I needed it for a project, I can add that as well if it's useful. I need some directions how to contribute to the api team.

cheers!

xavier

  • Forum Godess / God
  • I’m (like) Lobo ;)
  • *****
  • Posts: 4453
  • Karma: 161
    • Tech To The People
  • CiviCRM version: yes probably
  • CMS version: drupal
Re: Where to find API Documentation Updated?
August 08, 2012, 12:07:10 pm
Quote from: sluc23 on August 08, 2012, 08:01:44 am
Tx Xavier!
I can help you guys with the documentation.


If you're in europe, you might want to join at the code sprint, will be a good opportunity.

I don't have civi in front of me, but isn't contributionType one of the OptionGroup/OptionValues ?

If not, patch welcome, have you already written the unit tests too?
-Hackathon and data journalism about the European parliament 24-26 jan. Watch out the result

sjthespian

  • I post occasionally
  • **
  • Posts: 63
  • Karma: 3
    • The League of Professional System Administrators
  • CiviCRM version: 4.2.7
  • CMS version: Drupal 6.28
  • MySQL version: 5.1.66
  • PHP version: 5.3.3
Re: Where to find API Documentation Updated?
August 30, 2012, 02:30:53 pm
I'm trying to do some work with contributions with the API (replacing some old code I wrote that goes directly against the database) and as far as I can tell contribution types only exist in civicrm_contribution_types. It would be really useful to have the ContributionType methods in the API.
Dan Rich <drich@lopsa.org>
    Director, LOPSA - http://lopsa.org/

Eileen

  • Forum Godess / God
  • I’m (like) Lobo ;)
  • *****
  • Posts: 4195
  • Karma: 218
    • Fuzion
Re: Where to find API Documentation Updated?
August 30, 2012, 04:25:06 pm
Hi Katie from Wikipedia actually wrote an API for that - there's a ticket somewhere - but was going to write a unit test so we could include it in core.
Make today the day you step up to support CiviCRM and all the amazing organisations that are using it to improve our world - http://civicrm.org/contribute
Pages: [1]
  • CiviCRM Community Forums (archive) »
  • Old sections (read-only, deprecated) »
  • Developer Discussion »
  • APIs and Hooks (Moderator: Donald Lobo) »
  • Where to find API Documentation Updated?

This forum was archived on 2017-11-26.