Document Hydroshare Drupal REST APIs

[jeffersonheard]

See this Gist on Drupal API access

We need to document the RESTful APIs for Geoanalytics and Hydroshare so that someone can:

• Create a resource
• List resources
• Update a resource
• Delete a resource
• Understand any API differences between content types

Every API call needs to have documented:

• Purpose
• Endpoint
• Required parameters
• Optional parameters
• Whether login is optional

In addition, we need to document authentication via the webservice

Right now, I don't myself know enough about the services module to say whether we need separate documentation for each content type, or whether the services are at all self-describing. I suppose we shall see. The documentation on Services is pitiful on the Drupal website; they suggest listening to an hour long presentation on what Services does and list a few (they claim outdated) examples.

Still, it's what we need.

[StephCMills]

I met with Jeff Heard to discuss this document, and I should have more information from Brian Miles soon.

[jeffersonheard]

We are actively working on this document now. Complete API documentation will cover Jeff Horsburgh's document, highlighting CRUD features, authentication and authorization, and WFS/WMS/Subsetting features of different data types.