Issue deprecation notice for key_transform default changes

[ianks]

Today I upgraded AMS and spent a chunk of time trying to understand why my keys were all incorrect. It turns out that all of the keys in the JSONAPI adapter are now, by default, using the :dashed option....

IMO, this a breaking change, and unexpected. If we want to set some defaults that are different from the current behavior, I think a deprecation cycle is necessary. Also, we should keep the transformation as :unaltered until the deprecation cycle is over.

This change is going to cause some pain and breakage if we do not have some sort of warning about this behavior change.

[bf4]

@ianks Sorry about that. I agree. It should have been in a breaking changes section at the very least. cc @remear

[bf4]

the JSON API default is good, but we should deprecate till next release

[NullVoxPopuli]

@ianks were you at least able to configure your keys to be what you need?

[bf4]

Was this from #1629 (gotta 🏃 )

[NullVoxPopuli]

Yeah, it should stay the way it is, dasherized is what the spec says. But yeah, we should be sure to catch breaking changes in the changlog in the future.

[ianks]

The spec recommends dasherizing, it is not a must. Therefore I think it is reasonable to change the default after a deprecation cycle, since we are still technically in line with the spec. Making dasher-izing the default will serve to enhance the spec.

[NullVoxPopuli]

@ianks were you able to get ams working with your project via the key transform config option? (which will become transform, after @remear next PR).

we are still in release candidate phases so nothing is totally set in stone yet. We strive to achieve reasonable defaults by the time we get to 0.1 (aka 1.0 (maybe)) released.

[bf4]

@NullVoxPopuli I still favor communicating better. We recommend people use master. Our rc isn't a real rc. We're in a weird state.

If we're closing this issue, I'd like to see some resolution or action item.