mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-08-15 04:26:59 +00:00
Doc: Rest YAML File Updation (#21922)
Co-authored-by: “Rounak <“rounakpreet.d@deuexsolutions.com”> Co-authored-by: Prajwal214 <167504578+Prajwal214@users.noreply.github.com>
This commit is contained in:
parent
0f7d6e7f61
commit
5fcea965b6
@ -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 %}
|
@ -0,0 +1,14 @@
|
|||||||
|
```yaml {% srNumber=100 %}
|
||||||
|
sourceConfig:
|
||||||
|
config:
|
||||||
|
type: ApiMetadata
|
||||||
|
markDeletedApiCollections: true
|
||||||
|
overrideMetadata: false
|
||||||
|
# apiCollectionFilterPattern:
|
||||||
|
# includes:
|
||||||
|
# - apiCollection1
|
||||||
|
# - apiCollection2
|
||||||
|
# excludes:
|
||||||
|
# - apiCollection3
|
||||||
|
# - apiCollection4
|
||||||
|
```
|
@ -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 %}
|
@ -0,0 +1,14 @@
|
|||||||
|
```yaml {% srNumber=100 %}
|
||||||
|
sourceConfig:
|
||||||
|
config:
|
||||||
|
type: ApiMetadata
|
||||||
|
markDeletedApiCollections: true
|
||||||
|
overrideMetadata: false
|
||||||
|
# apiCollectionFilterPattern:
|
||||||
|
# includes:
|
||||||
|
# - apiCollection1
|
||||||
|
# - apiCollection2
|
||||||
|
# excludes:
|
||||||
|
# - apiCollection3
|
||||||
|
# - apiCollection4
|
||||||
|
```
|
@ -67,7 +67,8 @@ source:
|
|||||||
```
|
```
|
||||||
```yaml {% srNumber=1 %}
|
```yaml {% srNumber=1 %}
|
||||||
openAPISchemaURL: https://docs.open-metadata.org/swagger.json
|
openAPISchemaURL: https://docs.open-metadata.org/swagger.json
|
||||||
|
docURL: https://petstore3.swagger.io/
|
||||||
|
# token: <jwt_token>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user