OAS Update

Author: stackit-pipeline

services/intake/v1beta/intake.json

@@ -266,11 +266,13 @@
         "properties": {
           "personalAccessToken": {
             "description": "A Dremio personal access token for authentication",
+            "example": "bB7IPkMOqIFMNyZacEf7zkwwNZ4Yov60f/doo+4f18Mtl43lcw8n+BNgLCEkdA==",
             "maxLength": 1024,
             "type": "string"
           },
           "tokenEndpoint": {
             "description": "The URL to the Dremio instance's OAuth 2.0 token endpoint",
+            "example": "https://my-dremio.data-platform.stackit.run/oauth/token",
             "maxLength": 1024,
             "type": "string"
           }
@@ -284,11 +286,13 @@
         "properties": {
           "personalAccessToken": {
             "description": "A Dremio personal access token for authentication",
+            "example": "bB7IPkMOqIFMNyZacEf7zkwwNZ4Yov60f/doo+4f18Mtl43lcw8n+BNgLCEkdA==",
             "maxLength": 1024,
             "type": "string"
           },
           "tokenEndpoint": {
             "description": "The URL to the Dremio instance's OAuth 2.0 token endpoint",
+            "example": "https://my-dremio.data-platform.stackit.run/oauth/token",
             "maxLength": 1024,
             "type": "string"
           }
@@ -303,6 +307,7 @@
           "namespace": {
             "default": "intake",
             "description": "The namespace to which data shall be written. It will be automatically created, if it does not exist.",
+            "example": "my-namespace",
             "maxLength": 1024,
             "type": "string"
           },
@@ -317,17 +322,20 @@
           },
           "tableName": {
             "description": "The table name is a short name chosen by the user to identify the table in Iceberg.",
+            "example": "my-table",
             "maxLength": 32,
             "minLength": 1,
             "type": "string"
           },
           "uri": {
             "description": "The URI to the Iceberg catalog endpoint",
+            "example": "https://my-dremio-catalog.data-platform.stackit.run/iceberg",
             "maxLength": 1024,
             "type": "string"
           },
           "warehouse": {
             "description": "The Iceberg warehouse to connect to, required when the catalog has no default warehouse configured.",
+            "example": "catalog-s3",
             "maxLength": 1024,
             "type": "string"
           }
@@ -357,6 +365,7 @@
           },
           "uri": {
             "description": "The URI to the Iceberg catalog endpoint",
+            "example": "https://my-dremio-catalog.data-platform.stackit.run/iceberg",
             "maxLength": 1024,
             "type": "string"
           },
@@ -379,6 +388,7 @@
           },
           "deadLetterTopic": {
             "description": "The topic where undelivered messages are published (Dead Letter Queue).",
+            "example": "deadletter-intake-ea6184e0-57e2-4445-8721-64798e3636bd",
             "maxLength": 1024,
             "type": "string"
           },
@@ -399,11 +409,13 @@
           },
           "id": {
             "description": "A auto generated unique id which identifies the resource.",
+            "example": "ea6184e0-57e2-4445-8721-64798e3636bd",
             "format": "uuid",
             "type": "string"
           },
           "intakeRunnerId": {
             "description": "The unique id of the intake runner this intake is running on.",
+            "example": "b945ef76-9d09-491a-8f96-d41d30b6fdb9",
             "format": "uuid",
             "type": "string"
           },
@@ -427,6 +439,7 @@
           },
           "topic": {
             "description": "The topic to publish data to.",
+            "example": "intake-ea6184e0-57e2-4445-8721-64798e3636bd",
             "maxLength": 1024,
             "type": "string"
           },
@@ -437,6 +450,7 @@
           },
           "uri": {
             "description": "The URI for reaching the resource.",
+            "example": "b945ef76-9d09-491a-8f96-d41d30b6fdb9.intake.eu01.onstackit.cloud:9094",
             "maxLength": 1024,
             "type": "string"
           }
@@ -473,6 +487,7 @@
           },
           "id": {
             "description": "A auto generated unique id which identifies the resource.",
+            "example": "b945ef76-9d09-491a-8f96-d41d30b6fdb9",
             "format": "uuid",
             "type": "string"
           },
@@ -503,6 +518,7 @@
           },
           "uri": {
             "description": "The URI for reaching the resource.",
+            "example": "b945ef76-9d09-491a-8f96-d41d30b6fdb9.intake.eu01.onstackit.cloud:9094",
             "maxLength": 1024,
             "type": "string"
           }
@@ -743,7 +759,7 @@
   "info": {
     "description": "This API provides endpoints for managing Intakes.\n",
     "title": "STACKIT Intake API",
-    "version": "1beta.2.0"
+    "version": "1beta.2.1"
   },
   "openapi": "3.0.3",
   "paths": {