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

As a developer, I want to have a sliced OpenAPI document with only the endpoints and components used by my solution when generating a plugin #4672

Closed
maisarissi opened this issue May 16, 2024 · 2 comments · Fixed by #4748
Assignees
Labels
type:feature New experience request
Milestone

Comments

@maisarissi
Copy link
Contributor

maisarissi commented May 16, 2024

Is your feature request related to a problem? Please describe the problem.

Kiota produces large OpenAPI documents even when only one endpoint is selected because it doesn’t remove unused components.

Client library/SDK language

None

Describe the solution you'd like

When generating plugin and clients, Kiota should be able to trim unused components from the original OpenAPI document to generate a clean sliced OpenAPI document with only the information that is important for my solution.

For clients:

  • Remove all unused components and keep all used components including schemas, parameters, responses.
  • Remove all extensions (starts with x-) that don't match with our internal documentation of supported extensions in Kiota.

For plugins:

  • Removes all unused components and keep only schemas and parameter of used components. For plugins we should also remove any responses components as this won't be used by orchestrators and can increase the size of the OpenAPI document.
  • Remove all extensions (starts with x-) that don't match with our internal documentation of supported extensions in Kiota.

Additional context

No response

@maisarissi maisarissi added status:waiting-for-triage An issue that is yet to be reviewed or assigned type:feature New experience request labels May 16, 2024
@github-project-automation github-project-automation bot moved this to Needs Triage 🔍 in Kiota May 16, 2024
@baywet baywet added this to the Backlog milestone May 16, 2024
@sebastienlevert sebastienlevert moved this from Needs Triage 🔍 to Todo 📃 in Kiota May 16, 2024
@andrueastman andrueastman removed the status:waiting-for-triage An issue that is yet to be reviewed or assigned label May 21, 2024
@maisarissi maisarissi modified the milestones: Backlog, Kiota v1.15 May 23, 2024
@andrueastman andrueastman self-assigned this May 27, 2024
@andrueastman
Copy link
Member

Just to confirm here, @maisarissi
Is the desired openApi document the document the document in the .kiota folder (especially for client generation)?
Does this mean that for plugin generation, the document in the plugin output folder should now match the one in the .kiota folder?

@andrueastman andrueastman changed the title As a developer, I want to have a sliced OpenAPI document with only the endpoints and components used by my solution As a developer, I want to have a sliced OpenAPI document with only the endpoints and components used by my solution when generating a plugin Jun 4, 2024
@andrueastman
Copy link
Member

Limiting the scope of the issue to plugin generation that has an output yaml that will be trimmed via generation at #4748

With regards to client generation, open questions above with regards to handling of .kiota folder documents will be addressed via client generation issue at #4770

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:feature New experience request
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants