Schema generation fails inside JsonContent

[stevesutton-hds]

(Edit: This is now a feature request, not a failure - see comment chain)

Schema generation fails, when inside a JsonContent element.

Steps to reproduce:

With composer.json containing "zircote/swagger-php": "^4.10", (4.10.6 in composer.lock)

With code

class myclass {
/**
 * @OA\Info(
 *   title="API",
 *   version="1.1",
 *   description="API documentation",
 * )
 *
 */

    /**
     * @OA\Post(
     *   path="/path",
     *   @OA\Response(
     *     response="200",
     *     description="response",
     *     @OA\JsonContent(
     *         @OA\Schema(
     *           title="title",
     *           @OA\Property(
     *             property = "success",
     *             type = "boolean",
     *             example = true
     *           ),
     *         ),
     *     )
     *   )
     * )
     *

     */
    protected function post(array $extraParams, array $queries) {
      return;
    }
}

Calling:

$oa = \OpenApi\Generator::scan(["src/"]);

echo $oa->toJson();

Results in output:

{
    "openapi": "3.0.0",
    "paths": {
        "/path": {
            "post": {
                "operationId": "dd9f210a8294662e079e1c11b03617d8",
                "responses": {
                    "200": {
                        "description": "response",
                        "content": {
                            "application/json": {
                                "schema": {}
                            }
                        }
                    }
                }
            }
        }
    }
}

Notice that schema value is empty "{}"

Expected ouput::

{
    "openapi": "3.0.0",
    "paths": {
        "/path": {
            "post": {
                "operationId": "dd9f210a8294662e079e1c11b03617d8",
                "responses": {
                    "200": {
                        "description": "response",
                        "content": {
                            "application/json": {
                                "schema": {
                                            "title": "title",
                                            "properties": {
                                                "success": {
                                                    "type": "boolean",
                                                    "example": true
                                                }
                                            },
                                            "type": "object"
                                        }
                            }
                        }
                    }
                }
            }
        }
    }}

Note that if inside the OA\JsonContent I enclose the schema inside a oneOf = {} and add a second dummy schema, I then see the correct schema output in the json.

Also note that the behaviour is the same if the schema is included as a reference, rather than inline.

[DerManoMann]

Almost got it. JsonContent is a shorthand version of a Schema nested inside a MediaType. It extends Schema, so there is no need to nest another Schema.

Removing the inner Schema should be all you need to change.

[stevesutton-hds]

Aha, thanks! That's really not obvious :D

I guess it would still be very useful if the generator could detect and warn about this instead of just generating an empty schema without explanation - I wasted a few hours today and never did solve it myself - so I'll leave this open as a feature request, but yes, removing the inner Schema did result in the expected output.

edit: even generating:

"schema" : {
  "schema": {}
}

Might have help me get to that conclusion myself.