From 8cf47516c1843e6ed07785aa5b766efe2e7aa361 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Thu, 29 Aug 2024 20:14:10 +0300 Subject: [PATCH] docs: use new x-sidebar-summary for sidebar items in api-reference if available (#8865) Use the new `x-sidebar-summary` OAS attribute when adding operations to the sidebar, if available. --- www/apps/api-reference/types/openapi.ts | 1 + www/apps/api-reference/utils/get-tag-child-sidebar-items.tsx | 5 ++++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/www/apps/api-reference/types/openapi.ts b/www/apps/api-reference/types/openapi.ts index f2804b3987..babfcf6801 100644 --- a/www/apps/api-reference/types/openapi.ts +++ b/www/apps/api-reference/types/openapi.ts @@ -19,6 +19,7 @@ export type Operation = OpenAPIV3.OperationObject<{ parameters: Parameter[] "x-featureFlag"?: string "x-workflow"?: string + "x-sidebar-summary"?: string }> export type RequestObject = OpenAPIV3.RequestBodyObject & { diff --git a/www/apps/api-reference/utils/get-tag-child-sidebar-items.tsx b/www/apps/api-reference/utils/get-tag-child-sidebar-items.tsx index b19f7570d5..5cbdebc1a0 100644 --- a/www/apps/api-reference/utils/get-tag-child-sidebar-items.tsx +++ b/www/apps/api-reference/utils/get-tag-child-sidebar-items.tsx @@ -23,7 +23,10 @@ export default function getTagChildSidebarItems( ...(definedOperation.tags || []), definedOperation.operationId, ]), - title: definedOperation.summary || definedOperation.operationId, + title: + definedOperation["x-sidebar-summary"] || + definedOperation.summary || + definedOperation.operationId, additionalElms: ( ),