10000 Add InvalidArguments to OpenError, ChannelError and ResolveError enums by KhurramJalil · Pull Request #1559 · finos/FDC3 · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add InvalidArguments to OpenError, ChannelError and ResolveError enums #1559

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

Merged
merged 7 commits into from
Apr 24, 2025

Conversation

KhurramJalil
Copy link
Contributor
@KhurramJalil KhurramJalil commented Apr 3, 2025

Describe your change

Fixed #1490 by adding InvalidArguments inside OpenError, ChannelError and ResolveError enums

Related Issue

Resolves #1490
#1490

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?

@KhurramJalil KhurramJalil requested a review from a team as a code owner April 3, 2025 10:30
Copy link
linux-foundation-easycla bot commented Apr 3, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

Copy link
netlify bot commented Apr 3, 2025

Deploy Preview for fdc3 ready!

Name Link
🔨 Latest commit
🔍 Latest deploy log https://app.netlify.com/sites/fdc3/deploys/67ef8f13cb7d0ec401d46c9e
😎 Deploy Preview https://deploy-preview-1559--fdc3.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.

@kriswest
Copy link
Contributor
kriswest commented Apr 3, 2025

Thanks for taking this on @KhurramJalil.

Rather than updating BridgingTypes.ts and BrowserTypes.ts directly, the schema files that they are generated from need to be updated. You can find the relevant section of the schema file at: https://github.com/KhurramJalil/FDC3/blob/f63785ae6615d44ff64fa986d1640573945937da/packages/fdc3-schema/schemas/api/api.schema.json#L302-L362

Once updated, run the following to generate the source files:

cd packages/fdc3-schema
npm install
npm run build

You should then have some modified files in your checkout that you can then commit to your PR branch.

@kriswest
Copy link
Contributor
kriswest commented Apr 3, 2025

Oh and also the docs page at: https://github.com/KhurramJalil/FDC3/blob/patch-2/website/docs/api/ref/Errors.md

Implemented code changes as per the feedback from @kriswest
Implemented the changes as per feedback from @kriswest
Copy link
Contributor
@kriswest kriswest 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 kriswest requested a review from a team April 17, 2025 15:26
Copy link
Contributor
@mistryvinay mistryvinay 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 kriswest changed the title Fixed https://github.com/finos/FDC3/issues/1490 by adding InvalidArguments inside OpenError, ChannelError and ResolveError enums Add InvalidArguments to OpenError, ChannelError and ResolveError enums Apr 24, 2025
@kriswest kriswest merged commit 6726556 into finos:main Apr 24, 2025
14 of 15 checks passed
@KhurramJalil KhurramJalil deleted the patch-2 branch May 19, 2025 09:00
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.

No defined behaviour when incorrect arguments are passed to API calls
4 participants
0