Schema for Juju RPC messages

[Katherine Cox-Buday]

Mark Shuttleworth <mark at ubuntu.com> writes:

> On 27/07/16 19:43, Reed O'Brien wrote:
>
>     +1
>     
>     
>     On Wed, Jul 27, 2016 at 9:52 AM, Katherine Cox-Buday
>     <katherine.cox-buday at canonical.com> wrote:
>     
>     
>         I am a huge fan of publishing schema's and then generating
>         SDKs and documentation websites off of them. It brings your
>         API closer to language agnostic, removes the burden on us
>         having to hand-craft both our API client and our documentation
>         site, and makes validation implicit. I'm not up on what the
>         best tools for doing this are, but Swagger[1] seems to be
>         popular.
>
> Schemas are excellent for test suites and tool validation, but
> auto-generated bindings are *always* uuuuugly. Please don't make that
> plan A for any language you care about. From a house perspective, Go,
> JS and Python need designed and human-curated bindings that are
> idiomatic for coders who love those languages.
>
> Mark
>

Good point, Mark. I agree that it's difficult to make an auto-generated client idiomatic/nice to use. What I like to do is use the schema to auto-generate the boilerplate, and then wrap that with a small shim that is more crisp.

Do you have an opinion on this approach?

-- 
Katherine