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

Deprecating IntentMetadata.displayname #926

Merged
merged 8 commits into from
May 30, 2023
Merged

Deprecating IntentMetadata.displayname #926

merged 8 commits into from
May 30, 2023

Conversation

kriswest
Copy link
Contributor

@kriswest kriswest commented Mar 9, 2023

resolves #312

Marking IntentMetadata.displayName as deprecated as it can only come from app definitions in appD, which means the DA needs to pick one and all could be different. SWG agreed to go with the intent name instead as thats always the same AND is required to be recognizable

@netlify
Copy link

netlify bot commented Mar 9, 2023

Deploy Preview for fdc3 canceled.

Name Link
🔨 Latest commit f705e71
🔍 Latest deploy log https://app.netlify.com/sites/fdc3/deploys/642d7916b2b73500083e9590

@kriswest kriswest requested review from hughtroeger and a team March 9, 2023 16:40
@kriswest kriswest added this to the 2.1 milestone Mar 9, 2023
@kriswest kriswest added api FDC3 API Working Group app-directory deprecation Deprecating or removing features post deprecation labels Mar 9, 2023
docs/api/ref/Metadata.md Outdated Show resolved Hide resolved
src/api/IntentMetadata.ts Outdated Show resolved Hide resolved
src/app-directory/specification/appd.yaml Outdated Show resolved Hide resolved
src/app-directory/specification/appd.yaml Outdated Show resolved Hide resolved
@@ -607,7 +607,8 @@ components:
properties:
displayName:
type: string
description: An optional display name for the intent that may be used in UI instead of the name.
description: Optional display name for the intent. Deprecated in favour of the Intent name, which is common amongst all apps that support it, where teh display name may vary.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
description: Optional display name for the intent. Deprecated in favour of the Intent name, which is common amongst all apps that support it, where teh display name may vary.
description: Optional display name for the intent. Deprecated in favour of the intent name, which is common amongst all apps that support it, where the display name may vary.

kriswest and others added 4 commits April 5, 2023 14:28
Co-authored-by: Matt Jamieson <10372+mattjamieson@users.noreply.github.com>
Co-authored-by: Matt Jamieson <10372+mattjamieson@users.noreply.github.com>
@kriswest
Copy link
Contributor Author

kriswest commented Apr 5, 2023

Changes applied - needs signing off again @mattjamieson @greyseer256

Copy link
Contributor

@mattjamieson mattjamieson left a comment

Choose a reason for hiding this comment

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

LGTM!

@kriswest
Copy link
Contributor Author

@greyseer256 this'll need your review before its merged

Copy link
Contributor

@hughtroeger hughtroeger left a comment

Choose a reason for hiding this comment

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

👍

@kriswest kriswest removed this from the 2.1 milestone May 17, 2023
@kriswest kriswest merged commit 7fa7c47 into master May 30, 2023
@bingenito bingenito mentioned this pull request Nov 6, 2023
18 tasks
@kriswest kriswest deleted the kriswest/issue312 branch November 13, 2024 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api FDC3 API Working Group app-directory deprecation Deprecating or removing features post deprecation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The AppIntent interface incorrectly describes an intent
3 participants