diff --git a/sections/designRules.md b/sections/designRules.md index 3cf9fe3d..662dc60e 100644 --- a/sections/designRules.md +++ b/sections/designRules.md @@ -687,7 +687,9 @@ An API is as good as the accompanying documentation. The documentation has to be
Statement
- OpenAPI definition document SHOULD include the info.contact object for publicly available APIs. Contact information SHOULD NOT be a generic contact address for the whole organisation. + OpenAPI definition document SHOULD include the info.contact object for publicly available APIs. + The info.contact object MUST include the fields name, url and email. + Contact information SHOULD NOT be a generic contact address for the whole organisation.
Rationale
@@ -703,7 +705,10 @@ An API is as good as the accompanying documentation. The documentation has to be
How to test
- Parse the OpenAPI Description to confirm the info.contact object is present. +