Skip to content

feat(api): derive reference title and slug from summary #18322

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.

Sign up for GitHub

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

Merged
betegon merged 6 commits into from
Jun 10, 2026
Merged

feat(api): derive reference title and slug from summary #18322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a7092aa
feat(api): derive reference title and slug from summary
betegon Jun 9, 2026
4bba8fb
Merge branch 'master' into api/operation-id-summary-title
betegon Jun 9, 2026
3de606b
ref(api): drop verbose comment, let code self-document
betegon Jun 9, 2026
1ad919d
Merge branch 'master' into api/operation-id-summary-title
betegon Jun 9, 2026
cc4ae04
fix(api): detect deprecation from operationId and summary independently
betegon Jun 9, 2026
0c9ac49
fix(api): strip deprecated prefix from stored summary too
betegon Jun 9, 2026
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
17 changes: 12 additions & 5 deletions src/build/resolveOpenAPI.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,13 @@ async function apiCategoriesUncached(): Promise<APICategory[]> {

Object.entries(data.paths).forEach(([apiPath, methods]) => {
Object.entries(methods).forEach(([method, apiData]) => {
Comment thread
sentry[bot] marked this conversation as resolved.
const isDeprecated = isDeprecatedOperationId(apiData.operationId);
const cleanOperationId = stripDeprecatedPrefix(apiData.operationId ?? '');
// Detect deprecation from either field independently — the (DEPRECATED)
// marker may sit on operationId even when a summary is present.
const isDeprecated =
isDeprecatedOperationId(apiData.operationId) ||
isDeprecatedOperationId(apiData.summary);
const titleSource = apiData.summary || apiData.operationId || '';
const cleanName = stripDeprecatedPrefix(titleSource);

let server = 'https://sentry.io';
if (apiData.servers && apiData.servers[0]) {
Expand All @@ -141,11 +146,13 @@ async function apiCategoriesUncached(): Promise<APICategory[]> {
categoryMap[tag].apis.push({
apiPath,
method,
name: cleanOperationId,
name: cleanName,
deprecated: isDeprecated,
server,
slug: slugify(cleanOperationId),
summary: apiData.summary,
slug: slugify(cleanName),
summary: apiData.summary
? stripDeprecatedPrefix(apiData.summary)
: apiData.summary,
descriptionMarkdown: apiData.description,
pathParameters: (apiData.parameters || []).filter(
p => p.in === 'path'
Expand Down
2 changes: 1 addition & 1 deletion src/components/apiPage/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ export function ApiPage({api}: Props) {
</div>
<div className="flex flex-col md:flex-row gap-4">
<div className="w-full md:w-1/2">
{api.summary && <p>{api.summary}</p>}
{api.summary && api.summary !== api.name && <p>{api.summary}</p>}

{api.descriptionMarkdown && parseMarkdown(api.descriptionMarkdown)}
Comment thread
sentry[bot] marked this conversation as resolved.

Expand Down
Loading