api ref

Author: ethanpalm

settings.mdx

@@ -544,47 +544,52 @@ This section contains the full reference for the `docs.json` file.
 ### API Configurations
 
 <ResponseField name="api" type="object">
-  API reference configuration and playground settings
+  API documentation and interactive playground settings.
 
   <Expandable title="Api">
     <ResponseField name="openapi" type="string or array or object">
-      A string or an array of strings of absolute or relative urls pointing to the OpenAPI file(s)
+      OpenAPI specification files for generating API documentation. Can be a single URL/path or an array of URLs/paths.
 
       <Expandable title="Openapi">
         <ResponseField name="source" type="string">
-
+          URL or path to your OpenAPI specification file.
+          
           Minimum length: 1
         </ResponseField>
         <ResponseField name="directory" type="string">
-          no starting slash in the directory
+          Directory to search for OpenAPI files.
+          
+          Do not include a leading slash.
         </ResponseField>
       </Expandable>
     </ResponseField>
      <ResponseField name="asyncapi" type="string or array or object">
-      A string or an array of strings of absolute or relative URLs pointing to the AsyncAPI file(s)
+      AsyncAPI specification files for generating API documentation. Can be a single URL/path or an array of URLs/paths.
 
       <Expandable title="Asyncapi">
         <ResponseField name="source" type="string">
-          The path to the AsyncAPI files.
+          URL or path to your AsyncAPI specification file.
 
           Minimum length: 1
         </ResponseField>
         <ResponseField name="directory" type="string">
-          The directory to search for AsyncAPI files.
+          Directory to search for AsyncAPI files.
+          
+          Do not include a leading slash.
         </ResponseField>
       </Expandable>
     </ResponseField>
     <ResponseField name="params" type="object">
-      Configurations for the API parameters
+      Display settings for API parameters.
 
       <Expandable title="Params">
         <ResponseField name="expanded" type="&quot;all&quot; | &quot;closed&quot;">
-          The view mode of expandable API parameters. Defaults to `closed`.
+          Whether to expand all parameters by default. Defaults to `closed`.
         </ResponseField>
       </Expandable>
     </ResponseField>
     <ResponseField name="playground" type="object">
-      Configurations for the API playground
+      API playground settings.
 
       <Expandable title="Playground">
         <ResponseField name="display" type="&quot;interactive&quot; | &quot;simple&quot; | &quot;none&quot;">
@@ -596,35 +601,35 @@ This section contains the full reference for the `docs.json` file.
       </Expandable>
     </ResponseField>
     <ResponseField name="examples" type="object">
-      Configurations for the autogenerated API examples
+      Configurations for the autogenerated API examples.
 
       <Expandable title="Examples">
         <ResponseField name="languages" type="array of string">
           Example languages for the autogenerated API snippets
         </ResponseField>
          <ResponseField name="defaults" type="&quot;required&quot; | &quot;all&quot;">
-          Whether to show optional parameters in api examples, defaults to `all`
+          Whether to show optional parameters in API examples. Defaults to `all`.
         </ResponseField>
       </Expandable>
     </ResponseField>
     <ResponseField name="mdx" type="object">
-      Configurations for API pages generated from MDX files
+      Configurations for API pages generated from `MDX` files.
 
       <Expandable title="Mdx">
         <ResponseField name="auth" type="object">
-          Authentication configuration for the API
+          Authentication configuration for MDX-based API requests.
 
           <Expandable title="Auth">
             <ResponseField name="method" type="&quot;bearer&quot; | &quot;basic&quot; | &quot;key&quot; | &quot;cobo&quot;">
-              Authentication method for the API
+              Authentication method for API requests.
             </ResponseField>
             <ResponseField name="name" type="string">
-              Authentication name for the API
+              Authentication name for API requests.
             </ResponseField>
           </Expandable>
         </ResponseField>
         <ResponseField name="server" type="string or array">
-          The server configuration for the API.
+          Server configuration for API requests.
         </ResponseField>
       </Expandable>
     </ResponseField>