microsoft / botframework-sdk

Bot Framework provides the most comprehensive experience for building conversation applications.
MIT License
7.5k stars 2.44k forks source link

[DCR] Move all Swagger files to single repository and adjust generateClient.cmds #5135

Closed stevengum closed 4 years ago

stevengum commented 5 years ago

Issue

We don't have a single source of truth regarding Swagger files, which can add some friction regenerating the schema and connector libraries.

Proposed change

Per the Autorest team (Azure/autorest#93), Autorest is able to take a URL for the -Input argument.

Component Impact

The swagger/ folders in each v4 SDK need to be updated, the Swagger files should be taken out, and the generateClient.cmd scripts should instead take the Swagger file from this repo (e.g. https://raw.githubusercontent.com/Microsoft/BotBuilder/master/swagger/ConnectorAPI.json), or the BotFramework-Services repo (e.g. https://raw.githubusercontent.com/Microsoft/BotFramework-Services/master/swagger/ConnectorAPI.json).

Customer Impact

N/A

Tracking Status

Dotnet SDK

Javascript SDK

Java SDK

Python SDK

Tools

[dcr]

sgellock commented 5 years ago

Chris, can you us this to track a plan

cleemullins commented 5 years ago

We will be depricating the runtime use of AutoRest in the 4.5 timeframe in order to simplify our tooling chain. This issue will track.

EricDahlvang commented 5 years ago

Each repository should retain a copy of the swagger file that corresponds to the current state of that repo. This will enable quickly determining what has changed, by comparing the repository's copy to the latest.

The source of truth is here now: https://github.com/microsoft/botframework-sdk/blob/master/specs/botframework-protocol/botframework-channel.json

cleemullins commented 5 years ago

I've reached out to @dandriscoll to see if we can get version numbers added to the swagger file. That will let up track "which is which" in a much more explicit way. Pushing this out another release until that's done.

cleemullins commented 4 years ago

Closing, as we no longer generate from swagger files.