feat: add configuration to always show message examples (#1016)

asyncapi · Jul 3, 2024 · 282829f · 282829f
1 parent 482464d
commit 282829f
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 1 deletion.
diff --git a/docs/configuration/config-modification.md b/docs/configuration/config-modification.md
@@ -17,6 +17,7 @@ interface ConfigInterface {
     servers?: boolean;
     operations?: boolean;
     messages?: boolean;
+    messageExamples?: boolean;
     schemas?: boolean;
     errors?: boolean;
   };
@@ -45,7 +46,10 @@ interface ConfigInterface {
 - **show?: Partial<ShowConfig>**
 
   This field contains configuration responsible for rendering specific parts of the AsyncAPI component.
-  All except the `sidebar` fields are set to `true` by default.
+  The `sidebar` and `messageExamples` fields are set to `false` by default. The default for all other fields is `true`.
+
+  The examples for messages shown within an operation are always displayed. To also show examples for the
+  standalone messages in the "Messages" section, set `messageExamples` to `true`.
 
 - **sidebar?: Partial<SideBarConfig>**
 

diff --git a/library/src/config/config.ts b/library/src/config/config.ts
@@ -19,6 +19,7 @@ export interface ShowConfig {
   servers?: boolean;
   operations?: boolean;
   messages?: boolean;
+  messageExamples?: boolean;
   schemas?: boolean;
   errors?: boolean;
 }

diff --git a/library/src/config/default.ts b/library/src/config/default.ts
@@ -16,6 +16,7 @@ export const defaultConfig: ConfigInterface = {
     servers: true,
     operations: true,
     messages: true,
+    messageExamples: false,
     schemas: true,
     errors: true,
   },

diff --git a/library/src/containers/Messages/Messages.tsx b/library/src/containers/Messages/Messages.tsx
@@ -36,6 +36,7 @@ export const Messages: React.FunctionComponent = () => {
               message={message}
               index={idx + 1}
               key={message.id()}
+              showExamples={config?.show?.messageExamples ?? false}
             />
           </li>
         ))}