search

reconciliation-api / specs

Specifications of the reconciliation API
https://reconciliation-api.github.io/specs/draft/
30 stars 9 forks source link

Switch to RFC6570 for URI templates #85

Closed wetneb closed 2 years ago

wetneb commented 2 years ago

Closes #39.

This switches to the RFC6570 syntax for URI templates, as suggested in #39 by @Robsteranium. This has the benefit of not forcing URL encoding of the identifiers when inserting them in the template, and allowing for a much wider range of use cases. This is a significant change since the syntax used so far ({{id}} in most places, ${id} for the flyout template) are not compatible with RFC6570. However I think it is really important to support the use case of services using a full URI as identifier (since that is already happening in the wild), or parts of URI which should be inserted without escaping.

fsteeg commented 2 years ago

Makes sense and looks good to me, +1.

wetneb commented 2 years ago

Since this is not backwards compatible, in our last call we suggested to wait for a 0.2 release before merging this.

wetneb commented 2 years ago

Merging now that 0.2 is released.