forked from sane/sails-hook-jsonapi
-
Notifications
You must be signed in to change notification settings - Fork 0
/
package.json
57 lines (57 loc) · 3.44 KB
/
package.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
{
"name": "sails-hook-flagpole",
"version": "0.1.0",
"description": "Sails responses with superpowers.",
"main": "index.js",
"sails": {
"isHook": true
},
"scripts": {
"test": "tape tests/responses/*.js | tap-spec",
"lint": "eslint lib/ tests/responses/",
"pretest": "npm run lint"
},
"keywords": [
"sails",
"jsonapi",
"sails-hook",
"api",
"ember-data"
],
"author": {
"name": "Brett Neese"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/brettneese/sails-hook-flagpole/issues"
},
"repository": {
"type": "git",
"url": "git+https://github.com/brettneese/sails-hook-flagpole.git"
},
"dependencies": {
"jsonapi-serializer": "https://github.com/brettneese/jsonapi-serializer/tarball/master",
"pluralize": "^1.1.2",
"sails-build-dictionary": "^0.10.1"
},
"devDependencies": {
"barrels": "^1.5.0",
"eslint": "^1.0.0",
"eslint-config-ianvs": "^0.0.6",
"eslint-config-standard": "^4.0.0",
"eslint-plugin-standard": "^1.1.0",
"sails": "^0.11.0",
"sails-memory": "^0.10.5",
"tap-spec": "^4.0.2",
"tape": "^4.0.1",
"tape-catch": "^1.0.4"
},
"gitHead": "20908ad8ba9266c29dc236acd633a91cd20959d0",
"readme": "<p align=\"center\"><img src=\"/../images/sails.png?raw=true\" height=\"80\"/><img src=\"/../images/jsonapi.png?raw=true\" height=\"80\"/></p>\n\n# sails-hook-flagpole\n\nThis is a [Sails JS](http://sailsjs.org) hook for creating an API which conforms to JSON API specifications per jsonapi.org.\n\n*Note*: This project is still in development, and is not yet fully functional. \n\n### Installation\n\nWhen we get on NPM:\n\n`npm install sails-hook-flagpole`\n\n### Usage\n*requires at least sails >= 0.11*\n\nJust lift your app as normal, and your api responses will be formatted in accordance with [jsonapi.org](http://jsonapi.org/format/).\n\n#### Options\nCreate a `jsonapi.js` file inside the `config/` directory of your app, and you can set the following options:\n\n| Option | Default | Description |\n|---------------|:---------:|---------------|\n| `compoundDoc` | `true` | When set to 'true' (default), response will be a [compound document](http://jsonapi.org/format/#document-compound-documents). Otherwise, related resources will be nested within the top-level resource attributes. |\n| `included` | `true` | When set to `true` (default), related resource data will be [included](http://jsonapi.org/format/#fetching-includes) in the response. Currently, `include` parameters in client requests are not supported. |\n\n\n### Known Limitations\n\nThis is still a project-in-work. So far, the following are not yet implemented:\n\n- [ ] Included request parameter handling (400 response if present)\n- [ ] Links\n - [ ] Top-level \"self\" links\n - [ ] Top-level \"related\" links\n - [ ] Resource-level \"self\" links\n - [ ] Related resource relationship links\n - [ ] Metadata links\n- [ ] Pagination\n- [ ] Formatting\n - [ ] Non-dasherized attributes\n- [ ] Sparse fieldsets\n\nThere may be more. Please submit issue reports.\n",
"readmeFilename": "README.md",
"homepage": "https://github.com/brettneese/sails-hook-flagpole#readme",
"_id": "sails-hook-flagpole@0.1.0",
"_shasum": "e955a5bc521a1ec69f5c288cb2bcd1661bc79efb",
"_from": "git+https://github.com/brettneese/sails-hook-flagpole.git",
"_resolved": "git+https://github.com/brettneese/sails-hook-flagpole.git#20908ad8ba9266c29dc236acd633a91cd20959d0"
}