Skip to content
This repository has been archived by the owner on Dec 27, 2022. It is now read-only.

Stabilize API

lusis edited this page Apr 6, 2011 · 3 revisions

Please note that the current API docs for Application and Configuration are out of date due to the recent refactor. Updates coming shortly

Stabilize API

One of the first milestones should be to stabilize the API around each resource. REST resources and operations are based around this article by Adam Wiggins. Therefore

  • GET - read
  • POST - create
  • PUT - update
  • DELETE - delete

and those operations act on each object sub-path i.e.

  • GET /h/hostname - Gets Host hostname
  • DELETE /s/servicename/hostname - Deletes Service servicename for Host hostname
  • PUT /c/appname/configname - Updates Configuration configname for Application appname

In the case of ease of use, I've opted to combined POST and PUT. Any PUT operation will optionally create any missing components. Using the PUT example above should appname not exist, it will optionally be created.

Proposed Resource APIs

Clone this wiki locally