The top-level ‘External Documentation’ object URL for the tag must be a proper URL

Description

The URL defined the url field of the External Documentation object for a tag is not a proper URL.

You can use the externalDocs field to reference an external resource that offers extended documentation. This is field is optional. However, if you do reference external documentation for your, OpenAPI Specification (OAS) requires that all URLs in the API contract must be proper URLs in a valid format.

Example

The following is an example of how this issue could look in your API definition. Here, the url field has just a placeholder string:

"tag" : {
	"name": "pet",
	"description": "Pets operations",
        "externalDocs" : {
             "description": "Find more info here",
             "url": "need to add later"
        },

Remediation

Make sure that all URLs in your API are proper URLs and have a valid format.

"tag" : {
	"name": "pet",
	"description": "Pets operations",
        "externalDocs" : {
             "description": "Find more info here",
             "url": "http://swagger.io/docs/petsoperations"
        },

Get API Security news directly in your Inbox.

By clicking Subscribe you agree to our Data Policy