Skip to content
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.

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

Add 'image' field to entities #188

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add 'image' field to entities #188

wants to merge 1 commit into from

Conversation

wetneb
Copy link
Member

@wetneb wetneb commented Jan 14, 2025

This PR adds an image field to entities so that those can be displayed in a controlled way, without relying on embedding the preview as an iframe.

This is an attempt at offering an alternative approach to #182, as discussed there.

Copy link

netlify bot commented Jan 14, 2025

Deploy Preview for reconciliation-api-specs ready!

Name Link
🔨 Latest commit 5d176d4
🔍 Latest deploy log https://app.netlify.com/sites/reconciliation-api-specs/deploys/678613faa398b50008e0802e
😎 Deploy Preview https://deploy-preview-188--reconciliation-api-specs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@@ -761,6 +763,8 @@ <h3>Suggest Responses</h3>
<dd>Its corresponding human-readable name, to be displayed prominently to the user;</dd>
<dt><code>description</code></dt>
<dd>An optional description which can be provided to disambiguate namesakes, providing more context. This could for instance be displayed underneath the <code>name</code>;</dd>
<dt><code>image</code></dt>
<dd>An optional URL to an image illustrating the entity, helping the user identify the entity visually. This image could for instance be displayed alongside the <code>name</code> and <code>description</code>;</dd>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion for consistency with the other changes in this PR:

Suggested change
<dd>An optional URL to an image illustrating the entity, helping the user identify the entity visually. This image could for instance be displayed alongside the <code>name</code> and <code>description</code>;</dd>
<dd>An optional URL of an image illustrating the entity, helping the user identify the entity visually. This image could for instance be displayed alongside the <code>name</code> and <code>description</code>;</dd>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants