docs(serviceintegrationendpoint): add docs page and example (#722)

aiven · May 2, 2024 · ee726f0 · ee726f0
1 parent 662ecf1
commit ee726f0
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 0 deletions.
diff --git a/docs/docs/api-reference/examples/serviceintegrationendpoint.yaml b/docs/docs/api-reference/examples/serviceintegrationendpoint.yaml
@@ -0,0 +1,19 @@
+apiVersion: aiven.io/v1alpha1
+kind: ServiceIntegrationEndpoint
+metadata:
+  name: my-endpoint
+spec:
+  authSecretRef:
+    name: aiven-token
+    key: token
+
+  project: aiven-project-name
+  endpointName: my-endpoint
+  endpointType: external_postgresql
+
+  externalPostgresql:
+    username: username
+    password: password
+    host: host
+    port: 5432
+    ssl_mode: disable
diff --git a/docs/docs/api-reference/serviceintegrationendpoint.md b/docs/docs/api-reference/serviceintegrationendpoint.md
@@ -2,6 +2,30 @@
 title: "ServiceIntegrationEndpoint"
 ---
 
+## Usage example
+
+```yaml
+apiVersion: aiven.io/v1alpha1
+kind: ServiceIntegrationEndpoint
+metadata:
+  name: my-endpoint
+spec:
+  authSecretRef:
+    name: aiven-token
+    key: token
+
+  project: aiven-project-name
+  endpointName: my-endpoint
+  endpointType: external_postgresql
+
+  externalPostgresql:
+    username: username
+    password: password
+    host: host
+    port: 5432
+    ssl_mode: disable
+```
+
 ## ServiceIntegrationEndpoint {: #ServiceIntegrationEndpoint }
 
 ServiceIntegrationEndpoint is the Schema for the serviceintegrationendpoints API.

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -108,4 +108,5 @@ nav:
       - api-reference/projectvpc.md
       - api-reference/redis.md
       - api-reference/serviceintegration.md
+      - api-reference/serviceintegrationendpoint.md
       - api-reference/serviceuser.md