On Thu, 2008-11-27 at 10:13 -0800, Victor Stone wrote:
> On Wed, Nov 26, 2008 at 12:57 AM, Jon Phillips <jon@...> wrote:
> > One thing which would be helpful is to detail out anymore APIs useful
> > for development, in particular external APIs.
> There are only two external APIs - the Query API and Sample Pool API.
> (and really only half the Query API)
> > I started a basic page on this and added the two main ones:
> > http://wiki.creativecommons.org/Cchost/concepts/APIs
> > But, when looking at the commands on ccHost, I noticed a few more as
> > well in ccHost 5: http://ccmixter.org/commands/0
> That's a mistake.
> The 'commands' are only useful within the operation of the
> application. The ones that are doc'd MAY work ok from a menu or tab,
> the ones that are not doc'd are completely unsupported for usage
> outside the context they already work in. Don't confuse the internal
> calls of a library, pieces of features with a fully functioning,
> documented API.
> Calling the 'commands' from external site is 100% guaranteed to be break.
> Calling the command/0 stuff from WITHIN the site, leave alone from
> external site is asking for trouble.
> > The particular one I'm most interested in is a file manipulation API for
> > handling uploads, etc. There is some fresh work by some open clip art
> > developers on a clip art browser and want to make sure that form filling
> > nastiness is avoided with proper docs/direction.
> POST and other stuff that require user login will take some effort to
> architect and no small effort. It would *awesome* if OCA folks are
> taking this on.
Sure, there is interested dev as you saw :)
> > Also, I think it would be quite cool if the current apis could default
> > to returning some info about them via an installation...right now there
> > is a funky non-standard way to find info on cchost installations.
> Is this standard written down somewhere? Do you have examples I can
> model it after?
You know what, in looking at other apis, I don't see this functionality.
> > Why not just replace something like this http://ccmixter.org/query-api
> > with http://ccmixter.org/api/query which can print the documentation of
> > the API.
> > This is a bit different for the sample pool api which is a few different
> > apis working together:
> > http://ccmixter.org/media/viewfile/pool_api_doc.xml
> Actually its
Cool, that is better...whatever, the documentation rules and is the main
thing regardless...who cares about url standardization ;) Better to get
more dev! preaching to the choir :)
San Francisco + Beijing