refactor(api): improve doc (#26)

leroyguillaume · Jul 27, 2024 · f45fbe0 · f45fbe0
1 parent 801a6f3
commit f45fbe0
Show file tree

Hide file tree

Showing 8 changed files with 219 additions and 47 deletions.
diff --git a/.config/orbstack.yaml b/.config/orbstack.yaml
@@ -12,11 +12,7 @@ smtp:
  key: password
 
 swaggerUi:
- enabled: true
-
- extraEnv:
- - name: SWAGGER_JSON_URL
- value: https://simpaas.k8s.orb.local/api/_doc
+ apiUrl: https://simpaas.k8s.orb.local/api/_doc
 
 grafana:
  grafana.ini:
@@ -33,6 +29,3 @@ simpaas:
 
  ingress:
  domain: *domain
- additionalRules:
- swagger-ui:
- enabled: true
diff --git a/Cargo.toml b/Cargo.toml
@@ -35,6 +35,7 @@ uuid = {version = "1", features = ["serde", "v4"]}
 validator = {version = "0", features = ["derive"]}
 
 [package]
+description = "Platform as a Service (PaaS) based on Kubernetes and Helm."
 edition = "2021"
 name = "simpaas"
 version = "0.1.0"
diff --git a/charts/simpaas-stack/README.md b/charts/simpaas-stack/README.md
@@ -12,6 +12,9 @@ helm install simpaas simpaas/simpaas-stack
 ## Minimal configuration
 
 ```yaml
+swaggerUi:
+ apiUrl: https://simpaas.k8s.orb.local/api/_doc
+
 grafana:
  grafana.ini:
  server:
@@ -21,7 +24,3 @@ simpaas:
  ingress:
  domain: *domain
 ```
-
-## SwaggerUI
-
-If you enable feature `swaggerUi`, you need to set environment variable `SWAGGER_JSON_URL` to OpenAPI endpoint (`/_doc`).
diff --git a/charts/simpaas-stack/templates/swagger-ui/deployment.yaml b/charts/simpaas-stack/templates/swagger-ui/deployment.yaml
@@ -57,8 +57,12 @@ spec:
  readinessProbe:
  {{ toYaml . | nindent 10 }}
  {{- end }}
- {{- with $env }}
  env:
+ - name: BASE_URL
+ value: {{ .Values.swaggerUi.baseUrl }}
+ - name: SWAGGER_JSON_URL
+ value: {{ .Values.swaggerUi.apiUrl }}
+ {{- with $env }}
  {{- toYaml . | nindent 8 }}
  {{- end }}
  resources:

diff --git a/charts/simpaas-stack/values.yaml b/charts/simpaas-stack/values.yaml
@@ -53,7 +53,7 @@ smtp:
  readinessProbe: {}
 
 swaggerUi:
- enabled: &swaggerUiEnabled false
+ enabled: &swaggerUiEnabled true
 
  replicas: 1
 
@@ -68,9 +68,7 @@ swaggerUi:
  podSecurityContext: {}
  securityContext: {}
 
- env:
- - name: BASE_URL
- value: &swaggerUiPath /swagger-ui
+ env: []
  extraEnv: []
 
  resoures: {}
@@ -89,6 +87,9 @@ swaggerUi:
  livenessProbe: {}
  readinessProbe: {}
 
+ baseUrl: &swaggerUiPath /swagger-ui
+ apiUrl: ""
+
 grafana:
  enabled: &grafanaEnabled true
 

diff --git a/get-simpaas b/get-simpaas
@@ -128,6 +128,7 @@ spec:
 EOF
 
 install_chart $ns_simpaas simpaas $repo_simpaas/simpaas-stack \
+ --set "swaggerUi.apiUrl=https://$SIMPAAS_DOMAIN/api/_doc" \
  --set-json "grafana={\"grafana.ini\":{\"server\":{\"domain\":\"$SIMPAAS_DOMAIN\"}}}" \
  --set "simpaas.common.image.tag=$SIMPAAS_VERSION" \
  --set-json "simpaas.ingress.annotations={\"cert-manager.io/cluster-issuer\":\"$issuer\"}" \