Add filterByOperationId command option #636

MaggieKimani1 · 2021-10-20T07:12:15Z

This PR proposes adding a filterByOperationId parameter to the Commandline tool by:

Adding a --filterByOperationId command option to the transform command
Adding an OpenApiFilterService that slices an OpenApiDocument based on the operation Ids provided
Adding tests for the filtering service

Testing Instructions

Build the project and its dependencies by running the .\build.cmd file
Install the openapi-parser tool locally by running the .\install-tool.ps1 script
Invoke the tool by running the .\artifacts\openapi-parser.exe file and call the transform command
To use the new command option, append the --filterByOperationId "operationId" parameter to the transform command

E.g: .\artifacts\openapi-parser.exe transform --input People.yml --format yaml --output People2.yml --version OpenApi3_0 --filterByOperationId users_UpdateInsights

Fixes #631

…ed on OperationId

… results

…ubset doc

src/Microsoft.OpenApi/Microsoft.OpenApi.csproj

This reverts commit 43f48ec.

src/Microsoft.OpenApi/Services/OpenApiFilterService.cs

src/Microsoft.OpenApi.Tool/OpenApiService.cs

irvinesunday · 2021-11-02T08:36:41Z

src/Microsoft.OpenApi.Tool/OpenApiService.cs

            var stream = GetStream(input);

            OpenApiDocument document;



Defensive programming for the params?

The version and format params have default values, so they can't equate to null at any point.
operationIds is nullable since its an optional filtering parameter.

src/Microsoft.OpenApi.Tool/OpenApiService.cs

src/Microsoft.OpenApi/Services/CopyReferences.cs

…o mk/add-filter-commandOption

MaggieKimani1 added 16 commits October 12, 2021 12:21

Add a mock OpenApiDocument

0dc267c

Add tests for filtering validation

0ecca08

Add an OpenApi filtering service for filtering an OpenApiDocument bas…

2f4a1c8

…ed on OperationId

Add necessary packages

8e45f8b

Simplify using statement and switch condition

f270b90

Use static class reference

9cda4fb

Add --filterbyOperationId command option

af61c14

Add filterByOperationId param and logic

d24442d

Add static modifier

501e88c

Clean up and add xml comments

d5b1b5e

Add a class that visits the OpenApi operations and returns the search…

4016ba1

… results

Add a search result object model

73bef22

Copies OpenApiOperation references to the new subset document

a1d46e5

Copy OpenApiInfo and components from the source document to the new s…

b3c79eb

…ubset doc

Add an info object to the mock document

cd5f3fa

Clean up: Remove unnecessary params

3c43ea1

MaggieKimani1 requested a review from darrelmiller October 20, 2021 07:12

darrelmiller reviewed Oct 21, 2021

View reviewed changes

src/Microsoft.OpenApi/Microsoft.OpenApi.csproj Outdated Show resolved Hide resolved

Remove package reference

43f48ec

MaggieKimani1 requested a review from irvinesunday October 25, 2021 14:16

MaggieKimani1 added 5 commits October 26, 2021 16:49

Revert "Remove package reference"

8ba33cd

This reverts commit 43f48ec.

Update the Public API interface text file

2397e9d

Remove unnecessary package dependency

d13dcf4

Allow filtering for multiple operationIds

00dd9c4

Add check for writing to an already existing file

3f3dae0

darrelmiller reviewed Nov 2, 2021

View reviewed changes

src/Microsoft.OpenApi/Services/OpenApiFilterService.cs Show resolved Hide resolved

Copy over all Info properties

27ab7f7