Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 8a4f941

Browse files
committedMay 11, 2017
Better describe current status
1 parent 0ef6ac3 commit 8a4f941

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed
 

‎README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,28 @@ Please see below for the documentation relevant to you.
3434
- [![API Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/rails-api/active_model_serializers/0-8-stable)
3535

3636

37+
## Status of AMS
38+
39+
*Status*:
40+
41+
- ❗️ All existing PRs against master will need to be closed and re-opened against 0-10-stable, if so desired
42+
- ❗️ Master, for the moment, won't have any released version of AMS on it.
43+
44+
*Changes to 0.10.x maintenance*:
45+
46+
- The 0.10.x version has become a huge maintenance version. We had hoped to get it in shape for a 1.0 release, but it is clear that isn't going to happen. Almost none of the maintainers from 0.8, 0.9, or earlier 0.10 are still working on AMS. We'll continue to maintain 0.10.x on the 0-10-stable branch, but maintainers won't otherwise be actively developing on it
47+
- We may choose to make a 0.11.x ( 0-11-stable) release based on 0-10-stable that just removes the deprecations.
48+
49+
*What's happening to AMS*:
50+
51+
- There's been a lot of churn around AMS since it began back in [Rails 3.2](CHANGELOG-prehistory.md) and a lot of new libraries are around and the JSON:API spec has reached 1.0.
52+
- If there is to be a 1.0 release of AMS, it will need to address the general needs of serialization in much the way ActiveJob can be used with different workers.
53+
- The next major release *is* in development. We're starting simple and avoiding, at least at the outset, all the complications in AMS version, especially all the implicit behavior from guessing the serializer, to the association's serializer, to the serialization type, etc.
54+
- The basic idea is that models to serializers are a one to many relationship. Everything will need to be explicit. If you want to serialize a User with a UserSerializer, you'll need to call it directly. The serializer will essentially be for defining a basic JSON:API resource object: id, type, attributes, and relationships. The serializer will have an as_json method and can be told which fields (attributes/relationships) to serialize to JSON and will likely *not* know serialize any more than the relations id and type. Serializing anything more about the relations would require code that called a serializer. (This is still somewhat in discussion).
55+
- If this works out, the idea is to get something into Rails that existing libraries can use.
56+
57+
See [PR 2121](https://github.com/rails-api/active_model_serializers/pull/2121) where these changes were introduced for more information and any discussion.
58+
3759
## High-level behavior
3860

3961
## Architecture

0 commit comments

Comments
 (0)
Failed to load comments.