From 5fcea965b6c7b53b7f72419a6e8ff469ecd8abe4 Mon Sep 17 00:00:00 2001
From: Rounak Dhillon <162090200+RounakDhillon@users.noreply.github.com>
Date: Tue, 24 Jun 2025 15:44:16 +0530
Subject: [PATCH] Doc: Rest YAML File Updation (#21922)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: “Rounak <“rounakpreet.d@deuexsolutions.com”>
Co-authored-by: Prajwal214 <167504578+Prajwal214@users.noreply.github.com>
---
 .../v1.7/connectors/yaml/api/source-config-def.md  | 13 +++++++++++++
 .../v1.7/connectors/yaml/api/source-config.md      | 14 ++++++++++++++
 .../v1.8/connectors/yaml/api/source-config-def.md  | 13 +++++++++++++
 .../v1.8/connectors/yaml/api/source-config.md      | 14 ++++++++++++++
 .../content/v1.7.x/connectors/api/rest/yaml.md     |  3 ++-
 5 files changed, 56 insertions(+), 1 deletion(-)
 create mode 100644 openmetadata-docs/content/partials/v1.7/connectors/yaml/api/source-config-def.md
 create mode 100644 openmetadata-docs/content/partials/v1.7/connectors/yaml/api/source-config.md
 create mode 100644 openmetadata-docs/content/partials/v1.8/connectors/yaml/api/source-config-def.md
 create mode 100644 openmetadata-docs/content/partials/v1.8/connectors/yaml/api/source-config.md

diff --git a/openmetadata-docs/content/partials/v1.7/connectors/yaml/api/source-config-def.md b/openmetadata-docs/content/partials/v1.7/connectors/yaml/api/source-config-def.md
new file mode 100644
index 00000000000..f691e896962
--- /dev/null
+++ b/openmetadata-docs/content/partials/v1.7/connectors/yaml/api/source-config-def.md
@@ -0,0 +1,13 @@
+#### Source Configuration - Source Config
+
+{% codeInfo srNumber=100 %}
+
+The `sourceConfig` is defined [here](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/metadataIngestion/apiServiceMetadataPipeline.json):
+
+**markDeletedApiCollections**: To flag API collections as soft-deleted if they are not present anymore in the source system.
+
+**overrideMetadata**: Set the Override Metadata toggle to control whether to override the metadata if it already exists.
+
+**apiCollectionFilterPattern**: Note that the filter supports regex as include or exclude.
+
+{% /codeInfo %}
diff --git a/openmetadata-docs/content/partials/v1.7/connectors/yaml/api/source-config.md b/openmetadata-docs/content/partials/v1.7/connectors/yaml/api/source-config.md
new file mode 100644
index 00000000000..e1a5534f245
--- /dev/null
+++ b/openmetadata-docs/content/partials/v1.7/connectors/yaml/api/source-config.md
@@ -0,0 +1,14 @@
+```yaml {% srNumber=100 %}
+  sourceConfig:
+    config:
+      type: ApiMetadata
+      markDeletedApiCollections: true
+      overrideMetadata: false
+      # apiCollectionFilterPattern:
+      #   includes:
+      #     - apiCollection1
+      #     - apiCollection2
+      #   excludes:
+      #     - apiCollection3
+      #     - apiCollection4
+```
diff --git a/openmetadata-docs/content/partials/v1.8/connectors/yaml/api/source-config-def.md b/openmetadata-docs/content/partials/v1.8/connectors/yaml/api/source-config-def.md
new file mode 100644
index 00000000000..f691e896962
--- /dev/null
+++ b/openmetadata-docs/content/partials/v1.8/connectors/yaml/api/source-config-def.md
@@ -0,0 +1,13 @@
+#### Source Configuration - Source Config
+
+{% codeInfo srNumber=100 %}
+
+The `sourceConfig` is defined [here](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/metadataIngestion/apiServiceMetadataPipeline.json):
+
+**markDeletedApiCollections**: To flag API collections as soft-deleted if they are not present anymore in the source system.
+
+**overrideMetadata**: Set the Override Metadata toggle to control whether to override the metadata if it already exists.
+
+**apiCollectionFilterPattern**: Note that the filter supports regex as include or exclude.
+
+{% /codeInfo %}
diff --git a/openmetadata-docs/content/partials/v1.8/connectors/yaml/api/source-config.md b/openmetadata-docs/content/partials/v1.8/connectors/yaml/api/source-config.md
new file mode 100644
index 00000000000..e1a5534f245
--- /dev/null
+++ b/openmetadata-docs/content/partials/v1.8/connectors/yaml/api/source-config.md
@@ -0,0 +1,14 @@
+```yaml {% srNumber=100 %}
+  sourceConfig:
+    config:
+      type: ApiMetadata
+      markDeletedApiCollections: true
+      overrideMetadata: false
+      # apiCollectionFilterPattern:
+      #   includes:
+      #     - apiCollection1
+      #     - apiCollection2
+      #   excludes:
+      #     - apiCollection3
+      #     - apiCollection4
+```
diff --git a/openmetadata-docs/content/v1.7.x/connectors/api/rest/yaml.md b/openmetadata-docs/content/v1.7.x/connectors/api/rest/yaml.md
index 20ed08ff202..b900baf69d9 100644
--- a/openmetadata-docs/content/v1.7.x/connectors/api/rest/yaml.md
+++ b/openmetadata-docs/content/v1.7.x/connectors/api/rest/yaml.md
@@ -67,7 +67,8 @@ source:
 ```
 ```yaml {% srNumber=1 %}
       openAPISchemaURL: https://docs.open-metadata.org/swagger.json
-
+      docURL: https://petstore3.swagger.io/
+      # token: <jwt_token>
 ```