Skip to content

refactor: update SvgAsset schema description and examples for clarity #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dazzatronus merged 1 commit into from
Apr 3, 2026
Merged

refactor: update SvgAsset schema description and examples for clarity #101

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 5 additions & 11 deletions schemas/svgasset.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,6 @@ SvgAsset:
description: |
The SvgAsset is used to add scalable vector graphics (SVG) to a video using raw SVG markup.

```json
{
"type": "svg",
"src": "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#FF0000\"/></svg>"
}
```

**Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,
`<line>`, `<polygon>`, `<polyline>`

Expand All @@ -31,16 +24,17 @@ SvgAsset:
example: svg
src:
description: |
Raw SVG markup string. The shape, fill, stroke, dimensions and opacity
are automatically extracted from the SVG content.
Raw SVG markup string. The SVG must contain valid SVG elements. The shape,
fill, stroke, dimensions and opacity are automatically extracted from the
SVG content.
type: string
minLength: 1
maxLength: 500000
example: '<svg width="100" height="100"><circle cx="50" cy="50" r="40" fill="#3498db"/></svg>'
example: "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#3498db\"/></svg>"
additionalProperties: false
required:
- type
- src
example:
type: svg
src: '<svg width="200" height="200"><rect x="10" y="10" width="180" height="180" rx="20" fill="#3498db" stroke="#2C3E50" stroke-width="3"/></svg>'
src: "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#3498db\"/></svg>"
Loading