upgrade versions and docs#58
Merged
Merged
Conversation
harsh-sikhwal
approved these changes
May 25, 2026
ajbalogh
requested changes
May 25, 2026
Collaborator
ajbalogh
left a comment
There was a problem hiding this comment.
Because there is a major version change, this PR summary should also include a comment describing what broke backward compatibility so that implementers can take steps to mitigate
Collaborator
Author
|
@ajbalogh I have addressed your comment. |
ajbalogh
approved these changes
May 26, 2026
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
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.
Bump version to 2.0.0 and expand annotation documentation
Summary
1.1.1to2.0.0acrossapi/info.yaml,artifacts/openapi.yaml, andartifacts/infragraph.protoget_graphrequest schema: renameformattochoice, insertinfragraphas a new return type alongsidenetworkx, and introduce a structuredGraphResponseInfragraphresponse objectannotate_graphdocs to cover the newlinkstarget (in addition to nodes and edges) with a consolidated code example showing all threeserver[0:2]xpu[0:3]) and how it expands to fully qualified dot-separated namesrankandipaddressexamples to explicitly mentionAnnotationobject andattributes.addinfrastructre→infrastructureindocs/src/index.mdBreaking changes (1.1.1 → 2.0.0)
The
get_graphrequest schema changed in PR #52 in a way that is not backward compatible:formatfield renamed tochoice— any client code referencingGetGraphRequest.formatmust be updated toGetGraphRequest.choicenetworkxenum value shifted from1to2— a newinfragraph = 1variant was inserted before it. Clients that were passing the integer1to select networkx will now silently request theinfragraphformat insteadget_graphcan now return aGraphResponseInfragraphobject (infrastructure + annotations) in addition to the previous networkx YAML string; clients that assume a plain YAML string response must be updated to handle the new response shapeImplementers upgrading from
1.1.1should audit allget_graphcall sites, replaceformatwithchoice, and verify the enum value passed matches the intended representation.Annotation API — restructured schema
The
Annotationobject was fully redesigned. The old flatnodes.add(id, name, value)pattern no longer exists: