Disabling OpenAPI Documentation in IDE Services K8s Helm Chart

Question

Is it possible to disable the OpenAPI documentation in the Kubernetes (K8s) Helm chart configuration for IDE Services, and if so, how?

Answer

Yes, it is possible to disable the OpenAPI documentation in the Kubernetes Helm chart configuration by modifying the values.yaml file. You can utilize the configCustomization option under ides.config to disable the OpenAPI documentation in your instance. Below is an example configuration:

ides:
  config:
    configCustomization:
      springdoc:
        api-docs:
          enabled: false
        swagger-ui:
          enabled: false

Here's a breakdown of the parameters:

• springdoc.api-docs.enabled: Disables or enables the OpenAPI (REST API) documentation.
• springdoc.swagger-ui.enabled: Disables or enables the Swagger UI graphical interface for API documentation.

Ensure you add these configurations to your values.yaml file before deploying the Helm chart.

For more information, refer to the documentation at:

• Values File Documentation
• REST API Documentation