feat: use propertyAccess for conditional rendering of request/response bodies

packages/fern-docs/bundle/src/components/api-reference/endpoints/EndpointContentLeft.tsx

@@ -9,6 +9,7 @@ import { MdxServerComponentProseSuspense } from "@/mdx/components/server-compone
 import { ObjectProperty } from "../type-definitions/ObjectProperty";
 import {
   TypeDefinitionAnchorPart,
+  TypeDefinitionRequest,
   TypeDefinitionResponse,
 } from "../type-definitions/TypeDefinitionContext";
 import { WithSeparator } from "../type-definitions/TypeDefinitionDetails";
@@ -62,6 +63,7 @@ export async function EndpointContentLeft({
           hidden: false,
           valueShape: stringShape,
           availability: undefined,
+          propertyAccess: undefined,
         };
       },
       bearerAuth: (bearerAuth) => {
@@ -73,6 +75,7 @@ export async function EndpointContentLeft({
           hidden: false,
           valueShape: stringShape,
           availability: undefined,
+          propertyAccess: undefined,
         };
       },
       header: (value) => {
@@ -85,6 +88,7 @@ export async function EndpointContentLeft({
           hidden: false,
           valueShape: stringShape,
           availability: undefined,
+          propertyAccess: undefined,
         };
       },
       oAuth: (value) => {
@@ -104,6 +108,7 @@ export async function EndpointContentLeft({
                 hidden: false,
                 valueShape: stringShape,
                 availability: undefined,
+                propertyAccess: undefined,
               }),
             }),
         });
@@ -188,27 +193,29 @@ export async function EndpointContentLeft({
           </TypeDefinitionAnchorPart>
         )}
         {endpoint.requests?.[0] != null && (
-          <EndpointSection
-            title="Request"
-            description={
-              <MdxServerComponentProseSuspense
-                size="sm"
-                className="text-(color:--grayscale-a11)"
-                mdx={endpoint.requests[0].description}
-                fallback={createEndpointRequestDescriptionFallback(
-                  endpoint.requests[0],
-                  types
-                )}
-              />
-            }
-          >
-            <TypeDefinitionAnchorPart part="body">
-              <EndpointRequestSection
-                request={endpoint.requests[0]}
-                types={types}
-              />
-            </TypeDefinitionAnchorPart>
-          </EndpointSection>
+          <TypeDefinitionRequest>
+            <EndpointSection
+              title="Request"
+              description={
+                <MdxServerComponentProseSuspense
+                  size="sm"
+                  className="text-(color:--grayscale-a11)"
+                  mdx={endpoint.requests[0].description}
+                  fallback={createEndpointRequestDescriptionFallback(
+                    endpoint.requests[0],
+                    types
+                  )}
+                />
+              }
+            >
+              <TypeDefinitionAnchorPart part="body">
+                <EndpointRequestSection
+                  request={endpoint.requests[0]}
+                  types={types}
+                />
+              </TypeDefinitionAnchorPart>
+            </EndpointSection>
+          </TypeDefinitionRequest>
         )}
       </TypeDefinitionAnchorPart>
       <TypeDefinitionResponse>

packages/fern-docs/bundle/src/components/api-reference/type-definitions/FilteredObjectProperties.tsx

@@ -0,0 +1,44 @@
+"use client";
+
+import { ApiDefinition } from "@fern-api/fdr-sdk";
+
+import { FernCollapseWithButtonUncontrolled } from "./FernCollapseWithButtonUncontrolled";
+import { ObjectProperty } from "./ObjectProperty";
+import {
+  TypeDefinitionPathPart,
+  shouldIncludeObjectProperty,
+  useTypeDefinitionContext,
+} from "./TypeDefinitionContext";
+import { WithSeparator } from "./TypeDefinitionDetails";
+
+export function FilteredObjectProperties({
+  properties,
+  types,
+}: {
+  properties: ApiDefinition.ObjectProperty[];
+  types: Record<ApiDefinition.TypeId, ApiDefinition.TypeDefinition>;
+}) {
+  const { isRequest, isResponse } = useTypeDefinitionContext();
+
+  const filteredProperties = properties.filter((property) => {
+    return shouldIncludeObjectProperty(property, isRequest, isResponse);
+  });
+
+  return (
+    <FernCollapseWithButtonUncontrolled
+      showText={`Show ${filteredProperties.length} properties`}
+      hideText={`Hide ${filteredProperties.length} properties`}
+    >
+      <WithSeparator>
+        {filteredProperties.map((property) => (
+          <TypeDefinitionPathPart
+            key={property.key}
+            part={{ type: "objectProperty", propertyName: property.key }}
+          >
+            <ObjectProperty property={property} types={types} />
+          </TypeDefinitionPathPart>
+        ))}
+      </WithSeparator>
+    </FernCollapseWithButtonUncontrolled>
+  );
+}

packages/fern-docs/bundle/src/components/api-reference/type-definitions/InternalTypeDefinition.tsx

@@ -8,8 +8,7 @@ import { DiscriminatedUnionVariant } from "./DiscriminatedUnionVariant";
 import { EnumTypeDefinition } from "./EnumTypeDefinition";
 import { EnumValue } from "./EnumValue";
 import { FernCollapseWithButtonUncontrolled } from "./FernCollapseWithButtonUncontrolled";
-import { ObjectProperty } from "./ObjectProperty";
-import { TypeDefinitionPathPart } from "./TypeDefinitionContext";
+import { FilteredObjectProperties } from "./FilteredObjectProperties";
 import { WithSeparator } from "./TypeDefinitionDetails";
 import { UndiscriminatedUnionVariant } from "./UndiscriminatedUnionVariant";
 
@@ -84,23 +83,8 @@ export const InternalTypeDefinition = memo(function InternalTypeDefinition({
         shape,
         types
       ).properties;
-      return (
-        <FernCollapseWithButtonUncontrolled
-          showText={`Show ${properties.length} properties`}
-          hideText={`Hide ${properties.length} properties`}
-        >
-          <WithSeparator>
-            {properties.map((property) => (
-              <TypeDefinitionPathPart
-                key={property.key}
-                part={{ type: "objectProperty", propertyName: property.key }}
-              >
-                <ObjectProperty property={property} types={types} />
-              </TypeDefinitionPathPart>
-            ))}
-          </WithSeparator>
-        </FernCollapseWithButtonUncontrolled>
-      );
+
+      return <FilteredObjectProperties properties={properties} types={types} />;
     }
     case "primitive":
       return null;

packages/fern-docs/bundle/src/components/api-reference/type-definitions/TypeDefinitionContext.tsx

@@ -3,6 +3,7 @@
 import { createContext, useContext, useMemo } from "react";
 import React from "react";
 
+import { ApiDefinition } from "@fern-api/fdr-sdk";
 import { TypeDefinition } from "@fern-api/fdr-sdk/api-definition";
 import { slugToHref } from "@fern-docs/utils";
 import { useLazyRef } from "@fern-ui/react-commons";
@@ -14,11 +15,12 @@ import { useCurrentPathname } from "@/hooks/use-current-pathname";
 import { JsonPropertyPath } from "../examples/JsonPropertyPath";
 import { JsonPropertyPathPart } from "../examples/JsonPropertyPath";
 
-interface TypeDefinitionContextValue {
+export interface TypeDefinitionContextValue {
   types: Record<string, TypeDefinition>;
   isRootTypeDefinition: boolean;
   jsonPropertyPath: JsonPropertyPath;
   isResponse: boolean | undefined;
+  isRequest: boolean | undefined;
   slug: string;
   anchorIdParts: readonly string[];
   collapsible: boolean;
@@ -47,6 +49,7 @@ export function TypeDefinitionRoot({
     isRootTypeDefinition: true,
     jsonPropertyPath: [],
     isResponse: undefined,
+    isRequest: undefined,
     types,
     slug,
     anchorIdParts: [],
@@ -124,6 +127,24 @@ export function TypeDefinitionResponse({
   );
 }
 
+export function TypeDefinitionRequest({
+  children,
+}: {
+  children: React.ReactNode;
+}) {
+  const parent = useTypeDefinitionContext();
+  const contextValue = React.useRef(() => ({
+    ...parent,
+    isRequest: true,
+  }));
+
+  return (
+    <TypeDefinitionContext.Provider value={contextValue.current}>
+      {children}
+    </TypeDefinitionContext.Provider>
+  );
+}
+
 export function TypeDefinitionCollapsible({
   children,
 }: {
@@ -190,3 +211,13 @@ export function useIsActive(): boolean {
   const href = useHref();
   return currentHref === href;
 }
+
+export function shouldIncludeObjectProperty(
+  property: ApiDefinition.ObjectProperty,
+  isRequest?: boolean,
+  isResponse?: boolean
+) {
+  if (isRequest && property.propertyAccess === "READ_ONLY") return false;
+  if (isResponse && property.propertyAccess === "WRITE_ONLY") return false;
+  return true;
+}