Tfs Test Plans And Suites Migration Processor

This is the JSON schema that defines the structure and validation rules for this configuration.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://devopsmigration.io/schema/schema.processors.tfstestplansandsuitesmigrationprocessor.json",
  "title": "TfsTestPlansAndSuitesMigrationProcessor",
  "description": "Rebuilds Suits and plans for Test Cases migrated using the WorkItemMigration",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "If set to `true` then the processor will run. Set to `false` and the processor will not run.",
      "type": "boolean"
    },
    "enrichers": {
      "description": "List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors.",
      "type": "array"
    },
    "filterCompleted": {
      "description": "missing XML code comments",
      "type": "boolean"
    },
    "migrationDelay": {
      "description": "??Not sure what this does. Check code.",
      "type": "integer",
      "default": "0"
    },
    "onlyElementsWithTag": {
      "description": "The tag name that is present on all elements that must be migrated. If this option isn't present this processor will migrate all.",
      "type": "string",
      "default": "`String.Empty`"
    },
    "refName": {
      "description": "`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.",
      "type": "string"
    },
    "removeAllLinks": {
      "description": "??Not sure what this does. Check code.",
      "type": "boolean",
      "default": "false"
    },
    "removeInvalidTestSuiteLinks": {
      "description": "Indicates whether the configuration for node structure transformation should be taken from the common enricher configs. Otherwise the configuration elements below are used",
      "type": "boolean",
      "default": "false"
    },
    "sourceName": {
      "description": "This is the `IEndpoint` that will be used as the source of the Migration. Can be null for a write only processor.",
      "type": "string"
    },
    "targetName": {
      "description": "This is the `IEndpoint` that will be used as the Target of the Migration. Can be null for a read only processor.",
      "type": "string"
    },
    "testPlanIds": {
      "description": "This flag filters all test plans and retains only the specified ones for migration. Pass the test plan IDs as an array. Example: \"TestPlanIds\": [123, 456, 789]   Works optimally when \"TestPlanQuery\" is set to null.",
      "type": "string"
    },
    "testPlanQuery": {
      "description": "Filtering conditions to decide whether to migrate a test plan or not. When provided, this partial query is added after `Select * From TestPlan Where` when selecting test plans. Among filtering options, `AreaPath`, `PlanName` and `PlanState` are known to work. There is unfortunately no documentation regarding the available fields.",
      "type": "string",
      "default": "`String.Empty`"
    }
  }
}