Re: [netconf] Call for Authors

6.3 Known Limitations

Seeing a lot of REST developers see RESTCONF APIs for the first time, the
module namespacing in JSON is a big struggle

version 1
     { "some-module:some-container" : {"prop":"value"} ...}

Obviously I know why it is there, but this is a big hurdle for folks that
traditionally use JSON.  Then when I explain how it can change as different
YANG modules are  introduced

version 2
     { "some-module:some-container" : {"some-new-lib:prop":"value"} ...}

Scripts that use traditional HTTP clients (i.e. ignore the YANG defs) can
break if they do not handle the fluid module prefix correctly.

On Mon, Apr 22, 2024 at 6:20 PM Douglas Hubler <dhubler@gmail.com> wrote:

>
> On Mon, Apr 22, 2024 at 6:00 PM Kent Watsen <kent+ietf@watsen.net> wrote:
> > Would anyone like to help me write an INFORMATIONAL document that
> evangelizes the use of RESTCONF for generic web applications?   Attached is
> what I have so far.
>
> As a huge fan of RESTCONF and also do a lot of swagger I would have some
> input  for section 5. RESTCONF, a Superior REST-ful API
>
> Adjustable data granularity
> Traditional REST APIs struggle with what level of information to return
> for each GET request and this is called granularity. Return too little data
> and scripts will need to make constant trips for more. Return too much data
> and the majority of it will likely be unused. Both situations cause delays
> and additional resource consumption.
>
> RESTCONF APIs do not have this issue. Clients can precisely control the
> data they want from depth, to list pagination. From selecting fields to
> excluding fields.
>
>
>
> On Mon, Apr 22, 2024 at 6:00 PM Kent Watsen <kent+ietf@watsen.net> wrote:
>
>> Would anyone like to help me write an INFORMATIONAL document that
>> evangelizes the use of RESTCONF for generic web applications?   Attached is
>> what I have so far.
>>
>> Cheers,
>> Kent
>>
>>
>> _______________________________________________
>> netconf mailing list
>> netconf@ietf.org
>> https://www.ietf.org/mailman/listinfo/netconf
>>
>