Description
The URL defined the url
field of the top-level External Documentation
object is not a proper URL.
You can use the externalDocs
field to reference an external resource that offers extended documentation for your API. This is field is optional. However, if you do reference external documentation for your API, 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:
{
"swagger": "2.0",
"info": {
"title": "Swagger Petstore"
},
"host": "petstore.swagger.io",
"basePath": "/v1",
"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.
{
"swagger": "2.0",
"info": {
"title": "Swagger Petstore"
},
"host": "petstore.swagger.io",
"basePath": "/v1",
"externalDocs" : {
"description": "Find more info here",
"url": "http://swagger.io/docs/"
},