1.2 migration guide and docs updates (#3018)

Co-authored-by: Calvin Cestari <calvincestari@users.noreply.github.com>
apollographql · May 16, 2023 · b51006f · b51006f
1 parent 415f7fe
commit b51006f
Show file tree

Hide file tree

Showing 88 changed files with 9,500 additions and 1,834 deletions.
diff --git a/Sources/ApolloAPI/SchemaConfiguration.swift b/Sources/ApolloAPI/SchemaConfiguration.swift
@@ -24,11 +24,11 @@ public protocol SchemaConfiguration {
   /// [aliased fields](https://spec.graphql.org/draft/#sec-Field-Alias) will be keyed on their
   /// alias name, not the name of the field on the schema type.
   ///
-  /// 3. Because cache key resolution is performed both on raw JSON (from a network response or
-  /// cache hit) and `SelectionSet` model data (when writing to the cache directly), the underlying
-  /// data will have different formats. The `object` parameter of this function is an ``ObjectData``
-  /// struct that wraps the underlying object data. The ``ObjectData`` wrapper is used to normalize
-  /// this data to a consistent format in this context.
+  /// 3. The `object` parameter of this function is an ``ObjectData`` struct that wraps the
+  /// underlying object data. Because cache key resolution is performed both on raw JSON (from a
+  /// network response) and `SelectionSet` model data (when writing to the cache directly),
+  /// the underlying data will have different formats. The ``ObjectData`` wrapper is used to
+  /// normalize this data to a consistent format in this context.
   ///
   /// # See Also
   /// ``CacheKeyInfo``

diff --git a/Sources/ApolloCodegenLib/Templates/SchemaConfigurationTemplate.swift b/Sources/ApolloCodegenLib/Templates/SchemaConfigurationTemplate.swift
@@ -20,7 +20,7 @@ struct SchemaConfigurationTemplate: TemplateRenderer {
     \(accessControlModifier(for: .parent))enum SchemaConfiguration: \
     \(config.ApolloAPITargetName).SchemaConfiguration {
       \(accessControlModifier(for: .member))\
-    static func cacheKeyInfo(for type: Object, object: JSONObject) -> CacheKeyInfo? {
+    static func cacheKeyInfo(for type: Object, object: ObjectData) -> CacheKeyInfo? {
         // Implement this function to configure cache key resolution for your schema types.
         return nil
       }

diff --git a/Tests/ApolloCodegenTests/CodeGeneration/Templates/SchemaConfigurationTemplateTests.swift b/Tests/ApolloCodegenTests/CodeGeneration/Templates/SchemaConfigurationTemplateTests.swift
@@ -60,7 +60,7 @@ class SchemaConfigurationTemplateTests: XCTestCase {
     // given
     let expected = """
     public enum SchemaConfiguration: ApolloAPI.SchemaConfiguration {
-      public static func cacheKeyInfo(for type: Object, object: JSONObject) -> CacheKeyInfo? {
+      public static func cacheKeyInfo(for type: Object, object: ObjectData) -> CacheKeyInfo? {
         // Implement this function to configure cache key resolution for your schema types.
         return nil
       }
@@ -83,7 +83,7 @@ class SchemaConfigurationTemplateTests: XCTestCase {
     // given
     let expected = """
     enum SchemaConfiguration: ApolloAPI.SchemaConfiguration {
-      public static func cacheKeyInfo(for type: Object, object: JSONObject) -> CacheKeyInfo? {
+      public static func cacheKeyInfo(for type: Object, object: ObjectData) -> CacheKeyInfo? {
         // Implement this function to configure cache key resolution for your schema types.
         return nil
       }
@@ -104,7 +104,7 @@ class SchemaConfigurationTemplateTests: XCTestCase {
     // given
     let expected = """
     enum SchemaConfiguration: ApolloAPI.SchemaConfiguration {
-      static func cacheKeyInfo(for type: Object, object: JSONObject) -> CacheKeyInfo? {
+      static func cacheKeyInfo(for type: Object, object: ObjectData) -> CacheKeyInfo? {
         // Implement this function to configure cache key resolution for your schema types.
         return nil
       }
@@ -125,7 +125,7 @@ class SchemaConfigurationTemplateTests: XCTestCase {
     // given
     let expected = """
     enum SchemaConfiguration: Apollo.SchemaConfiguration {
-      static func cacheKeyInfo(for type: Object, object: JSONObject) -> CacheKeyInfo? {
+      static func cacheKeyInfo(for type: Object, object: ObjectData) -> CacheKeyInfo? {
         // Implement this function to configure cache key resolution for your schema types.
         return nil
       }

diff --git a/...apolloclientprotocol/fetch(query:cachepolicy:contextidentifier:queue:resulthandler:).json b/...apolloclientprotocol/fetch(query:cachepolicy:contextidentifier:queue:resulthandler:).json
diff --git a/...llo/apolloclientprotocol/perform(mutation:publishresulttostore:queue:resulthandler:).json b/...llo/apolloclientprotocol/perform(mutation:publishresulttostore:queue:resulthandler:).json
diff --git a/...cumentation/apollo/apolloclientprotocol/subscribe(subscription:queue:resulthandler:).json b/...cumentation/apollo/apolloclientprotocol/subscribe(subscription:queue:resulthandler:).json
diff --git a/...cumentation/apollo/apolloclientprotocol/upload(operation:files:queue:resulthandler:).json b/...cumentation/apollo/apolloclientprotocol/upload(operation:files:queue:resulthandler:).json
diff --git a/...on/apollo/apolloclientprotocol/watch(query:cachepolicy:callbackqueue:resulthandler:).json b/...on/apollo/apolloclientprotocol/watch(query:cachepolicy:callbackqueue:resulthandler:).json
diff --git a/docs/docc/Apollo.doccarchive/data/documentation/apollo/atomic/mutate(block:).json b/docs/docc/Apollo.doccarchive/data/documentation/apollo/atomic/mutate(block:).json