json.schema.metadataIngestion.apiServiceMetadataPipeline.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openmetadata-spec Show documentation

There is a newer version: 1.6.0-rc1

{
    "$id": "https://open-metadata.org/schema/metadataIngestion/apiServiceMetadataPipeline.json",
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "ApiServiceMetadataPipeline",
    "description": "ApiService Metadata Pipeline Configuration.",
    "type": "object",
    "definitions": {
        "ApiMetadataConfigType": {
          "description": "Api Source Config Metadata Pipeline type",
          "type": "string",
          "enum": ["ApiMetadata"],
          "default": "ApiMetadata"
        }
      },
      "properties": {
        "type": {
          "description": "Pipeline type",
          "$ref": "#/definitions/ApiMetadataConfigType",
          "default": "ApiMetadata"
        },
        "apiCollectionFilterPattern": {
          "description": "Regex to only fetch api collections with names matching the pattern.",
          "$ref": "../type/filterPattern.json#/definitions/filterPattern",
          "title": "API Collection Filter Pattern"
        },
        "markDeletedApiCollections": {
          "description": "Optional configuration to soft delete api collections in OpenMetadata if the source collections are deleted. Also, if the collection is deleted, all the associated entities like endpoints, etc., with that collection will be deleted",
          "type": "boolean",
          "default": true,
          "title": "Mark Deleted Api Collection"
        },
        "overrideMetadata":{
          "title": "Override Metadata",
          "description": "Set the 'Override Metadata' toggle to control whether to override the existing metadata in the OpenMetadata server with the metadata fetched from the source. If the toggle is set to true, the metadata fetched from the source will override the existing metadata in the OpenMetadata server. If the toggle is set to false, the metadata fetched from the source will not override the existing metadata in the OpenMetadata server. This is applicable for fields like description, tags, owner and displayName",
          "type": "boolean",
          "default": false
        }
      },
      "additionalProperties": false
}