Order of Headers/Paths/Queries

swissfintechinnovations / ca-payment

Common APIs for AIS and PIS

https://www.common-api.ch

Apache License 2.0

0 stars 3 forks source link

Order of Headers/Paths/Queries #19

Closed simonmeyerm closed 1 week ago

simonmeyerm commented 1 year ago

Would it makes sense to order the Headers, Paths and Queries in a defined order for all APIs?

bLink suggestion would be to arrange it alphabetically with:

Headers required
Headers optional
Paths required
Paths optional
Queries required
Queries optional

For bLink the order would look like this:

bLink Headers required
bLink Headers optional
General Headers required
General Headers optional
Paths required
Paths optional
Queries required
Queries optional

juergen-petry commented 11 months ago

Feedback on behalf of UBS: We have a neutral view: not against, nor in favor of it, but would support this proposal since it’s a purely cosmetic change. This is a matter of preference and other ordering criteria are equally valid.

svenbiellmann commented 1 month ago

All SFTI API specifications will follow the proposed naming conventions. For more details please see here: https://github.com/swissfintechinnovations/.github/wiki/Naming-Conventions. Therefore this issue will be closed.

svenbiellmann commented 1 week ago

Close of issue without implementation has been approved by the working group.