Skip to content

Commit b35b796

Browse files
committed
Update readme
1 parent c2a3ed3 commit b35b796

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@ JSONAPI support for loopback.
1212
[http://jsonapi.org/](http://jsonapi.org/)
1313

1414
## Status
15-
This project is a work in progress. Consider it alpha software.
16-
I am VERY interested in help to get this module over the line. See the [issue tracker](https://github.com/digitalsadhu/loopback-component-jsonapi/issues)
15+
This project is a work in progress. Consider it beta software. For ember users, this should be
16+
basically working except for side loading which should be coming pretty soon.
17+
The functionality that is present is pretty well tested. 100 integration tests and counting!
1718

1819
Currently supported:
1920
- Find all records via GET
@@ -24,12 +25,15 @@ Currently supported:
2425
- All errors have now been transformed into the correct JSON API format
2526
- Find related records via GET eg. /posts/1/comments (belongsTo, hasMany, hasOne)
2627
- Find relationships via GET eg. /posts/1/relationships/author (belongsTo, hasMany, hasOne)
28+
- Creating resource relationship linkages during a resource create
29+
- Updating/deleting resource relationship linkages during a resource update
2730

2831
Not yet properly supported:
29-
- Create relationship via POST (hasMany, belongsTo, hasOne, etc)
30-
- Update relationship via PATCH (hasMany, belongsTo, hasOne, etc)
31-
- Delete relationship via DELETE (hasMany, belongsTo, hasOne, etc)
32-
- [Fetching includes](http://jsonapi.org/format/#fetching-includes)
32+
- Side loading data is in the works but is not yet supported
33+
- manipulating relationships directly via:
34+
- POST /:resource/relationships/:relatedResource
35+
- PATCH /:resource/relationships/:relatedResource
36+
- DELETE /:resource/relationships/:relatedResource
3337

3438
## Requirements
3539
- loopback ^v2.0.0
@@ -38,6 +42,9 @@ Not yet properly supported:
3842
## Sample Project
3943
We have created a sample project using [EmberJS](http://emberjs.com), [Loopback](http://loopback.io) and this compoment. It's called [emberloop](https://github.com/tsteuwer/emberloop).
4044

45+
## Helping out
46+
We are VERY interested in help. See the [issue tracker](https://github.com/digitalsadhu/loopback-component-jsonapi/issues)
47+
4148
## Usage
4249
In your loopback project:
4350

0 commit comments

Comments
 (0)