[v2] Interceptor/RequestChain inline documentation #754
+428
−104
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
✅ Docs preview has no changesThe preview was not built because there were no changes. Build ID: 16ae1d3eb9d65b561ca95e23 |
BobaFetters
approved these changes
Sep 12, 2025
apollo-ios/Sources/Apollo/Interceptors/GraphQLInterceptor.swift
Outdated
Show resolved
Hide resolved
apollo-ios/Sources/Apollo/Interceptors/GraphQLInterceptor.swift
Outdated
Show resolved
Hide resolved
apollo-ios/Sources/Apollo/Interceptors/GraphQLInterceptor.swift
Outdated
Show resolved
Hide resolved
apollo-ios/Sources/Apollo/Interceptors/GraphQLInterceptor.swift
Outdated
Show resolved
Hide resolved
| /// Manages a chain of steps taken to execute a ``GraphQLRequest``. ``RequestChain`` enables customization of each step | ||
| /// of a request by injection of ``Interceptors``. | ||
| /// | ||
| /// ## Configuration via Interceptors |
There was a problem hiding this comment.
I'm unsure whether "configuration" is the correct description here. Feels more like "functionality" vs. a configuration.
There was a problem hiding this comment.
Changing this and the lines below it. Let me know if that feels better.
apollo-ios/Sources/Apollo/ResponseParsing/JSONResponseParser.swift
Outdated
Show resolved
Hide resolved
apollo-ios/Sources/Apollo/ResponseParsing/JSONResponseParser.swift
Outdated
Show resolved
Hide resolved
apollo-ios/Sources/Apollo/ResponseParsing/JSONResponseParser.swift
Outdated
Show resolved
Hide resolved
apollo-ios/Sources/Apollo/ResponseParsing/JSONResponseParser.swift
Outdated
Show resolved
Hide resolved
calvincestari
approved these changes
Sep 12, 2025
| public struct RequestChain<Request: GraphQLRequest>: Sendable { | ||
|
|
||
| /// An error that can be thrown by component of a ``RequestChain`` to indicate that the request should be retried. |
There was a problem hiding this comment.
Suggested change
| /// An error that can be thrown by component of a ``RequestChain`` to indicate that the request should be retried. | |
| /// An error that can be thrown by a component of a ``RequestChain`` to indicate that the request should be retried. |
| /// as the initial request. This means that interceptors will retain their state between retries of the same request. | ||
| /// | ||
| /// ## Retry Loop Prevention | ||
| /// If an interceptor throws a ``Retry`` error again on the retried request, it will continue retry the request again. |
There was a problem hiding this comment.
it will continue retry the request again
I'm not sure how the sentence should read here; "continually retry"?
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.
This PR adds extensive inline documentation to the
RequestChain,JSONResponse Parser, and all Interceptor relatedpublictypes.The inline documentation includes detailed descriptions of how interceptors should be implemented and how data flows through the
RequestChain.A future PR will add usage guides to the docs website with more step-by-step instructions on creating a custom
RequestChainand examples of a number of possible interceptor implementations.