This module was deprecated since OpenAPI provided swagger and redoc, which provided good uis for viewing docs. Recently this functionality was split from OpenAPI into a new module suite, OpenAPI UI. The new module, provides an easy way to add additional UIs for viewing schema and api docs. While this module was deprecated, I think it still actually has value to provide users with just the schema available in openapi.

I would like to open a discussion as to if there is a large enough use case for reviving this module around OpenAPI UI. Ultimately most of the functionality would remain the same. The the OpenAPI module already provides a good interface for openapi the ui library for a given api (Rest and Jsonapi at the moment). The only main difference between this library and the other implemented uis (redoc and swagger) is that this one only deals with schema, which means there is a need for some customization around splitting that data out from the openapi docs.

This would ultimately provide a 2.0 release of the module, which would depend on openapi_ui. Optionally, a sub module could be included to provide direct integration with Schemata, as the project does now, if there is a need. I am also willing to take over maintenance/ownership of this project in order to be the maintainer.

Thoughts?

Comments

richgerdes created an issue. See original summary.

e0ipso’s picture

e0ipso
Primary language Catalan
Location Can Picafort
commented

What is the value of having Docson as the UI? Docson can only visualize raw JSON Schemas, not the full Open API spec. Swagger UI allows for swapping in docson to display the schemas. Possibly that can be a better integration point.

If you think there is value in this, I'm totally open to it. Please provide a patch and I will make you co-maintainer of the module :-)

richgerdes’s picture

richgerdes
he/him
Primary language English
Location New Jersey, USA
commented

I have yet to make my final decision on if this is valuable. Ultimately, I think that there may be use cases which being able to view the raw schema, is valuable at which point there may still be a desire for this project. I think it would make sense to provide this as a sub module, not sure the exact details of implementation yet though.

I think that it wouldn't be complicated to provide the schema to docson via the integration with OpenAPI UI. It may require some custom logic to break out just the relevant schema, but I think it would be a reasonable change. I think there is definitely a use case for just viewing the schema for an api (say jsonapi) without needing it to be cluttered with route and tag details.

On the other hand, I don't have statistics on how this modules being used in production which makes it hard to decide if the new version will be used or not.