yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-08-22 07:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs: ApiMetadata ingestion source-config (#19158)

Browse Source 
Signed-off-by: CyberHippo <hippolyte@vergnol.fr>
This commit is contained in:
Hippo 2024-12-28 18:33:58 +01:00 committed by GitHub
parent 633cead09a
commit 24b668a642
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 33 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
openmetadata-docs/content/partials/v1.6/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.6/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
```

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

@ -46,7 +46,7 @@ This is a sample config for OpenAPI:
{% codeInfo srNumber=1 %} {% codeInfo srNumber=1 %}
**OpenAPI Schema URL**: **OpenAPI Schema URL**:
An OpenAPI schema URL typically refers to the URL where the OpenAPI Specification (OAS) document of a web service is hosted. The document defines the service's API, including available endpoints, request/response formats, authentication methods, etc. It is usually in JSON format. for e.g. `https://petstore3.swagger.io/api/v3/openapi.json` An OpenAPI schema URL typically refers to the URL where the OpenAPI Specification (OAS) document of a web service is hosted. The document defines the service's API, including available endpoints, request/response formats, authentication methods, etc. It is usually in JSON format. for e.g. `https://petstore3.swagger.io/api/v3/openapi.json`
**Token**: An authentication token to connect to an OpenAPI schema URL. It is only required if the API schema is protected or secured. **Token**: An authentication token to connect to an OpenAPI schema URL. It is only required if the API schema is protected or secured.
@ -63,7 +63,7 @@ source:
serviceName: openapi_rest serviceName: openapi_rest
serviceConnection: serviceConnection:
config: config:
type: REST type: ApiMetadata
``` ```
```yaml {% srNumber=1 %} ```yaml {% srNumber=1 %}
openAPISchemaURL: https://docs.open-metadata.org/swagger.json openAPISchemaURL: https://docs.open-metadata.org/swagger.json
@ -71,7 +71,7 @@ source:
``` ```
{% partial file="/v1.6/connectors/yaml/database/source-config.md" /%} {% partial file="/v1.6/connectors/yaml/api/source-config.md" /%}
{% partial file="/v1.6/connectors/yaml/ingestion-sink.md" /%} {% partial file="/v1.6/connectors/yaml/ingestion-sink.md" /%}

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

@ -46,7 +46,7 @@ This is a sample config for OpenAPI:
{% codeInfo srNumber=1 %} {% codeInfo srNumber=1 %}
**OpenAPI Schema URL**: **OpenAPI Schema URL**:
An OpenAPI schema URL typically refers to the URL where the OpenAPI Specification (OAS) document of a web service is hosted. The document defines the service's API, including available endpoints, request/response formats, authentication methods, etc. It is usually in JSON format. for e.g. `https://petstore3.swagger.io/api/v3/openapi.json` An OpenAPI schema URL typically refers to the URL where the OpenAPI Specification (OAS) document of a web service is hosted. The document defines the service's API, including available endpoints, request/response formats, authentication methods, etc. It is usually in JSON format. for e.g. `https://petstore3.swagger.io/api/v3/openapi.json`
**Token**: An authentication token to connect to an OpenAPI schema URL. It is only required if the API schema is protected or secured. **Token**: An authentication token to connect to an OpenAPI schema URL. It is only required if the API schema is protected or secured.
@ -63,7 +63,7 @@ source:
serviceName: openapi_rest serviceName: openapi_rest
serviceConnection: serviceConnection:
config: config:
type: REST type: ApiMetadata
``` ```
```yaml {% srNumber=1 %} ```yaml {% srNumber=1 %}
openAPISchemaURL: https://docs.open-metadata.org/swagger.json openAPISchemaURL: https://docs.open-metadata.org/swagger.json
@ -71,7 +71,7 @@ source:
``` ```
{% partial file="/v1.7/connectors/yaml/database/source-config.md" /%} {% partial file="/v1.7/connectors/yaml/api/source-config.md" /%}
{% partial file="/v1.7/connectors/yaml/ingestion-sink.md" /%} {% partial file="/v1.7/connectors/yaml/ingestion-sink.md" /%}