Current process of importing new OpenAPI Documents

[char0n]

Latest process of getting new OpenAPI Documents into OAK is:

• rely on the repo tools validator that propose different suggestions of warning
• use spectral to identify additional issues
• use Overlays to fix the issues in idempotent way
• make sure there is a functioning Server Object URL and that this URL is the first server
• testing couple of requests agains the API or testing them all automatically if possible (only applicable for very small APIs)

Idempotent meaning - in Python there is an oas-patch library. It applies to Overlay over the OpenAPI Document. The goal of idempotency is that you have to construct the Overlay in a way that if you apply it multiple times on the same OpenAPI Document again and again, you'll always end up with the same result.