Feature Overview  

The tool currently used to generate the OCP API docs was created as a side project to help with the documentation of the OCP APIs for the docs team. The tool uses openapiv2 endpoints which are lined up for removal.

On the other hand we have requests (https://issues.redhat.com/browse/RFE-3682) from customers which like to have a tool supported by Red Hat they can use for schema validations of OpenShift objects.
 

Goals

Create a tool which can be used for our API doc generation and used by customers/partners for schema validation of OpenShift objects.
 

Requirements (aka. Acceptance Criteria):

• should work as a stand alone tool capable of being used in doc generation pipelines and test pipelines or processes used by our customers/partners.