Project: KICS (Provisioning / Security & Compliance)
File: 5aea1d7e-b834-4749-b143-2c7ec3bd5922.md

title: Invalid Tag External Documentation URL (v3) hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: 5aea1d7e-b834-4749-b143-2c7ec3bd5922 Query name: Invalid Tag External Documentation URL (v3) Platform: OpenAPI Severity: <span style="color:#5bc0de">Info</span> Category: Best Practices URL: Tag External Documentation URL should be a valid URL<br> ```json title="Positive test num. 1 - json file" hl_lines="57 53" { "openapi": "3.0.0", "info": { "title": "Simple API Overview", "version": "1.0.0", "contact": { "name": "contact", "url": "https://www.google.com/", "email": "user@gmail.com" } }, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "description": "200 response", "content": { "application/json": { "examples": { "foo": { "value": { "versions": [ { "status": "CURRENT", "updated": "2011-01-21T11:33:21Z", "id": "v2.0", "links": [ { "href": "http://127.0.0.1:8774/v2/", "rel": "self" } ] } ] } } } } } } } } } }, "tags": [ { "externalDocs": { "url": "/" }, "name": "pets", "description": "Everything about your Pets" }, { "name": "store", "description": "Access to Petstore orders", "externalDocs": { "url": "/" } } ] } ``` ```yaml title="Positive test num. 2 - yaml file" hl_lines="26 30" openapi: 3.0.0 info: title: Simple API Overview version: 1.0.0 paths: "/": get: operationId: listVersionsv2 summary: List API versions responses: "200": description: 200 response content: application/json: examples: foo: value: versions: status: CURRENT updated: "2011-01-21T11:33:21Z" id: v2.0 links: href: http://127.0.0.1:8774/v2/ rel: self tags: name: pets description: Everything about your Pets externalDocs: url: / name: store description: Access to Petstore orders externalDocs: url: / ``` ```json title="Positive test num. 3 - json file" hl_lines="34 30" { "swagger": "2.0", "info": { "title": "Simple API Overview", "version": "1.0.0", "contact": { "name": "contact", "url": "https://www.google.com/", "email": "user@gmail.com" } }, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "description": "200 response" } } } } }, "tags": [ { "externalDocs": { "url": "/" }, "name": "pets", "description": "Everything about your Pets" }, { "name": "store", "description": "Access to Petstore orders", "externalDocs": { "url": "/" } } ] } ``` <details><summary>Positive test num. 4 - yaml file</summary> ```yaml hl_lines="18 22" swagger: "2.0" info: title: Simple API Overview version: 1.0.0 contact: name: contact url: https://www.google.com/ email:

paths: "/": get: operationId: listVersionsv2 summary: List API versions responses: "200": description: 200 response tags: name: pets description: Everything about your Pets externalDocs: url: / name: store description: Access to Petstore orders externalDocs: url: / ``` </details> ```json title="Negative test num. 1 - json file" { "openapi": "3.0.0", "info": { "title": "Simple API Overview", "version": "1.0.0", "contact": { "name": "contact", "url": "https://www.google.com/", "email": "user@gmail.com" } }, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "description": "200 response", "content": { "application/json": { "examples": { "foo": { "value": { "versions": [ { "status": "CURRENT", "updated": "2011-01-21T11:33:21Z", "id": "v2.0", "links": [ { "href": "http://127.0.0.1:8774/v2/", "rel": "self" } ] } ] } } } } } } } } } }, "tags": [ { "externalDocs": { "url": "http://docs.my-api.com/pet-operations.htm" }, "name": "pets", "description": "Everything about your Pets" }, { "name": "store", "description": "Access to Petstore orders", "externalDocs": { "url": "http://docs.my-api.com/store-orders.htm" } } ] } ``` ```yaml title="Negative test num. 2 - yaml file" openapi: 3.0.0 info: title: Simple API Overview version: 1.0.0 paths: "/": get: operationId: listVersionsv2 summary: List API versions responses: "200": description: 200 response content: application/json: examples: foo: value: versions: status: CURRENT updated: "2011-01-21T11:33:21Z" id: v2.0 links: href: http://127.0.0.1:8774/v2/ rel: self tags: name: pets description: Everything about your Pets externalDocs: url: http://docs.my-api.com/pet-operations.htm name: store description: Access to Petstore orders externalDocs: url: http://docs.my-api.com/store-orders.htm ``` ```json title="Negative test num. 3 - json file" { "swagger": "2.0", "info": { "title": "Simple API Overview", "version": "1.0.0", "contact": { "name": "contact", "url": "https://www.google.com/", "email": "user@gmail.com" } }, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "description": "200 response" } } } } }, "tags": [ { "externalDocs": { "url": "http://docs.my-api.com/pet-operations.htm" }, "name": "pets", "description": "Everything about your Pets" }, { "name": "store", "description": "Access to Petstore orders", "externalDocs": { "url": "http://docs.my-api.com/store-orders.htm" } } ] } ``` <details><summary>Negative test num. 4 - yaml file</summary> ```yaml swagger: "2.0" info: title: Simple API Overview version: 1.0.0 contact: name: contact url: https://www.google.com/ email: user@gmail.com paths: "/": get: operationId: listVersionsv2 summary: List API versions responses: "200": description: 200 response tags: name: pets description: Everything about your Pets externalDocs: url: http://docs.my-api.com/pet-operations.htm name: store description: Access to Petstore orders externalDocs: url: http://docs.my-api.com/store-orders.htm ``` </details>