Skip to content

fix(api-reference): don't show "not documented" for filter-only permissions #160

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
anttiviljami merged 1 commit into from
Sep 28, 2026
Merged

fix(api-reference): don't show "not documented" for filter-only permissions #160

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 8 additions & 2 deletions src/utils/openapi-permissions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,16 @@ export const formatPermissions = (permissions: unknown): string | null => {
return null;
}

const filtered = filters.length ? `results filtered by ${filters.join(' and ')}` : '';

if (!requirements.length && filtered) {
// Filter grants document the operation on their own: no grant is required, results are filtered
return `> ${label} ${filtered}`;
}

const required = requirements.length ? requirements.join(' and ') : 'not documented';
const filtered = filters.length ? ` · results filtered by ${filters.join(' and ')}` : '';

return `> ${label} ${required}${filtered}`;
return `> ${label} ${required}${filtered ? ` · ${filtered}` : ''}`;
};

/**
Expand Down
Loading