Jump to: navigation, search

Difference between revisions of "Swift/API"

Line 1: Line 1:
 
= Swift API Definition =
 
= Swift API Definition =
  
Goal: To define the v1.0 API spec for Swift. We should try to not exclude existing clusters with a v1 definition
+
Goal: To define the v1.0 API spec for Swift.
 +
 
 +
We should try to not exclude existing clusters with a v1 definition. Later, after the v1 API is set, then we can discuss changes for v1.1 or v2.
  
 
== Current v1 API docs ==
 
== Current v1 API docs ==

Revision as of 20:00, 3 May 2013

Swift API Definition

Goal: To define the v1.0 API spec for Swift.

We should try to not exclude existing clusters with a v1 definition. Later, after the v1 API is set, then we can discuss changes for v1.1 or v2.

Current v1 API docs

http://docs.openstack.org/api/openstack-object-storage/1.0/content/


Outstanding TODOs

  1. What do we do about middleware? (see below)
  2. Implement API versioning and discoverability (see http://lists.openstack.org/pipermail/openstack-dev/2013-May/008436.html)
  3. Update docs to reflect API changes

Middleware

Middleware In v1 API Notes
account_quotas no [2]
acl no [1]
bulk no [2]
catch_errors no [1]
cname_lookup no [2]
container_quotas no [2]
crossdomain no [2]
domain_remap no [2]
formpost no [2]
healthcheck yes required
keystoneauth yes openstack
list_endpoints no [2]
memcache no [1]
name_check no [2]
proxy_logging no [1]
ratelimit no [2]
recon no [1]
slo no [2]
staticweb no [2]
tempauth no For testing
tempurl no [2] [3]

notes

[1] Not part of the external API, therefore NA

[2] Not widely deployed

[3] torgomatic wants this in core since it's been around forever and there are tons of use cases