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

feat(converter): add Reference Object summary and description plugins #3885

Merged
merged 2 commits into from
Mar 5, 2024

Conversation

tekyu
Copy link
Contributor

@tekyu tekyu commented Mar 1, 2024

his plugin removes the summary and description fields of Reference Object.

Refs SWG-10235
Refs #3697

@tekyu tekyu added enhancement New feature or request ApiDOM converter labels Mar 1, 2024
@tekyu tekyu requested a review from char0n March 1, 2024 12:53
@char0n char0n changed the title feat(apidom-converter): add referenceSummaryDescriptionPlugin feat(converter): add referenceSummaryDescriptionPlugin Mar 4, 2024
@char0n
Copy link
Member

char0n commented Mar 4, 2024

@tekyu there is an option to have this plugin divided into two. One plugin that removes summary, one that removes description. The idea is that every plugin just handles one aspect of the the transformation.

In this particular case, we can say that the aspect is to remove the non-supported fields, or we can divide the aspect into two separate ones.

Please let me know what you think.

@tekyu
Copy link
Contributor Author

tekyu commented Mar 4, 2024

@char0n if the idea is to have plugins that handles single operation I don't want to disrupt that with my plugin. I'll split them then

@char0n
Copy link
Member

char0n commented Mar 4, 2024

@tekyu it's your decision, as for this particular one I don't have strong opinion.

@tekyu tekyu force-pushed the feat/reference-summary-description-plugin branch from 9b67ab6 to f942461 Compare March 4, 2024 10:04
@tekyu tekyu changed the title feat(converter): add referenceSummaryDescriptionPlugin feat(converter): add reference summary and description plugins Mar 4, 2024
@tekyu tekyu requested a review from char0n March 4, 2024 11:09
Copy link
Member

@char0n char0n left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two nitpicks related to naming, otherwise LGTM

@char0n char0n changed the title feat(converter): add reference summary and description plugins feat(converter): add Reference Object summary and description plugins Mar 4, 2024
@tekyu tekyu force-pushed the feat/reference-summary-description-plugin branch from f942461 to 9f14db7 Compare March 4, 2024 12:16
@char0n
Copy link
Member

char0n commented Mar 4, 2024

@tekyu plese use Squash + merge github feature described in #3848 (comment)

Please also use commit message format described in: #3848 (comment)

@tekyu tekyu merged commit 3246c9f into main Mar 5, 2024
8 checks passed
@tekyu tekyu deleted the feat/reference-summary-description-plugin branch March 5, 2024 07:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants