apiDocsService parameter

Use apiDocsService to access the API documentation.

If apiDocsService is not defined in the SIPEnvironment, then the API documentation container is not deployed. It is recommended that for production environments, you need not deploy the API documentation container. For dev and QA environments, you can deploy API documentation container.

The following YAML snippet is a sample schema of apiDocsService:
apiDocsService: {} 
  replicaCount: 1
  resources:
    limits:
      cpu: '1'
      memory: 1.5Gi
    requests:
      cpu: '0.1'
      memory: 1Gi
    # affinityAndTolerations:""
The following table explains the general parameters of apiDocsService:
Property Default value Value type Required Description
affinityAndTolerations string No Use the name of the affinityAndTolerations that is defined in the SIPEnvironment.
replicaCount 1 integer No Specify the number of server instances to be deployed.
resources Limits:
CPU= '1'
Memory= 1.5Gi
Requests:
CPU= '0.1'
Memory= 1Gi
object No Specify the CPU and memory resource requests and limits for the apiDocsService.