Adding language binding for golang #1483
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for fdc3 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
kemerava
changed the title
kriswest
reviewed
Dec 28, 2024
kriswest
requested changes
Dec 28, 2024
There was a problem hiding this comment.
Looks like a great contribution @kemerava 👏
I've given it a quick pass for typos and indentation consistency, see comments.
I think we could do with a subsection adding here on Go: https://deploy-preview-1483--fdc3.netlify.app/docs/next/api/supported-platforms#native
Please describe any idiosyncracies specific to the language. If you intend to contribute a repo with the binding to FINOS it can also be mentioned there.
docs/api/ref/Metadata.md
Outdated
Comment on lines
769
to
772
| // The unique name of the intent that can be invoked by the raiseIntent call. | ||
| Name string `json:"name"` | ||
|
|
||
| DisplayName string `json:"displayName"` |
docs/api/ref/Metadata.md
Outdated
Comment on lines
850
to
865
|
|
||
| ```go | ||
| type IntentResolution struct { | ||
| // The application that resolved the intent. | ||
| Source AppIdentifier `json:"source"` | ||
| // The intent that was raised. | ||
| Intent string `json:"intent"` | ||
| // The version number of the Intents schema being used. | ||
| Version string `json:"version"` | ||
| } | ||
|
|
||
| type IntentResult any | ||
|
|
||
| func (ir *IntentResolution) GetResult() <-chan Result[IntentResult] { | ||
| // implementation here | ||
| } |
docs/api/ref/Metadata.md
Outdated
Comment on lines
948
to
958
| resolutionResult := <-desktopAgent.RaiseIntent("QuoteStream", context, nil) | ||
| if resolutionResult.Err != nil { | ||
| // handle error | ||
| } | ||
| if channel, ok := resolutionResult.Value.(Channel); ok { | ||
| log.Println("The result is a channel") | ||
| } else if context, ok := resolutionResult.Value.(Context); ok { | ||
| log.Println("The result is a context") | ||
| } else { | ||
| log.Error("The result is of incorrect data type!") | ||
| } |
docs/api/ref/Types.md
Outdated
Comment on lines
62
to
66
| // The unique application identifier located within a specific application directory instance. An example of an appId might be 'app@sub.root'. | ||
| AppId string `json:"appId"` | ||
| // An optional instance identifier, indicating that this object represents a specific instance of the application described. | ||
| InstanceId string `json:"instanceId"` | ||
| } |
| Type string `json:"type"` | ||
| Name string `json:"name"` | ||
| Id map[string]string `json:"id"` | ||
| // This field is required only in golang, as golang structs cannot be extended with more fields later |
There was a problem hiding this comment.
Thank you so much @kriswest for the review! (Sorry about the indentation madness, looks like this new IDE does not do spell checks or any indents, should be better now). Also I have added a section about go in the supported platforms, let me know if this is the level of granularity that would be okay there. Thanks again!
kriswest
changed the title
Co-authored-by: Kris West <kris.west@interop.io>
Co-authored-by: Kris West <kris.west@interop.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your change
Adding golang language binding
@michael-bowen-sc
Related Issue
#1482
Contributor License Agreement
Review Checklist
DesktopAgent,Channel,PrivateChannel,Listener,Bridging)?JSDoc comments on interfaces and types should be matched to the main documentation in /docs
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
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
npm run build) run and the results checked in?Generated code will be found at
/src/api/BrowserTypes.tsand/or/src/bridging/BridgingTypes.tsBaseContextschema applied viaallOf(as it is in existing types)?titleanddescriptionprovided for all properties defined in the schema?npm run build) run and the results checked in?Generated code will be found at
/src/context/ContextTypes.ts