Sync data connector instructions with sample implementation#6
Open
Wheatley-Labs wants to merge 2 commits intomainfrom
Open
Sync data connector instructions with sample implementation#6Wheatley-Labs wants to merge 2 commits intomainfrom
Wheatley-Labs wants to merge 2 commits intomainfrom
Conversation
### Motivation - Align the written data connector guide with the actual sample connector code so readers can follow the documentation against the repository code without confusion. - Clarify behaviors and artifacts that the sample connector produces (additional node types, message parsing, aliasing, and endpoint calls) that were missing or inconsistent in the original instructions. ### Description - Updated `data-connector/INSTRUCTIONS.md` to reference the correct project name (`TechnicalSupport.DataConnector.csproj`) and to document the additional node types `SupportCaseMessage` and `SupportChatContext` present in `Schema.cs` and used by the sample. - Added the `Status` property to the `SupportCase` schema and documented the creation of `HasMessage`/`MessageOf` edges and the `HasStatus` handling (including the sample call to `graph.UnlinkExcept` before linking the `Status` node). - Made ingestion examples match the sample code by switching the deserialization note to `Newtonsoft.Json`, showing `graph.AddAlias` calls for devices, switching `Node.Key` usages to `Node.FromKey`, and showing how support-case transcripts are parsed into `SupportCaseMessage` nodes. - Clarified run-time requirements by calling out that the sample calls example endpoints after ingestion (so a valid endpoints token is required) and explaining that `TestEndpointsAsync` can be commented out if endpoint calls are not desired, and updated shell query examples to use explicit type/field/edge names (strings) that align with the sample. ### Testing - Automated tests were not run because this is a documentation-only change and no code logic was modified.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Motivation
Description
data-connector/INSTRUCTIONS.mdto reference the correct project name (TechnicalSupport.DataConnector.csproj) and to document the additional node typesSupportCaseMessageandSupportChatContextpresent inSchema.csand used by the sample.Statusproperty to theSupportCaseschema and documented the creation ofHasMessage/MessageOfedges and theHasStatushandling (including the sample call tograph.UnlinkExceptbefore linking theStatusnode).Newtonsoft.Json, showinggraph.AddAliascalls for devices, switchingNode.Keyusages toNode.FromKey, and showing how support-case transcripts are parsed intoSupportCaseMessagenodes.TestEndpointsAsynccan be commented out if endpoint calls are not desired, and updated shell query examples to use explicit type/field/edge names (strings) that align with the sample.Testing
Codex Task