yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-08-15 12:37:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Doc: Rest YAML File Updation (#21922)

Browse Source 
Co-authored-by: “Rounak <“rounakpreet.d@deuexsolutions.com”>
Co-authored-by: Prajwal214 <167504578+Prajwal214@users.noreply.github.com>
This commit is contained in:
Rounak Dhillon 2025-06-24 15:44:16 +05:30 committed by GitHub
parent 0f7d6e7f61
commit 5fcea965b6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 56 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
openmetadata-docs/content/partials/v1.7/connectors/yaml/api/source-config-def.md Normal file
View File

@ -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 %}

14
openmetadata-docs/content/partials/v1.7/connectors/yaml/api/source-config.md Normal file
View File

@ -0,0 +1,14 @@
```yaml {% srNumber=100 %}
sourceConfig:
config:
type: ApiMetadata
markDeletedApiCollections: true
overrideMetadata: false
# apiCollectionFilterPattern:
# includes:
# - apiCollection1
# - apiCollection2
# excludes:
# - apiCollection3
# - apiCollection4
```

13
openmetadata-docs/content/partials/v1.8/connectors/yaml/api/source-config-def.md Normal file
View File

@ -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 %}

14
openmetadata-docs/content/partials/v1.8/connectors/yaml/api/source-config.md Normal file
View File

@ -0,0 +1,14 @@
```yaml {% srNumber=100 %}
sourceConfig:
config:
type: ApiMetadata
markDeletedApiCollections: true
overrideMetadata: false
# apiCollectionFilterPattern:
# includes:
# - apiCollection1
# - apiCollection2
# excludes:
# - apiCollection3
# - apiCollection4
```

3
openmetadata-docs/content/v1.7.x/connectors/api/rest/yaml.md
View File

@ -67,7 +67,8 @@ source:
```
```yaml {% srNumber=1 %}
openAPISchemaURL: https://docs.open-metadata.org/swagger.json
docURL: https://petstore3.swagger.io/
# token: <jwt_token>
```