diff --git a/api/bsky/embedgetEmbedExternalView.go b/api/bsky/embedgetEmbedExternalView.go index f5ddccca..e7a74df6 100644 --- a/api/bsky/embedgetEmbedExternalView.go +++ b/api/bsky/embedgetEmbedExternalView.go @@ -16,7 +16,8 @@ type EmbedGetEmbedExternalView_Output struct { AssociatedRecords []*lexutil.LexiconTypeDecoder `json:"associatedRecords,omitempty" cborgen:"associatedRecords,omitempty"` // associatedRefs: StrongRefs (URI+CID) of the Atmosphere records that backed this view, suitable for embedding into a post's external.associatedRefs. AssociatedRefs []*comatproto.RepoStrongRef `json:"associatedRefs,omitempty" cborgen:"associatedRefs,omitempty"` - View *EmbedExternal_View `json:"view,omitempty" cborgen:"view,omitempty"` + // view: Hydrated view of the embed. Present whenever at least one record was hydrated. `view.external.title` and `view.external.description` may be empty strings when the resolved records didn't supply them; clients should treat that as 'no enrichment for this field.' + View *EmbedExternal_View `json:"view,omitempty" cborgen:"view,omitempty"` } // EmbedGetEmbedExternalView calls the XRPC method "app.bsky.embed.getEmbedExternalView". diff --git a/lexicons/app/bsky/embed/getEmbedExternalView.json b/lexicons/app/bsky/embed/getEmbedExternalView.json index 7d60d24e..2b52ddb1 100644 --- a/lexicons/app/bsky/embed/getEmbedExternalView.json +++ b/lexicons/app/bsky/embed/getEmbedExternalView.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Resolve one or more AT-URIs into the data needed to render an enhanced external embed. Returns `associatedRefs` (strongRefs to embed into a post's external.associatedRefs) and the raw `associatedRecords`; `view` is also included when the resolved records can produce a renderable view, but may be omitted when no records were hydratable.", + "description": "Resolve one or more AT-URIs into the data needed to render an enhanced external embed. Returns `associatedRefs` (strongRefs to embed into a post's external.associatedRefs) and the raw `associatedRecords`; `view` is included when at least one record was hydrated, but may be omitted otherwise. When `view` is present, `view.external.title` and `view.external.description` may be empty strings if the resolved records didn't supply them — clients should treat empty values as 'no enrichment for this field' rather than the content being genuinely titleless.", "parameters": { "type": "params", "required": ["url", "uris"], @@ -29,7 +29,8 @@ "properties": { "view": { "type": "ref", - "ref": "app.bsky.embed.external#view" + "ref": "app.bsky.embed.external#view", + "description": "Hydrated view of the embed. Present whenever at least one record was hydrated. `view.external.title` and `view.external.description` may be empty strings when the resolved records didn't supply them; clients should treat that as 'no enrichment for this field.'" }, "associatedRefs": { "type": "array",