Re: Escaping in URL templates

Hi Edgar,

Thanks for this pointer to the OpenAPI specs, that is something worth
taking inspiration from.

Also, the broader idea of aligning the reconciliation API to OpenAPI, or
more generally to make it more "RESTful", is definitely something that
has been proposed in the past and seems to gather some interest:

https://github.com/reconciliation-api/specs/issues/17

The main concern I have is whether we can do this in a backwards
compatible way, and if not, is the breaking change worth it?

Also it is not clear to me what you mean by "avoid reworking other
groups' specs" - I don't see why that would happen? Specifically, which
spec are you worried that the reconciliation CG would try to rework? Or
is it another group that could want to rework the reconciliation API?

Best,

Antonin

On 26/04/2021 00:32, Edgard Marx wrote:
> Hi Antonin,
>
> Glad you asked.
> I am quite new to the group, so please excuse me if I am talking nonsense.
> In case you already have discussed this issue before.
>
> It is in my opinion that one should avoid reworking other groups' specs.
> Particularly if it is not the aim of the working group.
> Having that in mind, it will be nice if the Reconcile API is built on
> top of the OpenAPI (https://github.com/OAI/OpenAPI-Specification
> <https://github.com/OAI/OpenAPI-Specification>) specs.
> Especially because it has broader acceptance and adoption (e.g.
> Daimler Mobile data API).
> In this particular case, the OpenAPI specifies the use of simple
> brackets e.g. {variable}
> (https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#path-templating
> <https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#path-templating>).
>
> kind regards,
> <emarx/>
> http://emarx.org <http://emarx.org>
>
>
> On Fri, Apr 16, 2021 at 5:58 PM Antonin Delpeuch <antonin@delpeuch.eu
> <mailto:antonin@delpeuch.eu>> wrote:
>
>     Hi all,
>
>     One area where we could make some progress is the URL templates
>     exposed
>     by the manifest:
>     https://github.com/reconciliation-api/specs/issues/39
>     <https://github.com/reconciliation-api/specs/issues/39>
>
>     Beyond the fact that the template variable is not consistent
>     across the
>     whole manifest, the escaping of the value it is replaced with
>     remains to
>     be specified. The problem is that both behaviours (escaping or
>     not) can
>     potentially be useful in some contexts.
>
>     Any thoughts about how to specify this better?
>
>     Best,
>     Antonin
>