Skip to main content

head-operation-cannot-have-request-body

Overview​

This rule belongs to the openapi-v3-standards-linting ruleset and states that:

HTTP methods like GET, DELETE, HEAD are not allowed to have a request body since a payload for these methods do not have any defined semantics. If request body is defined for non-body HTTP verbs, it will get ignored. Therefore, in OpenAPI as well, the HEAD Operation Object must not set the requestBody property.

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageOperation Object for HEAD HTTP method cannot have a request body.
CodeOPENAPI3STANDARDS_L045
TypeLinting
Rule SystemSemantic
Broad CategoryOperations
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic linting head request body body parameter operation

Suggested Fixes​

  • Remove the requestBody property from the HEAD Operation Object.
  • Change the HTTP method to POST or any other method that supports request body.

For More Information​