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

Combined index and search swaggers #10874

Closed
heaths opened this issue Mar 26, 2020 · 5 comments
Closed

Combined index and search swaggers #10874

heaths opened this issue Mar 26, 2020 · 5 comments
Labels
Client This issue points to a problem in the data-plane of the library. Search
Milestone

Comments

@heaths
Copy link
Member

heaths commented Mar 26, 2020

We should combine index and search swaggers, or at least refactor SearchError and any other common types into a referenced shared file. This is causing us to implement workarounds to rename one when generating source.

Setting this tentatively for the Preview 3 release, depending on when Search service plans to GA their currently preview (i.e. we should do this before they GA).

/cc @brjohnstmsft @tg-msft

@heaths heaths added Search Client This issue points to a problem in the data-plane of the library. labels Mar 26, 2020
@heaths heaths added this to the [2020] May milestone Mar 26, 2020
@brjohnstmsft
Copy link
Member

@heaths The Swaggers are pretty big to begin with. Keeping them separate makes maintenance easier.

Also, something to consider is that we may want to have different resources use different API versions at some point (something I believe some other Azure services do). I'm not sure how that fits into the single-file versus multi-file choice, but it's something to keep in mind.

@heaths
Copy link
Member Author

heaths commented Apr 21, 2020

Thanks for the heads up. @tg-msft had brought it up, but if there's no desire to combine them we can close this.

@AlexGhiondea
Copy link
Contributor

Closing this for now.

@tg-msft
Copy link
Member

tg-msft commented Apr 21, 2020

Then we'll need to either see if AutoRest allows multiple remote swaggers now or update https://github.com/Azure/azure-sdk-for-net/blob/master/eng/CodeGeneration.targets to allow multiple AutoRest literate READMEs in one library. We need to remove https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/search/generate.ps1 at some point.

@tg-msft
Copy link
Member

tg-msft commented Apr 21, 2020

(Filed #11478 to track.)

@github-actions github-actions bot locked and limited conversation to collaborators Mar 28, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Client This issue points to a problem in the data-plane of the library. Search
Projects
None yet
Development

No branches or pull requests

4 participants