Add option to permit validation when schema and data are empty

chibicco commented 7 months ago

Background

In our project, there are scenarios where the API returns an empty response body with status code 200. However, the current OpenAPI 2 schema validation does not allow an empty schema for the response body, causing validation errors in these cases.

Specifically, in cases such as the schema and controller example below, I expect the Committee::Middleware::ResponseValidation check to pass successfully.

"/pets/cat": {
  "get": {
    "description": "Returns pets which are cats",
    "operationId": "find pets which are cats",
    "responses": {
      "200": {
        "description": "empty schema"
      }
    }
  }
}

class CatController
    # pets/cat
    get "/" do
        status 200
        present nil
    end
end

Changes

To address this issue, I have added an option to allow an empty schema for the response body in OpenAPI 2. This change enables the validation to pass when both the schema and response body are nil, accommodating the specific use case in our project.

If allow_blank_structures is set to true, the validation will pass if the schema is empty and the data is nil.
I have also modified the error message for the case where data is present and the schema does not exist.

chibicco commented 7 months ago

@brandur @ota42y

If you have a moment, I would appreciate it if you could review it. I apologize for my poor English skills, so please bear with me.

brandur commented 6 months ago

@chibicco Sorry for the delay. Do you still need this?

chibicco commented 6 months ago

@brandur Thank you for response :)

Yes, I need this pull requests. I have rebased on the latest master, If possible, please review.

chibicco commented 6 months ago

Greetings.

I have just noticed the following correction. https://github.com/interagent/committee/pull/420

If my PR is not appropriate, I would appreciate it if you could close it.

brandur commented 6 months ago

@chibicco Let's hold on that a bit longer. We have someone offering to help with maintenance so we may yet be able to rescue the project.

ydah commented 6 months ago

memo) I noticed in writing the following comment that 204 responses and so on expect to describe a response without a body. In other words, I think the next major update will change this parameters default value.

https://github.com/interagent/committee/pull/417#discussion_r1596566077