jshaver/walnut.js
1
0
Fork 0
forked from coolaj86/walnut.js
Code Issues Pull Requests Releases Wiki Activity

Update API.md

Browse Source
This commit is contained in:
AJ ONeal 2017-08-02 18:15:28 -06:00
parent 7b9a48338c
commit bd737849e3
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
API.md
View File

@ -158,18 +158,20 @@ Special properties of `request`:
-------------------------------- --------------------------------
```js ```js
req.apiUrlPrefix // This represents the full package path req.apiUrlPrefix // This represents the full package path without any package specific endpoints
// without any package specific endpoints // This is particularly useful when constructing webhook URLs
// i.e. https://api.example.com/api/tld.domain.pkg // 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 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 // 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 // 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 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.getSiteStore().then(function (models) {
req.Models = models; req.Models = models;