Project: KICS (Provisioning / Security & Compliance)
File: ae13a37d-943b-47a7-a970-83c8598bcca3.md

title: Path Template is Empty (v3) hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: ae13a37d-943b-47a7-a970-83c8598bcca3 Query name: Path Template is Empty (v3) Platform: OpenAPI Severity: <span style="color:#5bc0de">Info</span> Category: Structure and Semantics URL: All path templates should not be empty<br> ```yaml title="Positive test num. 1 - yaml file" hl_lines="32" 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 parameters: name: Authorization in: header description: ID of the API version required: true schema: type: integer /users/{}: get: parameters: in: path name: id required: true description: The user ID schema: type: integer minimum: 1 responses: "200": description: 200 response ``` ```json title="Positive test num. 2 - json file" hl_lines="53" { "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" } ] } ] } } } } } } } }, "parameters": [ { "name": "Authorization", "in": "header", "description": "ID of the API version", "required": true, "schema": { "type": "integer" } } ] }, "/users/{}": { "get": { "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The user ID", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "200 response" } } } } } } ``` ```yaml title="Positive test num. 3 - yaml file" hl_lines="10" 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: "/users/{}": get: operationId: listVersionsv2 summary: List API versions responses: "200": description: 200 response definitions: ErrorModel: type: object required: message code properties: message: type: string code: type: integer minimum: 100 maximum: 600 ``` <details><summary>Positive test num. 4 - json file</summary> ```json hl_lines="13" { "swagger": "2.0", "info": { "title": "Simple API Overview", "version": "1.0.0", "contact": { "name": "contact", "url": "https://www.google.com/", "email":

} }, "paths": { "/users/{}": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "description": "200 response" } } } } }, "definitions": { "ErrorModel": { "type": "object", "required": [ "message", "code" ], "properties": { "message": { "type": "string" }, "code": { "type": "integer", "minimum": 100, "maximum": 600 } } } } } ``` </details> ```yaml title="Negative test num. 1 - 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 parameters: name: Authorization in: header description: ID of the API version required: true schema: type: integer /users/{id}: get: parameters: in: path name: id required: true description: The user ID schema: type: integer minimum: 1 responses: "200": description: 200 response ``` ```json title="Negative test num. 2 - json 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" } ] } ] } } } } } } } }, "parameters": [ { "name": "Authorization", "in": "header", "description": "ID of the API version", "required": true, "schema": { "type": "integer" } } ] }, "/users/{id}": { "get": { "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The user ID", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "200 response" } } } } } } ``` ```yaml title="Negative test num. 3 - yaml 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: "/users/{id}": get: operationId: listVersionsv2 summary: List API versions responses: "200": description: 200 response definitions: ErrorModel: type: object required: message code properties: message: type: string code: type: integer minimum: 100 maximum: 600 ``` <details><summary>Negative test num. 4 - json file</summary> ```json { "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": { "/users/{id}": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "description": "200 response" } } } } }, "definitions": { "ErrorModel": { "type": "object", "required": [ "message", "code" ], "properties": { "message": { "type": "string" }, "code": { "type": "integer", "minimum": 100, "maximum": 600 } } } } } ``` </details>