From 10bdac0109e2433619a0471ca949a7e839ddfb29 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Wed, 2 Aug 2017 18:21:42 -0600 Subject: [PATCH] Update API.md --- API.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/API.md b/API.md index 08ba4e3..8843110 100644 --- a/API.md +++ b/API.md @@ -158,6 +158,10 @@ Special properties of `request`: -------------------------------- ```js +req.getSiteCapability(pkg) // Promises a capability on behalf of the current site (req.experienceId) without exposing secrets + +req.webhookParser(pkg, req, opts) // Allows the use of potentially dangerous parsers (i.e. urlencoded) for the sake of webhooks + req.apiUrlPrefix // This represents the full package path without any package specific endpoints // This is particularly useful when constructing webhook URLs // i.e. https://api.example.com/api/pkg@domain.tld @@ -172,6 +176,11 @@ req.clientApiUri // The api URL for the instance of an app req.pkgId // The name of the package being accessed // i.e. the 'hello@example.com' part of https://api.example.com/api/hello@example.com/kv/foo +``` + +Internal (and/or deprecated) APIs that you will very likely encounter + +``` req.getSiteStore().then(function (models) { req.Models = models;