Quick fixes

switchboard-xyz · Jun 10, 2024 · 6321a4f · 6321a4f
1 parent b11cf2a
commit 6321a4f
Show file tree

Hide file tree

Showing 4 changed files with 503 additions and 298 deletions.
diff --git a/plugins/docusaurus-plugin-api-docs/src/components/ProtoFile.tsx b/plugins/docusaurus-plugin-api-docs/src/components/ProtoFile.tsx
@@ -1,5 +1,6 @@
-import React from "react";
 import Link from "@docusaurus/Link";
+import React from "react";
+
 import {
   type Enum,
   type FileDescriptor,

diff --git a/plugins/docusaurus-plugin-api-docs/src/components/ProtoPage.tsx b/plugins/docusaurus-plugin-api-docs/src/components/ProtoPage.tsx
@@ -12,6 +12,10 @@ export interface ProtoPageProps extends Pick<DocItemProps, "route"> {}
 export default function ProtoPage({ route }: ProtoPageProps) {
   const id = (route as unknown as { id: string }).id;
   const message = useProto(id)!;
+  const showDescription = message?.name !== "Task";
+  const fields = message.fields.sort((a, b) =>
+    a.name.toLowerCase().localeCompare(b.name.toLowerCase())
+  );
 
   return (
     <ApiItemLayout
@@ -39,7 +43,7 @@ export default function ProtoPage({ route }: ProtoPageProps) {
 
         <h2>Fields</h2>
 
-        {message.fields.length === 0 ? (
+        {fields.length === 0 ? (
           <p>{message.name} has no fields.</p>
         ) : (
           <div id="fields">
@@ -48,11 +52,11 @@ export default function ProtoPage({ route }: ProtoPageProps) {
                 <tr>
                   <th>Name</th>
                   <th>Type</th>
-                  <th>Description</th>
+                  {showDescription && <th>Description</th>}
                 </tr>
               </thead>
               <tbody>
-                {message.fields.map((field, index) => (
+                {fields.map((field, index) => (
                   <tr key={index}>
                     <td>
                       <i
@@ -68,9 +72,11 @@ export default function ProtoPage({ route }: ProtoPageProps) {
                     <td>
                       <Markdown content={field.type} />
                     </td>
-                    <td>
-                      <Markdown content={field.description} />
-                    </td>
+                    {showDescription && (
+                      <td>
+                        <Markdown content={field.description} />
+                      </td>
+                    )}
                   </tr>
                 ))}
               </tbody>

diff --git a/protos/job_schemas.proto b/protos/job_schemas.proto
@@ -1101,6 +1101,12 @@ _**Example**_: SecretsTask
 
   /// Represents a singular operation performed by an oracle to yield an eventual numerical result.
   message Task {
+    // Reserve obsolete task keys / field numbers.
+    reserved 27;
+    reserved "defi_kingdoms_task";
+    reserved 28;
+    reserved "tps_task";
+
     oneof Task {
       HttpTask http_task = 1;
       JsonParseTask json_parse_task = 2;
@@ -1127,7 +1133,6 @@ _**Example**_: SecretsTask
       PerpMarketTask perp_market_task = 24;
       OracleTask oracle_task = 25;
       AnchorFetchTask anchor_fetch_task = 26;
-      // reserved 27, 28;
       SplStakePoolTask spl_stake_pool_task = 29;
       SplTokenParseTask spl_token_parse_task = 30;
       UniswapExchangeRateTask uniswap_exchange_rate_task = 31;