Fix OpenAPI schema validation for property descriptions and examples - #705
Merged
Merged
Conversation
The nightly Schema Validation run on 2026.x fails because these OpenAPI property descriptions exceed 100 characters or lack an example. Keep the descriptions short and move the explanatory detail into docblocks. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approved
The revised description satisfies the stated validation constraint and is consistently reflected in the generated client.
Review effort: Balanced
Findings: None
What changed in this PR
Fixes OpenAPI validation by shortening the data preview cell description while preserving generated client consistency.
Changes:
- Shortens the property description to 72 characters.
- Synchronizes the generated TypeScript comment.
| File | Description |
|---|---|
src/Schema/DataPreviewResponse.php |
Updates the OpenAPI property description. |
assets/studio/js/src/modules/data-importer/data-importer-api-slice.gen.ts |
Mirrors the description in generated types. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The nightly Schema Validation job on
2026.x(failing run) lints the deployed OpenAPI spec: each property needs a 2–100 character description and anexample. It has been red since at least 2026-09-21.This PR fixes the violations in this repo:
BundleDataImporterDataPreviewResponse.dataPreview[].data: description over 100 chars (generated TS client comment updated to match)Each description is shortened to 100 characters or less, and the explanatory detail moved into a docblock on the property (the pattern these schema files already use). No behaviour change.
🤖 Generated with Claude Code