Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: use new x-sidebar-summary for sidebar items in api-reference if available #8865

Merged
merged 2 commits into from
Aug 29, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions www/apps/api-reference/types/openapi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 & {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: (
<MethodLabel method={definedMethod} className="h-fit" />
),
Expand Down
Loading