designimage¶
Version: v1 Scope: per-tenant (not scoped to a store) Owning service: studio-design-library
A designimage record represents a static image asset available to the Studio design editor and the studio rendering pipeline. These images are uploaded and managed by the studio-design-library service and are available across all stores within a tenant — they are tenant-scoped, not store-scoped.
Typical uses include brand logos, product photographs, and decorative assets that a designer embeds into a label layout using the Studio editor. The display_name field holds the human-readable name shown in the Studio image picker (initially populated from the original filename at upload time). Tags allow grouping and filtering images in the editor UI.
Like other binary assets in the platform, the image file itself is stored in LFS under a content-addressed path (SHA-256 hash of the file content), which enables deduplication across the tenant's image library.
ID pattern¶
t/{tenantid}/designimages/{imageid}
t/{tenantid}— tenant namespace; designimages are not store-scopeddesignimages/{imageid}— whereimageidis most likely a GUID assigned at upload time
Aliases¶
by_tag¶
Groups designimage records by tag so consumers can efficiently retrieve all images with a given tag without a full scan.
| Property | Value |
|---|---|
| Alias name | by_tag |
| Alias expression | {.id/[..2]}/designimagetags/{.tags[]}/designimages/{imageid} |
| Alias pattern | t/{tenantid}/designimagetags/{tag}/designimages/{imageid} |
This alias is multivalued: a single designimage with multiple tags creates one alias entry per tag, each following the pattern above.
Schema¶
| Field | Type | Description |
|---|---|---|
id |
string |
Primary ID following the pattern t/{tenantid}/designimages/{imageid}. The imageid segment is typically a GUID |
display_name |
string |
Human-readable name shown in the Studio image picker. Optional. At upload time this is populated from the original filename; it can be renamed by the designer |
file_path |
string |
LFS path to the image file. The filename is the SHA-256 hex digest of the file content, enabling deduplication within the tenant's image library. Format: designer/t/{tenantid}/designimages/{sha256}.{ext} |
tags |
repeated string |
Zero or more tags used for categorisation and filtering in the Studio editor. Each tag generates a by_tag alias entry |
Consumed by¶
| Service | Why |
|---|---|
studio-renderer |
Resolves image references embedded in Studio label designs; fetches the image data from LFS via file_path during rendering |
studio-design-library (editor API) |
Serves the image picker in the Studio editor; queries by tag using the by_tag alias |
Related DTOs¶
- eccimage — the equivalent image asset DTO for the ECC rendering pipeline; store-scoped and addressed by
original_pathrather than GUID