docs: fix stale API references in relay.md#10105
Open
PHILLIPS71 wants to merge 8 commits into
Open
Conversation
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.
What's wrong
IIdSerializerdoesn't exist anymore. It was removed indf07a9169(#7026, "Added new node id serializer.", April 2024) along withIdSerializer,IdMiddleware, andIdValue, and replaced withINodeIdSerializer.INodeIdSerializeralso has a different shape than the old interface. It'sFormat(string typeName, object internalId), notSerialize(schemaName, typeName, id):src/HotChocolate/Core/src/Types/Types/Relay/Serialization/INodeIdSerializer.cs:6-20The old three-argument
Serialize(null, "Product", productId)call has no direct equivalent,Formatdrops the schema name entirely.While I was in there I checked the rest of the page against source and found three more things that had drifted:
AddQueryFieldToMutationPayloadsgeneratesquery: Query!, notquery: Query. The field is non-null:src/HotChocolate/Core/src/Types/Types/Relay/QueryFieldTypeInterceptor.cs:44-49The predicate example called
.Valueon a plain string.MutationPayloadPredicateisFunc<ITypeDefinition, bool>, andNameonITypeDefinitionis just astring. The framework's own default predicate shows the right usage:src/HotChocolate/Core/src/Types/Types/Relay/MutationPayloadOptions.cs:17-18The
NodeIdValueSerializersource generator doesn't fire automatically. The doc implied it kicks in whenever you use[ID]on a custom type. It actually only triggers on an explicit call toAddNodeIdValueSerializerFrom<T>():src/HotChocolate/Core/src/Types.Analyzers/Inspectors/NodeIdValueSerializerInspector.cs:19-29