Couchbase

Couchbase http://www.couchbase.com/issues This file is an XML representation of an issue en-us

5.2.4

845

26-12-2012

[NCBC-204] JSON extension methods not listed in API references http://www.couchbase.com/issues/browse/NCBC-204 Couchbase .NET client library Couldn't find docs around the JSON extension methods listed here: <br/> <a href="https://www.couchbase.com/docs/couchbase-sdk-net-1.2/jsonextensions.html">https://www.couchbase.com/docs/couchbase-sdk-net-1.2/jsonextensions.html</a> NCBC-204

JSON extension methods not listed in API references

Bug Major Reopened Unresolved John Zablocki Perry Krug Tue, 15 Jan 2013 08:32:40 -0600 Sat, 18 May 2013 05:29:31 -0500 1.2.0 1.2.7 docs 0 2 Are you asking for these methods to be included in the API methods along with ExecuteStore, ExecuteGet, etc? Extension methods technically aren't API methods and aren't part of the ICouchbaseClient interface. Yes, that was what I was asking for. I'm not sure I understand why there are so many different methods for store/get, but since we are recommending customers to store their data as JSON I would assume that these are "first class citizens" and should be documented along with the other methods we support...no? The JSON extension methods are "opinionated" in that they force you to use JSON.NET for serialization and the default serializer settings that I've included. I don't know that we should recommend these extensions as the "best" option, but rather "an" option. If a user is content to rely on these basic methods, then they would be sufficient. However, there are many users who will prefer other JSON serializers or other class-to-document mapping rules. So rather than attempt to address all JSON concerns with the API, these are convenience methods, which is why they're extension methods. Extension methods in .NET allow a user to treat method like a class method, even though it's not defined in an object's interface. Thanks for the clarification John. <br/> <br/> Can we provide guidance or examples on how to use JSON more generically? I think that's reasonable. When I update the jsonextensions.html page, I'll try to add "Here's what to do if you don't want to use JSON extensions..." Thanks John, and will that then link to a piece of our "formal" documentation and API reference? <a href="http://www.couchbase.com/docs/couchbase-sdk-net-1.2/couchbase-sdk-net-json.html">http://www.couchbase.com/docs/couchbase-sdk-net-1.2/couchbase-sdk-net-json.html</a> Just as a quick re-open...could we link this from the home page of /develop/net/current as well? Rank 8555