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

Search: Improve swagger documentation #11457

Closed
heaths opened this issue Apr 20, 2020 · 2 comments
Closed

Search: Improve swagger documentation #11457

heaths opened this issue Apr 20, 2020 · 2 comments
Assignees
Labels
Client This issue points to a problem in the data-plane of the library. Search Service Attention Workflow: This issue is responsible by Azure service team.
Milestone

Comments

@heaths
Copy link
Member

heaths commented Apr 20, 2020

Since we generate most of the code, there are a lot of descriptions in swagger that need to be improved. They either aren't clear (e.g. almost all enum value description), or just wrong (e.g. PatternAnalyzer.Pattern description says it defaults to whitespace when, actually, it's non-whitespace, i.e. \w+).

This will positively improve all languages' SDKs and means we don't have to override all models (harder for some languages than others, but still a lot of manual work meant to be done by generators).

/cc @brjohnstmsft

@heaths heaths added Search Service Attention Workflow: This issue is responsible by Azure service team. Client This issue points to a problem in the data-plane of the library. labels Apr 20, 2020
@heaths heaths added this to the [2020] June milestone Apr 20, 2020
@ghost
Copy link

ghost commented Apr 20, 2020

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @felixwa, @brjohnstmsft.

@heaths
Copy link
Member Author

heaths commented Apr 20, 2020

We'll track indivudual items in Azure/azure-rest-api-specs, though I think at some point a top-down review would help to improve docs not only for REST APIs, but the client SDK doc comments as well.

@heaths heaths closed this as completed Apr 20, 2020
@brjohnstmsft brjohnstmsft self-assigned this Jun 30, 2020
@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 Service Attention Workflow: This issue is responsible by Azure service team.
Projects
None yet
Development

No branches or pull requests

2 participants