microsoft / microsoft/OpenAPI.NET

Consolidate slicing to OpenApi.NET lib

Open
#1,468 0 comments 0 reactions 1 assignee View on GitHub

@peombwa is already working on this.

Since Nov 14, 2023.

status:needs-discussion
Dominant language
C#
Stars
1.6k
Forks
286
Avg merge
6h 38m
Merged PRs (30d)
35

Description

Is your feature request related to a problem? Please describe.
To improve the efficiency and consistency of creating subsets by downstream tools, we should look at consolidating slicing functionality into the OpenApi.NET library. The functionality will be used to support dynamic creation of OpenAPI subsets in SK.

Describe the solution you'd like
The library should offer methods on the OpenApiDocument instance that support slicing based on the following OpenAPI constructs:

  • Tags: This functionality is currently available in both Hidi and DevX API.
  • OperationIds: This functionality is also present in Hidi and DevX API.
  • Paths: This functionality is currently implemented in Kiota. We should adopt Kiota's path filtering syntax for this purpose.

Describe alternatives you've considered
While using a predicate works, it is a low-level solution that necessitates defining the same slicing logic in multiple places where we depend on the library. Consolidating the slicing functionality into the OpenApi.NET library would eliminate this redundancy.

Additional context
N/A

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.