Chapter 3. Interacting with the OpenShift Lightspeed REST API

Use the OpenAPI 3.1 specifications for OpenShift Lightspeed to access interactive REST API documentation and download machine-readable files for environment integration.

The OpenShift Lightspeed REST API utilizes OpenAPI 3.1 specifications. The system automatically generates the specification from the route definitions, and you do not need to manually configure separate specification files.

You can access the following API endpoints when the service is running locally on port 8080:

Restrict network-level access in production environments to prevent the interactive /docs and /redoc endpoints from being publicly accessible.

The interactive Swagger UI provides a platform to explore and test OpenShift Lightspeed REST API endpoints. You can use this interface to verify request parameters and response schemas directly from your browser to ensure seamless API integration.

You can explore and test the OpenShift Lightspeed REST API endpoints by using the interactive Swagger UI.

Regenerating the OpenAPI schema updates the docs/openapi.json file to reflect recent development changes. Keeping the schema current prevents documentation drift and ensures that integration tests accurately validate the API.

The canonical, version-controlled representation of the API surface is located in the docs/openapi.json file. If you make any route, model, or version changes during development, you must regenerate the OpenAPI schema to prevent schema drift and integration test failures.