Skip to content

PrivateChannelEvent extends ApiEvent#1474

Merged
kriswest merged 2 commits intomainfrom
PrivateChannelEvent-extends-ApiEvent
Dec 16, 2024
Merged

PrivateChannelEvent extends ApiEvent#1474
kriswest merged 2 commits intomainfrom
PrivateChannelEvent-extends-ApiEvent

Conversation

@kriswest
Copy link
Copy Markdown
Contributor

@kriswest kriswest commented Dec 16, 2024

Describe your change

PrivateChannelEvent extends ApiEvent in the documentation , but not in the sourcecode and needs to be corrected

Related Issue

resolves #1473

Contributor License Agreement

  • I acknowledge that a contributor license agreement is required and that I have one in place or will seek to put one in place ASAP.

Review Checklist

  • Issue: If a change was made to the FDC3 Standard, was an issue linked above?
  • CHANGELOG: Is a CHANGELOG.md entry included?
  • API changes: Does this PR include changes to any of the FDC3 APIs (DesktopAgent, Channel, PrivateChannel, Listener, Bridging)?
    • Docs & Sources: If yes, were both documentation (/docs) and sources updated?

      JSDoc comments on interfaces and types should be matched to the main documentation in /docs
    • Conformance tests: If yes, are conformance test definitions (/toolbox/fdc3-conformance) still correct and complete?

      Conformance test definitions should cover all required aspects of an FDC3 Desktop Agent implementation, which are usually marked with a MUST keyword, and optional features (SHOULD or MAY) where the format of those features is defined
    • Schemas: If yes, were changes applied to the Bridging and FDC3 for Web protocol schemas?

      The Web Connection protocol and Desktop Agent Communication Protocol schemas must be able to support all necessary aspects of the Desktop Agent API, while Bridging must support those aspects necessary for Desktop Agents to communicate with each other
      • If yes, was code generation (npm run build) run and the results checked in?

        Generated code will be found at /src/api/BrowserTypes.ts and/or /src/bridging/BridgingTypes.ts
  • Context types: Were new Context type schemas created or modified in this PR?
    • Were the field type conventions adhered to?
    • Was the BaseContext schema applied via allOf (as it is in existing types)?
    • Was a title and description provided for all properties defined in the schema?
    • Was at least one example provided?
    • Was code generation (npm run build) run and the results checked in?

      Generated code will be found at /src/context/ContextTypes.ts
  • Intents: Were new Intents created in this PR?

@kriswest kriswest requested a review from a team as a code owner December 16, 2024 11:59
@netlify
Copy link
Copy Markdown

netlify Bot commented Dec 16, 2024

Deploy Preview for fdc3 canceled.

Name Link
🔨 Latest commit c0e1762
🔍 Latest deploy log https://app.netlify.com/sites/fdc3/deploys/67601636479c530008025837

@kriswest kriswest requested review from a team and bingenito December 16, 2024 12:00
@kriswest
Copy link
Copy Markdown
Contributor Author

Well spotted @bingenito!

@kriswest kriswest merged commit bc2fa35 into main Dec 16, 2024
@kriswest kriswest deleted the PrivateChannelEvent-extends-ApiEvent branch December 16, 2024 12:41
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.

PrivateChannelEvent should extend ApiEvent

2 participants