OpenAPI: GET, DELETE operations cannot have a requestBody

[dustinbyrne]

OpenAPI does not support requestBody within GET, DELETE methods because it does not have explicitly defined semantics.

See the following GitHub issue: OAI/OpenAPI-Specification#1801

The following generated definition is invalid:

  /api_keys/{id}:
    delete:
      responses:
        '302':
          content: {}
          description: Found
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                commit:
                  type: string
                utf8:
                  type: string
      parameters:
        - name: id
          in: path
          schema:
            type: string
          required: true

[kgilpin]

Seems like this could be a scanner rule then - since sending a payload to a DELETE request is invalid.

…

On Wed, Feb 8, 2023 at 5:50 PM Dustin Byrne ***@***.***> wrote: OpenAPI does not support requestBody within DELETE methods because it does not have explicitly defined semantics <https://www.rfc-editor.org/rfc/rfc7231#section-4.3.5>. See the following GitHub issue: OAI/OpenAPI-Specification#1801 <OAI/OpenAPI-Specification#1801> The following generated definition is invalid: /api_keys/{id}: delete: responses: '302': content: {} description: Found requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: commit: type: string utf8: type: string parameters: - name: id in: path schema: type: string required: true — Reply to this email directly, view it on GitHub <#1010>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAVC64BPJZDD24YDUWYLFDWWQPLBANCNFSM6AAAAAAUV2Y56E> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[appland-release]

🎉 This issue has been resolved in version @appland/openapi-v1.4.2 🎉

The release is available on:

• @appland/openapi-v1.4.2
• GitHub release
• @appland/openapi-v1.4.2

Your semantic-release bot 📦🚀