Missing ability to declare no request body

[Wulfheart]

Given return new Response('', 204); I would expect that there is some way to declare a response. Do you know a way to achieve this?

[romalytvynenko]

Hey @Wulfheart

What exactly you want to achieve?

[Wulfheart]

Thanks for your response. I somehow would like to have the ability to declare a response with an empty body but don’t know I could achieve this. With empty I mean that there is no body at all in the response.

[romalytvynenko]

I see!

Well, the doc that you see is what I've found about how to document empty body in Open API. So I believe it is an empty body 👻

[Wulfheart]

Ok. Is there any way I can tell scramble that it is an empty response?

[marventhieme]

I am also interested in this.

My setup:

A resource controller method for deleting a model:
DELETE api/v1/courses/{course} ................. courses.destroy › V1\CourseController@destroy

The implementation of the method looks like this:

    public function destroy(Course $course)
    {
        $course->delete();

        return response()->noContent();
    }

The generated doc looks like this:

"delete": {
                "operationId": "courses.destroy",
                "summary": "Delete a course",
                "tags": [
                    "Course"
                ],
                "parameters": [
                    {
                        "name": "course",
                        "in": "path",
                        "required": true,
                        "description": "The course ID",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object"
                            }
                        }
                    }
                },
                "responses": {
                    "204": {
                        "description": "No content",
                        "content": {
                            "application/json": {

                            }
                        }
                    },
                    "404": {
                        "$ref": "#/components/responses/ModelNotFoundException"
                    }
                }
            }

What I would like to generate is:

"delete": {
                "operationId": "courses.destroy",
                "summary": "Delete a course",
                "tags": [
                    "Course"
                ],
                "parameters": [
                    {
                        "name": "course",
                        "in": "path",
                        "required": true,
                        "description": "The course ID",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "No content",
                    },
                    "404": {
                        "$ref": "#/components/responses/ModelNotFoundException"
                    }
                }
            }

So omitting the requestBody object completely and removing the content object from the 204 response.
In the current state, testing the API with https://github.com/hotmeteor/spectator does not work as it expects me to add a body to the request and receive a body in the response.

[romalytvynenko]

@marventhieme that sounds legit! Will release a change in 0.10.0

[romalytvynenko]

Fixed in 0.10.*

[marventhieme]

Thank you very much! 😊