deprecate service requestSchema & responseSchema fields

foxglove · Nov 9, 2023 · 209f23e · 209f23e
1 parent d631a7a
commit 209f23e
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/typescript/ws-protocol/src/types.ts b/typescript/ws-protocol/src/types.ts
@@ -54,8 +54,16 @@ export type Service = {
   type: string;
   request?: ServiceRequestDefinition; // Must be given if requestSchema is not given.
   response?: ServiceResponseDefinition; // Must be given if responseSchema is not given.
-  requestSchema?: string; // Must be given if request is not given.
-  responseSchema?: string; // Must be given if response is not given.
+  /**
+   * Must be given if request is not given.
+   * @deprecated Use request instead.
+   */
+  requestSchema?: string;
+  /**
+   * Must be given if response is not given.
+   * @deprecated Use response instead.
+   */
+  responseSchema?: string;
 };
 
 export type Subscribe = {