How to do 'contract first'

[kuehne-trustable-de]

To leave the XML & JSON worlds I wonder how to apply a 'contract first' approach. What's the best way to describe an interface?

[cyberphone]

This is one solution:
https://www.rfc-editor.org/rfc/rfc8610.html

I'm aware of the problem, so I opened this issue:
OAI/OpenAPI-Specification#3108

[cyberphone]

Since numeric labels are preferable due to element positioning and size, I ended up with the following method:

Name	Label	Type	Description
someParameter	1	tstr	Keeps some very useful text
anotherOne	2	bstr	Probably quite useful as well

Sample:

{
  1: "Rock and Roll will never die",
  2: h'aabb78'
}

Using the Name as labels, the elements would (due to deterministic coding rules), be swapped which may not be what you wanted.

[cyberphone]

For a fairly complex encryption container I added this to the tables: