Skip to content

feat: option to include models tagged with @openapi.ignore in the spec file #2221

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
merged 2 commits into from
Aug 17, 2025
Merged

feat: option to include models tagged with @openapi.ignore in the spec file #2221

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d32424a
feat: option to include @openapi.ignored models in the spec file
lenageorgescu-dsl Aug 12, 2025
0d8c504
refactor: minor readability improvements as suggested by coderabbit
lenageorgescu-dsl Aug 12, 2025
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
9 changes: 8 additions & 1 deletion packages/plugins/openapi/src/generator-base.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,14 @@ export abstract class OpenAPIGeneratorBase {
abstract generate(): PluginResult;

protected get includedModels() {
return getDataModels(this.model).filter((d) => !hasAttribute(d, '@@openapi.ignore'));
const includeApiIgnored = this.getOption<boolean>('includeApiIgnored', false);
if (includeApiIgnored) {
return getDataModels(this.model);
} else {
return getDataModels(this.model).filter(
(d) => !hasAttribute(d, '@@openapi.ignore')
);
}
}

protected wrapArray(
Expand Down