Tag: examples

Best practice in APIs always includes the advice to include examples. In older versions of OpenAPI (3.1 and earlier), that was simple for JSON data but a little bit unclear for other formats whether to describe the data structure or to show the actual data that would be transferred. Help is at hand in OpenAPI 3.2 where the new fields dataValue and serializedValue mean you can do whichever makes most sense - or both!