Project: KICS (Provisioning / Security & Compliance)
File: 561710b1-b845-4562-95ce-2397a05ccef4.md

title: Template Path With No Corresponding Path Parameter (v3) hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: 561710b1-b845-4562-95ce-2397a05ccef4 Query name: Template Path With No Corresponding Path Parameter (v3) Platform: OpenAPI Severity: <span style="color:#5bc0de">Info</span> Category: Structure and Semantics URL: The template path must have a corresponding path parameter for a given operation<br> ```yaml title="Positive test num. 1 - yaml file" hl_lines="10" openapi: 3.0.0 info: title: Simple API overview version: 1.0.0 paths: /users/{test-id}: get: parameters: in: header name: test-id required: true description: The user ID schema: type: integer minimum: 1 responses: "200": description: 200 response "/": 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 ``` ```json title="Positive test num. 2 - json file" hl_lines="58" { "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/{blabla}": { "get": { "parameters": [ { "in": "header", "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="40 34" 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 /people/{id}: get: parameters: {} responses: "200": description: 200 response /users/{id}: get: parameters: {} responses: "200": description: 200 response ``` <details><summary>Positive test num. 4 - json file</summary> ```json hl_lines="65 55" { "openapi": "3.0.0", "info": { "title": "Simple API overview", "version":

}, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "description": "200 response", "content": { "application/json": { "examples": { "foo": { "value": { "versions": [ { "links": [ { "href": "http://127.0.0.1:8774/v2/", "rel": "self" } ], "status": "CURRENT", "updated": "2011-01-21T11:33:21Z", "id": "v2.0" } ] } } } } } } } }, "parameters": [ { "required": true, "schema": { "type": "integer" }, "name": "Authorization", "in": "header", "description": "ID of the API version" } ] }, "/people/{id}": { "get": { "parameters": {}, "responses": { "200": { "description": "200 response" } } } }, "/users/{id}": { "get": { "parameters": {}, "responses": { "200": { "description": "200 response" } } } } } } ``` </details> <details><summary>Positive test num. 5 - yaml file</summary> ```yaml hl_lines="14" 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/{test-id}: get: parameters: in: header name: test-id required: true description: The user ID type: string responses: "200": description: 200 response "/": get: operationId: listVersionsv2 summary: List API versions responses: "200": description: 200 response parameters: name: Authorization in: header description: ID of the API version required: true type: string ``` </details> <details><summary>Positive test num. 6 - json file</summary> ```json hl_lines="38" { "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" } } }, "parameters": [ { "name": "Authorization", "in": "header", "description": "ID of the API version", "required": true, "type": "string" } ] }, "/users/{blabla}": { "get": { "parameters": [ { "in": "header", "name": "id", "required": true, "description": "The user ID", "type": "string" } ], "responses": { "200": { "description": "200 response" } } } } } } ``` </details> <details><summary>Positive test num. 7 - yaml file</summary> ```yaml hl_lines="25 31" 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 parameters: name: Authorization in: header description: ID of the API version required: true type: string /people/{id}: get: parameters: {} responses: "200": description: 200 response /users/{id}: get: parameters: {} responses: "200": description: 200 response ``` </details> <details><summary>Positive test num. 8 - json file</summary> ```json hl_lines="35 45" { "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" } } }, "parameters": [ { "required": true, "name": "Authorization", "in": "header", "description": "ID of the API version", "type": "string" } ] }, "/people/{id}": { "get": { "parameters": {}, "responses": { "200": { "description": "200 response" } } } }, "/users/{id}": { "get": { "parameters": {}, "responses": { "200": { "description": "200 response" } } } } } } ``` </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: "/": get: operationId: listVersionsv2 summary: List API versions responses: "200": description: 200 response parameters: name: Authorization in: header description: ID of the API version required: true type: string /users/{id}: get: parameters: in: path name: id required: true description: The user ID type: string responses: "200": description: 200 response ``` <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": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "description": "200 response" } } }, "parameters": [ { "name": "Authorization", "in": "header", "description": "ID of the API version", "required": true, "type": "string" } ] }, "/users/{id}": { "get": { "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The user ID", "type": "string" } ], "responses": { "200": { "description": "200 response" } } } } } } ``` </details>