From bd737849e3432755893dc0f12341a2ab7b45afb9 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Wed, 2 Aug 2017 18:15:28 -0600 Subject: [PATCH] Update API.md --- API.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/API.md b/API.md index 825171a..08ba4e3 100644 --- a/API.md +++ b/API.md @@ -158,18 +158,20 @@ Special properties of `request`: -------------------------------- ```js -req.apiUrlPrefix // This represents the full package path - // without any package specific endpoints - // i.e. https://api.example.com/api/tld.domain.pkg +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 + // (of https://api.example.com/api/pkg@domain.tld/public/foo) req.experienceId // The instance name of an app as a whole, where an app is mounted // i.e. the 'example.com' part of https://example.com/foo // OR 'example.com#foo' if '/foo' is part of the app's mount point req.clientApiUri // The api URL for the instance of an app - // the 'api.example.com' part of https://api.example.com/api/com.example.hello/kv/foo + // i.e. the 'api.example.com' part of https://api.example.com/api/hello@example.com/kv/foo - req.pkgId // the com.example.hello part of https://api.example.com/api/com.example.hello/kv/foo +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 req.getSiteStore().then(function (models) { req.Models = models;