Update Relay Config Documentation Clarity

Reviewed By: nijiaju

Differential Revision: D90402329

fbshipit-source-id: 9236f06d98e5b4ce46beaacf6bb4dcd827cc7e88

Author: captbaritone

compiler/crates/relay-compiler/relay-compiler-config-schema.json

@@ -306,7 +306,7 @@
       ]
     },
     "ConnectionInterface": {
-      "description": "Configuration where Relay should expect some fields in the schema.",
+      "description": "Configuration where Relay should expect some fields in the schema.\n\n**Important**: When you configure this option in the compiler, you must also configure\nthe Relay runtime to match by calling `ConnectionInterface.inject()` with the same values.\nSee: <https://relay.dev/docs/api-reference/runtime-config/#connectioninterface>",
       "type": "object",
       "properties": {
         "cursor": {
@@ -1250,6 +1250,7 @@
       "type": "object",
       "properties": {
         "connectionInterface": {
+          "description": "Configuration for connection field names in the schema.\n\n**Important**: When you configure this option in the compiler, you must also configure\nthe Relay runtime to match by calling `ConnectionInterface.inject()` with the same values.\nSee: <https://relay.dev/docs/api-reference/runtime-config/#connectioninterface>",
           "$ref": "#/$defs/ConnectionInterface",
           "default": {
             "cursor": "cursor",

compiler/crates/relay-config/src/connection_interface.rs

@@ -12,6 +12,10 @@ use serde::Deserialize;
 use serde::Serialize;
 
 /// Configuration where Relay should expect some fields in the schema.
+///
+/// **Important**: When you configure this option in the compiler, you must also configure
+/// the Relay runtime to match by calling `ConnectionInterface.inject()` with the same values.
+/// See: <https://relay.dev/docs/api-reference/runtime-config/#connectioninterface>
 #[derive(Debug, Serialize, Deserialize, JsonSchema)]
 #[serde(deny_unknown_fields, rename_all = "camelCase")]
 pub struct ConnectionInterface {

compiler/crates/relay-config/src/project_config.rs

@@ -193,6 +193,11 @@ impl Debug for ExtraArtifactsConfig {
 #[derive(Debug, Serialize, Deserialize, JsonSchema)]
 #[serde(rename_all = "camelCase")]
 pub struct SchemaConfig {
+    /// Configuration for connection field names in the schema.
+    ///
+    /// **Important**: When you configure this option in the compiler, you must also configure
+    /// the Relay runtime to match by calling `ConnectionInterface.inject()` with the same values.
+    /// See: <https://relay.dev/docs/api-reference/runtime-config/#connectioninterface>
     #[serde(default)]
     pub connection_interface: ConnectionInterface,