You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by Apache Wiki <wi...@apache.org> on 2010/10/12 05:43:02 UTC
[Couchdb Wiki] Update of "Complete_HTTP_API_Reference" by TimSmith
Dear Wiki user,
You have subscribed to a wiki page or wiki category on "Couchdb Wiki" for change notification.
The "Complete_HTTP_API_Reference" page has been changed by TimSmith.
The comment on this change is: Add internal anchors to allow directly to a subsection of this page.
http://wiki.apache.org/couchdb/Complete_HTTP_API_Reference?action=diff&rev1=26&rev2=27
--------------------------------------------------
= Complete HTTP API Reference =
+ <<Anchor(server)>>
- Server-level miscellaneous methods:
+ == Server-level miscellaneous methods ==
||GET||/||Returns MOTD and version||HttpGetRoot||
||GET||/favicon.ico||Special path for providing a site icon||HttpGetFavicon||
||GET||/_all_dbs||Returns a list of all databases on this server||HttpGetAllDbs||
@@ -15, +16 @@
||GET||/_sleep||Returns success after waiting for a given number of milliseconds ''(removed since 1.0.0)''||
||GET||/_utils/'''file'''||Return static web pages that contain the CouchDB administration interface||
+ <<Anchor(configuration)>>
- Server configuration:
+ == Server configuration ==
||GET||/_config||Returns the entire server configuration||
||GET||/_config/'''section'''||Returns a single section from server configuration||
||GET||/_config/'''section'''/'''key'''||Returns a single configuration value from given section in server configuration||
||PUT||/_config/'''section'''/'''key'''||Set a single configuration value in a given section to server configuration||
||DELETE||/_config/'''section'''/'''key'''||Delete a single configuration value from a given section in server configuration||
+ <<Anchor(authentication)>>
- Authentication:
+ == Authentication ==
||GET||/_session||Returns cookie based login user information||
||POST||/_session||Do cookie based user login||
||DELETE||/_session||Logout cooked based user||
@@ -31, +34 @@
||POST||/_oauth/authorize||XXX||
||*||/_oauth/request_token||XXX||
+ <<Anchor(database)>>
- Database methods:
+ == Database methods ==
||GET||/'''db'''||Returns database information||
||PUT||/'''db'''||Create a new database||
||DELETE||/'''db'''||Delete an existing database||
@@ -52, +56 @@
||GET||/'''db'''/_revs_limit||Sets the limit of historical revisions to store for a single document in the database||
||PUT||/'''db'''/_revs_limit||Gets the limit of historical revisions to store for a single document in the database||
+ <<Anchor(document)>>
- Database document methods:
+ == Database document methods ==
||POST||/'''db'''||Inserts a new document with an automatically generated id||
||GET||/'''db'''/'''doc'''||Returns the latest revision of the document||
||PUT||/'''db'''/'''doc'''||Inserts a new version of the document||
@@ -62, +67 @@
||PUT||/'''db'''/'''doc'''/'''attachment'''||Inserts an attachment to the document||
||DELETE||/'''db'''/'''doc'''/'''attachment'''||Deletes an attachment from the document||
+ <<Anchor(local)>>
- Special non-replicating documents:
+ == Special non-replicating documents ==
||GET||/'''db'''/_local/'''local-doc'''||Returns the latest revision of the non-replicated document||
||PUT||/'''db'''/_local/'''local-doc'''||Inserts a new version of the non-replicated document||
||DELETE||/'''db'''/_local/'''local-doc'''||Deletes the non-replicated document||
||COPY||/'''db'''/_local/'''local-doc'''||Copies the non-replicated document||
+ <<Anchor(design)>>
- Special design documents:
+ == Special design documents ==
||GET||/'''db'''/_design/'''design-doc'''||Returns the latest revision of the design document||
||PUT||/'''db'''/_design/'''design-doc'''||Inserts a new version of the design document||
||DELETE||/'''db'''/_design/'''design-doc'''||Deletes the design document||
@@ -77, +84 @@
||PUT||/'''db'''/_design/'''design-doc'''/'''attachment'''||Inserts an attachment to the design document||
||DELETE||/'''db'''/_design/'''design-doc'''/'''attachment'''||Deletes an attachment from the design document||
+ <<Anchor(handlers)>>
- Special design document handlers:
+ == Special design document handlers ==
||GET||/'''db'''/_design/'''design-doc'''/_info||Returns information about the design document||
||GET||/'''db'''/_design/'''design-doc'''/_view/'''view-name'''||Returns results of the view||
||POST||/'''db'''/_design/'''design-doc'''/_view/'''view-name'''||Returns certain rows from the view||