Skip to content

Conversation

@MaggieKimani1
Copy link
Contributor

@MaggieKimani1 MaggieKimani1 commented Nov 2, 2021

This PR:

  • Updates the current build.yml file with an additional build task for packaging the OpenApi.Tool, a commandline tool that enables processing of OpenAPI documents through validation, supports conversion for different file formats e.g from json to yaml and vice versa, and also supports filtering/slicing of OpenApi documents into smaller subset documents based on OperationIds and tags provided.
  • This tool will then be published to Nuget as a package and leveraged across multiple projects such as DevX API, Kiota, Powershell, GE autocomplete etc

Fixes #630

- task: MSBuild@1
displayName: 'Pack OpenAPI.Tool'
inputs:
solution: src/Microsoft.OpenApi.Tool/Microsoft.OpenApi.Tool.csproj
Copy link
Member

Choose a reason for hiding this comment

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

The NuGet package will be named Microsoft.OpenApi.Tool. Is there a more specific name for this tool?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

From my conversation with @darrelmiller, we're still brainstorming whether to retain it as is or find a more descriptive name for the tool.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe OpenApiCli.Tool @darrelmiller ?

Copy link
Member

Choose a reason for hiding this comment

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

I'm very close to being convinced we should call this Microsoft.hidi as hidi is the Swahili word for Convert.

Copy link
Member

Choose a reason for hiding this comment

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

Do either of you foresee this tool with future functionality that does something other than convert and validate? If this is foreseeable, then perhaps we leave it as is.

Copy link
Member

Choose a reason for hiding this comment

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

Yes, it is going to slice. It may also convert from CSDL to OpenAPI. It may in the future be able to apply overlays. I ran the name "hidi" up the chain and we have support from PMs.

Copy link
Member

Choose a reason for hiding this comment

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

So then, Microsoft.OpenApi.Hidi or Microsoft.Hidi? I'm more for the first, but think both are fine.

Copy link
Member

Choose a reason for hiding this comment

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

I was planning the second. However, I have been asked to chat with the marketing folks to make sure they are ok with the hidi and kiota names. I'm going try and do that tomorrow.

Copy link
Member

Choose a reason for hiding this comment

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

We can merge the PR and get approval before we push a release out.

@MaggieKimani1 MaggieKimani1 changed the title Update ci-build.yml for Azure Pipelines Updates ci-build.yml to deploy Commandline tool to Nuget Nov 3, 2021
@MaggieKimani1 MaggieKimani1 merged commit e9f5257 into vnext Nov 9, 2021
@MaggieKimani1 MaggieKimani1 deleted the mk/add-cmdtool-build-task branch November 9, 2021 20:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create deployment pipeline for command line tool

4 participants