Linting Rules - OpenAPI V3 - Response POST 201 Status Code

Number of APIs: 1

This is a Spectral governance rule to make sure that POST methods all have a 201 status code response in an OpenAPI. Here is a JSON version of the rule that can be applied using this API-driven collection API, or at CLI or CI/CD pipeline.

{
  "openapi-v3-response-post-201-status-code": {
    "description": "Ensures POST operations have a 201 status code response.",
    "message": "A POST operation should have a 201 status code for the response.",
    "severity": "warn",
    "formats": [
      "oas3"
    ],
    "given": "$.paths[*].post.responses",
    "then": {
      "field": "201",
      "function": "truthy"
    }
  }
}

This request can be run as part of this collection, or dragged and dropped to another collection of governance requests organized by folder, demonstrating how API governance linting works, but also providing a rule that can be used as part of your wider API governance strategy.

1. OpenAPI V3 - Response POST 201 Status Code POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-response-post-201-status-code/