Adding documentation pages (empty) for Webhooks.
Adding schema definition for Webhooks. Gh-183
This commit is contained in:
parent
7eefe5e5d8
commit
d19a75c2ea
8 changed files with 66 additions and 5 deletions
|
@ -52,17 +52,30 @@ Every API endpoint returns a JSON response in a [standard envelope][Envelope].
|
|||
1. [POST /tag/:id/update.json][PostTag]
|
||||
Modify meta data for a user's tag.
|
||||
|
||||
#### Webhook endpoints
|
||||
1. [GET /webhook/list.json][GetWebhooks]
|
||||
Get a user's tags.
|
||||
1. [GET /webhook/:id/view.json][GetWebhook]
|
||||
Get a user's tags.
|
||||
1. [POST /webhook/create.json][PostWebhookCreate]
|
||||
Get a user's tags.
|
||||
1. [POST /webhook/:id/delete.json][PostWebHookDelete]
|
||||
Modify meta data for a user's tag.
|
||||
1. [POST /webhook/:id/update.json][PostWebHookUpdate]
|
||||
Modify meta data for a user's tag.
|
||||
|
||||
|
||||
#### Group endpoints
|
||||
1. [GET /group/:id/view.json][GetGroup]
|
||||
Get a group.
|
||||
1. [GET /group/list.json][GetGroups]
|
||||
Get a listing of a user's groups.
|
||||
1. [POST /group/create.json][PostGroupCreate]
|
||||
Create a group.
|
||||
1. [POST /group/delete.json][PostGroupDelete]
|
||||
Delete a group.
|
||||
1. [POST /group/update.json][PostGroupUpdate]
|
||||
Update a group.
|
||||
1. [GET /group/:id/view.json][GetGroup]
|
||||
Get a group.
|
||||
1. [GET /group/list.json][GetGroups]
|
||||
Get a listing of a user's groups.
|
||||
|
||||
[Envelope]: Envelope.markdown
|
||||
[GetHelloWorld]: GetHelloWorld.markdown
|
||||
|
@ -81,5 +94,10 @@ Every API endpoint returns a JSON response in a [standard envelope][Envelope].
|
|||
[PostGroupUpdate]: PostGroupUpdate.markdown
|
||||
[GetGroup]: GetGroup.markdown
|
||||
[GetGroups]: GetGroups.markdown
|
||||
[PostWebhookCreate]: PostWebhookCreate.markdown
|
||||
[PostWebhookDelete]: PostWebhookDelete.markdown
|
||||
[PostWebhookUpdate]: PostWebhookUpdate.markdown
|
||||
[GetWebhook]: GetWebhook.markdown
|
||||
[GetWebhooks]: GetWebhooks.markdown
|
||||
[authentication]: Authentication.markdown
|
||||
[oauth1.0a]: http://oauth.net/core/1.0a/
|
||||
|
|
1
documentation/api/GetWebhook.markdown
Normal file
1
documentation/api/GetWebhook.markdown
Normal file
|
@ -0,0 +1 @@
|
|||
Not yet documented
|
1
documentation/api/GetWebhooks.markdown
Normal file
1
documentation/api/GetWebhooks.markdown
Normal file
|
@ -0,0 +1 @@
|
|||
Not yet documented
|
1
documentation/api/PostWebhookCreate.markdown
Normal file
1
documentation/api/PostWebhookCreate.markdown
Normal file
|
@ -0,0 +1 @@
|
|||
Not yet documented
|
1
documentation/api/PostWebhookDelete.markdown
Normal file
1
documentation/api/PostWebhookDelete.markdown
Normal file
|
@ -0,0 +1 @@
|
|||
Not yet documented
|
1
documentation/api/PostWebhookUpdate.markdown
Normal file
1
documentation/api/PostWebhookUpdate.markdown
Normal file
|
@ -0,0 +1 @@
|
|||
Not yet documented
|
|
@ -4,7 +4,7 @@ Documentation
|
|||
|
||||
----------------------------------------
|
||||
|
||||
### What's a Action object for?
|
||||
### What's an Action object for?
|
||||
|
||||
The Social object stores social actions taken on a user's [Photo][Photo].
|
||||
This includes comments and favorites and could include other social actions in the future.
|
||||
|
|
38
documentation/schemas/Webhook.markdown
Normal file
38
documentation/schemas/Webhook.markdown
Normal file
|
@ -0,0 +1,38 @@
|
|||
Documentation
|
||||
=======================
|
||||
#### OpenPhoto, a photo service for the masses
|
||||
|
||||
----------------------------------------
|
||||
|
||||
### What's a Webhook object for?
|
||||
|
||||
Webhooks allow each OpenPhoto instance to be _programmable_.
|
||||
Developers use webhooks to be notified of events so they can process them.
|
||||
|
||||
http://wiki.webhooks.org/w/page/13385124/FrontPage
|
||||
|
||||
----------------------------------------
|
||||
|
||||
### Schema for a Action object
|
||||
|
||||
{
|
||||
id: (string),
|
||||
appId: (string),
|
||||
callback: (string),
|
||||
topic: (enum),
|
||||
verifyToken: (string),
|
||||
challenge: (string),
|
||||
secret: (string)
|
||||
}
|
||||
|
||||
----------------------------------------
|
||||
|
||||
### Schema description
|
||||
|
||||
* id, base 36 value of a base 10 auto-incremented value
|
||||
* appId, A string identifing the application creating this entry
|
||||
* callback, URL to which the event information is POSTed
|
||||
* topic, An enumerated string with predefined values (i.e. photoupload, photoupdate, newcomment, etc.)
|
||||
* verifyToken, A string supplied by the subscriber **not used for sync**
|
||||
* challenge, A challenge string used in the verification process **not used for sync**
|
||||
* secret, An optional subscriber supplied secret for request signing
|
Loading…
Add table
Add a link
Reference in a new issue