Project: KICS (Provisioning / Security & Compliance)
File: f368dd2d-9344-4146-a05b-7c6faa1269ad.md

title: Success Response Code Undefined for Post Operation (v3) hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: f368dd2d-9344-4146-a05b-7c6faa1269ad Query name: Success Response Code Undefined for Post Operation (v3) Platform: OpenAPI Severity: <span style="color:#edd57e">Low</span> Category: Networking and Firewall URL: Post should define at least one success response (200, 201, 202 or 204)<br> ```json title="Positive test num. 1 - json file" hl_lines="12" { "openapi": "3.0.0", "info": { "title": "Simple API", "version": "1.0.0" }, "paths": { "/item": { "post": { "operationId": "createItem", "summary": "Create item", "responses": { "default": { "description": "Error" } } } } } } ``` ```json title="Positive test num. 2 - json file" hl_lines="24" { "openapi": "3.0.0", "info": { "title": "Simple API", "version": "1.0.0" }, "paths": { "/item": { "delete": { "operationId": "deleteItem", "summary": "Delete item", "responses": { "204": { "description": "Item deleted successfully" }, "default": { "description": "Error" } } }, "post": { "operationId": "createItem", "summary": "Create item", "responses": { "default": { "description": "Error" } } } } } } ``` ```yaml title="Positive test num. 3 - yaml file" hl_lines="10" openapi: 3.0.0 info: title: Simple API version: 1.0.0 paths: "/item": post: operationId: createItem summary: Create item responses: default: description: Error ``` <details><summary>Positive test num. 4 - yaml file</summary> ```yaml hl_lines="18" openapi: 3.0.0 info: title: Simple API version: 1.0.0 paths: "/item": delete: operationId: deleteItem summary: Delete item responses: "204": description: Item deleted successfully default: description: Error post: operationId: createItem summary: Create item responses: default: description: Error ``` </details> <details><summary>Positive test num. 5 - json file</summary> ```json hl_lines="24" { "swagger": "2.0", "info": { "title": "Simple API", "version": "1.0.0" }, "paths": { "/item": { "delete": { "operationId": "deleteItem", "summary": "Delete item", "responses": { "204": { "description": "Item deleted successfully" }, "default": { "description": "Error" } } }, "post": { "operationId": "createItem", "summary": "Create item", "responses": { "default": { "description": "Error" } } } } } } ``` </details> <details><summary>Positive test num. 6 - yaml file</summary> ```yaml hl_lines="18" swagger: "2.0" info: title: Simple API version:

paths: "/item": delete: operationId: deleteItem summary: Delete item responses: "204": description: Item deleted successfully default: description: Error post: operationId: createItem summary: Create item responses: default: description: Error ``` </details> ```json title="Negative test num. 1 - json file" { "openapi": "3.0.0", "info": { "title": "Simple API", "version": "1.0.0" }, "paths": { "/item": { "delete": { "operationId": "deleteItem", "summary": "Delete item", "responses": { "default": { "description": "Error" } } }, "post": { "operationId": "updateItem", "summary": "Create item", "responses": { "200": { "description": "OK" }, "default": { "description": "Error" } } } } } } ``` ```yaml title="Negative test num. 2 - yaml file" openapi: 3.0.0 info: title: Simple API version: 1.0.0 paths: "/item": delete: operationId: deleteItem summary: Delete item responses: default: description: Error post: operationId: updateItem summary: Create item responses: "200": description: OK default: description: Error ``` ```json title="Negative test num. 3 - json file" { "swagger": "2.0", "info": { "title": "Simple API", "version": "1.0.0" }, "paths": { "/item": { "delete": { "operationId": "deleteItem", "summary": "Delete item", "responses": { "default": { "description": "Error" } } }, "post": { "operationId": "updateItem", "summary": "Create item", "responses": { "200": { "description": "OK" }, "default": { "description": "Error" } } } } } } ``` <details><summary>Negative test num. 4 - yaml file</summary> ```yaml swagger: "2.0" info: title: Simple API version: 1.0.0 paths: "/item": delete: operationId: deleteItem summary: Delete item responses: default: description: Error post: operationId: updateItem summary: Create item responses: "200": description: OK default: description: Error ``` </details> <details><summary>Negative test num. 5 - json file</summary> ```json { "swagger": "2.0", "info": { "title": "Simple API", "version": "1.0.0" }, "paths": { "/item": { "post": { "operationId": "postItem", "summary": "post item", "responses": { "2XX": { "description": "Item posted successfully" }, "default": { "description": "Error" } } }, "patch": { "operationId": "updateItem", "summary": "Update item", "responses": { "default": { "description": "Error" } } } } } } ``` </details> <details><summary>Negative test num. 6 - yaml file</summary> ```yaml swagger: "2.0" info: title: Simple API version: 1.0.0 paths: "/item": post: operationId: postItem summary: post item responses: "2XX": description: Item post successfully default: description: Error patch: operationId: updateItem summary: Update item responses: default: description: Error ``` </details>