Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Meta Issue] Deprecating in favour of official Ember Data adapter #86

Closed
5 of 6 tasks
jonkoops opened this issue Jun 19, 2015 · 7 comments
Closed
5 of 6 tasks

[Meta Issue] Deprecating in favour of official Ember Data adapter #86

jonkoops opened this issue Jun 19, 2015 · 7 comments

Comments

@jonkoops
Copy link
Contributor

The Ember Data team has decided to support JSON API out of the box in the upcoming v1.0 release. Given these developments we have decided to deprecate this library and move our users to the official Ember Data solution.

This issue is to keep track of other issues related to this topic. But should also serve as a place to discuss what we can do to make the migration as smooth as possible.

  • Reach JSON API 1.0 compliance (see Support for JSON API 1.0 #82 and Support JSON API 1.0. eneuhauser/ember-json-api#14)
  • Extend DS.JSONAPIAdapter and DS.JSONAPISerializer
  • Remove any code from adapter and serializer that is duped in the Ember Data one
  • Add a deprecation notice to the README with a link to the official Ember docs
  • Add a deprecation notice to the Bower package
  • Add a deprecation notice to the NPM package
@wecc
Copy link

wecc commented Jun 19, 2015

I've written down some steps that I think should be sufficient to transition to the new built-in JSON-API adapter/serializer:

  1. Make sure that your API conforms to JSON-API 1.0

  2. The built-in JSONAPISerializer expects type to be plural dasherized and attributes/relationships members dasherized

    If your API uses other conventions make sure to override modelNameFromPayloadKey/payloadKeyFromModelName and/or keyForAttribute/keyForRelationship to reflect your API

  3. Update your adapter(s) and serializer(s) to extend from DS.JSONAPIAdapter/DS.JSONAPISerializer

  4. Follow the transition guide to the new Serializer API if you have any customizations in your serializer (link to guide is on it's way).

Please let me know if there's anything else I can do to help. I'm also available on Slack during most of the day, CET.

@kurko
Copy link
Owner

kurko commented Jun 19, 2015

This is awesome! Thanks @wecc for your hard work.

@jonkoops
Copy link
Contributor Author

@wecc Thanks for the feedback. Let me know when docs to the new Serializer API is available.

@jonkoops
Copy link
Contributor Author

JSON API v1.0 compliance has been added in #82.

@jonkoops
Copy link
Contributor Author

jonkoops commented Oct 2, 2015

I'm thinking maybe we should just go ahead and deprecate the library. I really want to move the code over to the latest Ember Data in the 1.13.x releases, but I just haven't had the time. @kurko would this be agreeable to you as well?

@kurko
Copy link
Owner

kurko commented Oct 6, 2015

Yes. I also don't think it's worth our time and effort to move in parallel with ED.

@jonkoops
Copy link
Contributor Author

This issue is closed by #89, we are now officially deprecated!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants