From 24b668a642f7cd6285ba7089fdeb90b39f5c85d7 Mon Sep 17 00:00:00 2001 From: Hippo Date: Sat, 28 Dec 2024 18:33:58 +0100 Subject: [PATCH] Docs: ApiMetadata ingestion source-config (#19158) Signed-off-by: CyberHippo --- .../v1.6/connectors/yaml/api/source-config-def.md | 13 +++++++++++++ .../v1.6/connectors/yaml/api/source-config.md | 14 ++++++++++++++ .../content/v1.6.x/connectors/api/rest/yaml.md | 6 +++--- .../v1.7.x-SNAPSHOT/connectors/api/rest/yaml.md | 6 +++--- 4 files changed, 33 insertions(+), 6 deletions(-) create mode 100644 openmetadata-docs/content/partials/v1.6/connectors/yaml/api/source-config-def.md create mode 100644 openmetadata-docs/content/partials/v1.6/connectors/yaml/api/source-config.md diff --git a/openmetadata-docs/content/partials/v1.6/connectors/yaml/api/source-config-def.md b/openmetadata-docs/content/partials/v1.6/connectors/yaml/api/source-config-def.md new file mode 100644 index 00000000000..f691e896962 --- /dev/null +++ b/openmetadata-docs/content/partials/v1.6/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.6/connectors/yaml/api/source-config.md b/openmetadata-docs/content/partials/v1.6/connectors/yaml/api/source-config.md new file mode 100644 index 00000000000..e1a5534f245 --- /dev/null +++ b/openmetadata-docs/content/partials/v1.6/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.6.x/connectors/api/rest/yaml.md b/openmetadata-docs/content/v1.6.x/connectors/api/rest/yaml.md index 325f3aa1067..adf15e6b157 100644 --- a/openmetadata-docs/content/v1.6.x/connectors/api/rest/yaml.md +++ b/openmetadata-docs/content/v1.6.x/connectors/api/rest/yaml.md @@ -46,7 +46,7 @@ This is a sample config for OpenAPI: {% 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` **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 serviceConnection: config: - type: REST + type: ApiMetadata ``` ```yaml {% srNumber=1 %} 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" /%} diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/api/rest/yaml.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/api/rest/yaml.md index 8e21f6818a1..20ed08ff202 100644 --- a/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/api/rest/yaml.md +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/api/rest/yaml.md @@ -46,7 +46,7 @@ This is a sample config for OpenAPI: {% 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` **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 serviceConnection: config: - type: REST + type: ApiMetadata ``` ```yaml {% srNumber=1 %} 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" /%}