Skip to content

Conversation

BrocksiNet
Copy link
Contributor

@BrocksiNet BrocksiNet commented Sep 17, 2025

Description

closes: #1715

Type of change

New feature (non-breaking change which adds functionality)

ToDo's

  • Documentation added/updated
  • Unit-Tests added/updated
  • E2E-Tests added/updated
  • Related Issue updated

Copy link

vercel bot commented Sep 17, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Updated (UTC)
frontends-demo Ready Ready Preview Sep 25, 2025 2:23pm
frontends-vue-starter-template Ready Ready Preview Sep 25, 2025 2:23pm
shopware-frontends-docs Ready Ready Preview Sep 25, 2025 2:23pm

@BrocksiNet BrocksiNet changed the title feat: first iteration split command feat: split command Sep 17, 2025
@BrocksiNet BrocksiNet changed the title feat: split command feat: split command for api-gen package Sep 17, 2025
@patzick patzick marked this pull request as ready for review September 25, 2025 14:05
@patzick patzick requested a review from Copilot September 25, 2025 14:05
@BrocksiNet BrocksiNet requested review from patzick and removed request for Copilot September 25, 2025 14:05
@BrocksiNet BrocksiNet self-assigned this Sep 25, 2025
@BrocksiNet BrocksiNet added composables domain/framework For x-team workflows and tracking efforts api-gen and removed composables labels Sep 25, 2025
@patzick patzick requested a review from Copilot September 25, 2025 14:06
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces a new split command for the api-gen package that allows users to split large OpenAPI schemas into smaller files organized by tags or paths. This helps address performance issues when importing large schemas into API clients like Postman or Insomnia.

Key changes:

  • Added a new split command with comprehensive functionality for schema splitting
  • Implemented utilities for schema manipulation and filtering
  • Added comprehensive test coverage for all split command functionality

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
packages/api-gen/src/commands/split.ts Main implementation of the split command with support for tags/paths splitting and filtering
packages/api-gen/src/utils/schemaSplitter.ts Utility functions for schema manipulation, filtering, and component cleanup
packages/api-gen/src/cli.ts CLI command registration with options for split functionality
packages/api-gen/tests/split.test.ts Comprehensive test suite covering all split command scenarios
packages/api-gen/tests/api-types/splitTestSchema.json Test fixture providing OpenAPI schema for testing split functionality
packages/api-gen/README.md Documentation for the new split command with usage examples

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@vercel vercel bot temporarily deployed to Preview – shopware-frontends-docs September 25, 2025 14:09 Inactive
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@vercel vercel bot temporarily deployed to Preview – shopware-frontends-docs September 25, 2025 14:09 Inactive
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@vercel vercel bot temporarily deployed to Preview – shopware-frontends-docs September 25, 2025 14:10 Inactive
@vercel vercel bot temporarily deployed to Preview – shopware-frontends-docs September 25, 2025 14:10 Inactive
Copy link

codspeed-hq bot commented Sep 25, 2025

CodSpeed Performance Report

Merging #2013 will not alter performance

Comparing feat/api-gen-split-command (2ef86de) with main (c77daa6)1

Summary

✅ 8 untouched

Footnotes

  1. No successful run was found on main (79567ad) during the generation of this report, so c77daa6 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

@BrocksiNet
Copy link
Contributor Author

@patzick please tell me when released. Thanks.

@patzick
Copy link
Contributor

patzick commented Sep 26, 2025

I just saw there is no changeset, needs to be added

But you can already use it in canary! Can you confirm it works as expected?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api-gen domain/framework For x-team workflows and tracking efforts

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEATURE] Port ApiSchemaSplitter to api-gen package

2 participants