OpenAPI/Swagger allows you to include external documentation in your API description for various components. API Transformer now supports conversion of this information for both import/export of OpenAPI/Swagger files.
OpenAPI/Swagger allows you to link external documentation at four different levels in your API description:
- Root Object [v2.0, v3.0]
- Operation Object [v2.0, v3.0]
- Tag Object [v2.0, v3.0]
- Schema Object [v2.0, v3.0]
For each of the above levels, you can define an External Documentation Object against the
externalDocs property. It can look like the following:
"description": "More details can be found at:",
For External Documentation Object to be considered valid and transformed successfully,
url must be present as it is a required property.