New guideline: usage of gateways

[ePaul]

We want to have a general guideline about usage of API gateways. The main question is whether we generally want to describe the API "before" or "behind" the gateway?

• Gateway usage should be "transparent" (in either of the two meanings):
  • either have the gateway invisible, i.e. only document what's outside of the gateway
  • or have it clearly documented, i.e. for each header/... make it clear whether it's applicable inside/outside of the gateway.

[ePaul]

• SHOULD document external (client-side) view
• MAY also document view "behind the gateway", if it's intended to be called that way
  • if so, make it clear which headers normally come from the gateway (and should not be provided when using the gateway)

[ePaul]

From the meeting:

• This should go into the "General Guidelines" section, possibly after rule 101.

[tkrop]

Happy birthday 🎉

[ePaul]

We got several cases during the last few years where this rule would have been useful. We just should add it.