MINOR - Remove required description field

[TeddyCr]

Describe your changes:

Fixes

I worked on ... because ...

Type of change:

• Bug fix
• Improvement
• New feature
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation

Checklist:

• I have read the CONTRIBUTING document.
• My PR title is Fixes <issue-number>: <short explanation>
• I have commented on my code, particularly in hard-to-understand areas.
• For JSON Schema changes: I updated the migration scripts or explained why it is not needed.

---

Summary by Gitar

• Schema validation update:
  • Removed description from required fields in createTestDefinition.json and testDefinition.json
• Form validation removal:
  • Removed required validation rules for description field in TestDefinitionForm.component.tsx
• Impact:
  • Test definitions can now be created without providing a description field

_{This will update automatically on new commits.}

---

[gitar-bot]

🔍 CI failure analysis for c1c187f: CI failures across 16+ jobs in 3 categories: (1) infrastructure failures from branch deletion, (2) configuration issues with missing nox/cachetools, and (3) test failures across integration tests (3 failures), UI tests (8 failures), and DataProduct tests (6 new failures with port creation/migration issues) - likely related to PR's schema changes making 'description' optional.

Issue

Multiple CI jobs failed with three categories: infrastructure failures, environment configuration issues, and test failures across integration, UI, and DataProduct tests.

Root Cause

Category 1: Infrastructure Failures

Branch MINOR-Remove-Required-Description deleted after CI triggered:

• generate-types: Git fetch failed (exit code 1)
• maven-collate-ci: Collate workflow submodule checkout failed (exit code 128)
• integration-tests-postgres-opensearch (63879265532): Job timed out during OpenSearch index initialization

Category 2: Configuration Failures (6 Jobs)

All Python test jobs failed with nox: command not found (exit code 127):

• Unit Tests & Static Checks (3.10, 3.11) - Jobs 63879265689, 63879265988
• Integration Tests shard-1 (3.10, 3.11) - Jobs 63879265768, 63879265906
• Integration Tests shard-2 (3.10, 3.11) - Jobs 63879265791, 63879265696

Also: ModuleNotFoundError: cachetools during DAG validation, py-combine-coverage (63882535849) missing upstream artifacts

Category 3: Test Failures (PR-Related)

A. Integration Tests

integration-tests-mysql-elasticsearch (63879265727) - 3 failures in 10,687 tests:

• TestSuiteResourceIT:765: NullPointerException: pipelineServiceClient is null
• WorkflowDefinitionResourceIT:5251, :2553: Timeouts (2 min, 1 min)
• Infrastructure issues: DJL NDManager leaks (3450+), OpenSearch pool shutdowns, "Missing required property 'ShardFailure.primary'"

B. UI/Playwright Tests

playwright-ci-postgresql (3, 6) (63879265629) - 8 failures in 651 passed:

• SettingsNavigationPage (save button disabled), BulkImport (timeout), DataProductRename/OnlineUsers (undefined property access)
• ImpactAnalysis (TypeError accessing undefined), Permissions (browser crash, button not visible)

C. DataProduct Tests (NEW)

maven-sonarcloud-ci (63879265424) & Test Report (63905820486) - 6 failures in DataProductResourceTest:

1. testDataProductBulkOutputPorts:850 - expected success, got failure
2. testGetPortsByNameEndpoints:1108 - expected 1 port, got 0
3. testGetPortsViewEndpoint:1066 - expected 1 port, got 0
4. testGetOutputPortsReturnsFullEntities:1012 - expected 1 port, got 0
5. testDataProductDomainMigrationWithInputOutputPorts:1732 - Wrong domain UUID assigned to output port
6. testDataProductBulkPortsViaApi:904 - HTTP 400 error

Pattern: Port creation returning 0 results, domain migration assigning to wrong domain, bulk operations failing. May be related to TestDefinition schema changes cascading to DataProduct validation.

Details

PR Context:

• PR MINOR - Remove required description field #25939 removes "description" as required from TestDefinition schema
• Commit: c1c187f

Common Pattern: All test failures show undefined/null/missing entity issues:

• Integration: NullPointerException, schema validation errors
• UI: Undefined property access, broken form state
• DataProduct: Port entities missing, domain assignment failures

Recommended Actions

1. Infrastructure: Restore branch or re-trigger CI
2. Configuration: Install nox, fix cachetools environment
3. Test Failures:
   • Priority 1 - DataProduct: Investigate TestDefinition schema → DataProduct port entity relationship
   • Priority 2 - UI: Verify test fixtures handle optional "description"
   • Priority 3 - Integration: Review entity response structures
4. Schema Impact: Verify TestDefinition changes don't cascade to dependent entities (DataProducts, Ports)

Code Review ✅ Approved

Clean removal of the required constraint on the description field, applied consistently across JSON schemas (API and entity) and the UI form. No issues found.

Tip

Comment Gitar fix CI or enable auto-apply: gitar auto-apply:on

Options

Auto-apply is off → Gitar will not commit updates to this branch.
Display: compact → Showing less information.

Comment with these commands to change:

Auto-apply	Compact
gitar auto-apply:on	gitar display:verbose

_{Was this helpful? React with 👍 / 👎 | Gitar}

[github-actions]

Jest test Coverage

UI tests summary

Lines	Statements	Branches	Functions
	65.69% (56271/85657)	45.12% (29422/65215)	47.94% (8891/18548)

[sonarqubecloud]

Quality Gate passed for 'open-metadata-ui'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud