-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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: Some Swagger specs are not linter-compliant or complete #1085
Comments
FYI @vishrutshah At this time we have no ETA for the above changes. |
For more information, see Azure/azure-rest-api-specs#1085
As requested by @brjohnstmsft in Azure#1787 and Azure#1085
* Adding Go Keyvault specification. * Adding CDN Go config * Adding Relay Go Config * Adding Storage Go Config * Adding App Insights Go Config. * Adding APIManagment Go Config * Adding Authorization Go Config * Adding ContainerRegistry Go Config * Fixing license-header tag in current work. * Adding AnalysisServices Go Config * Adding Automation Go Config * Adding Batch Go Config * Adding Billing Go Config * Adding MediaServices Go Config * Fixing Nit formatting issue. * Adding CognitiveServices Go Config * Adding Compute Go Config * Adding Consumption Go Config * Adding ContainerInstance Go Config * Adding CosmosDB Go Config * Adding CustomerInsights Go Config * Adding DataFactory Go Config * Adding DomainServices Go Config * Adding EventGrid Go Config * Adding EventHub Go Config * Adding GraphRBAC Go Config * Adding IoTHub Go Config * Adding Logic Go Config * Adding NotificationHub Go Config * Adding Redis Go Config * Adding Scheduler Go Config * Adding Search Go Config * Add ServerManagement Go Config * Adding ServiceBus Go Config * Adding StorSimple8000Series Go Config * Adding StreamAnalytics Go Config * Add TrafficManager Go Config * Adding VisualStudio Go Config * Review feedback * More syntax fixes in Batch. * Adding Advisor Go Config * Adding Commerce Go Config * Adding Datalake Go Config * Fixing DataLake Store typo * Adding DNS Go Config * Adding DevTestLabs Go Config * Adding HD Insight Go Config * Adding Intune Go Config * Adding Machine Learning Go Config * Adding MySQL Go Config * Fixing typo * Adding Monitor Go Config * Fixing Network package typo * Adding Mobile Engagement Go Config * Adding Operational Insights Go Config * Adding PostgreSQL Go Config * Adding PowerBIEmbedded Go Config * Adding StorageImportExport Go Config * Fixing billing output-folder typo * Fixing advisor tag * Adding Service Fabric Go Config * Fixing Datalake Analytics Go Config * Removing '_' from machine_learning Go path * Adding missing parameter specification docs * Removing Search Data-Plane Go Config As requested by @brjohnstmsft in #1787 and #1085
* Adding Multi-API Version support packages. * Fixing Billing Output * Generating Datalake Analytics Management package * Renaming machine_learning -> machinelearning * Removing Search Data-Plane packages As discussed in Azure/azure-rest-api-specs#1085 and Azure/azure-rest-api-specs#1787 by @brjohnstmsft * Adding web package * Adding resources * Adding resource health * Adding SQL packages * Adding Operations Management * Adding Market Place Ordering:wq * Adding Service-Map
Update: The issues mentioned above for the management plane (search.json) have been resolved. The issues with the data plane specs remain. |
Prior to the reorganization of the azure-rest-api-specs repo structure, the Swagger specs for the Azure Search data plane API version 2016-09-01-preview lived in the search-service branch of the azure-rest-api-specs-pr repo. Now that there is a place for preview/incomplete Swagger specs in the public repo, we'd like to move this spec there so all the specs are in one place. The specs themselves have not changed; This is just a repo-to-repo copy. Like all Azure Search data plane specs, these are incomplete. See this issue for details: Azure#1085
* [Azure Search] Moving 2016-09-01-preview spec from private repo Prior to the reorganization of the azure-rest-api-specs repo structure, the Swagger specs for the Azure Search data plane API version 2016-09-01-preview lived in the search-service branch of the azure-rest-api-specs-pr repo. Now that there is a place for preview/incomplete Swagger specs in the public repo, we'd like to move this spec there so all the specs are in one place. The specs themselves have not changed; This is just a repo-to-repo copy. Like all Azure Search data plane specs, these are incomplete. See this issue for details: #1085 * [Azure Search] Adding 2016-09-01-preview config to readme.md
Update: All issues around validation and examples have been addressed. However, |
Update: |
Hi @brjohnstmsft can we close this issue now? |
@akning-ms Yes, the specs are now complete. |
Summary
Currently Azure Search has three Swagger specs per API version:
docs
resource that exists for every (customer-defined) search index.The intent of this issue is to capture and track all known issues with these specs, as of the following API versions:
Issues with search.json
examples
property instead ofx-ms-examples
. This needs to be changed the next time we touch this spec.Issues with searchservice.json
We need to:
x-ms-examples
to all operations.default
response to all operations.Issues with searchindex.json
Same as the issues for
searchservice.json
, plus:docs
resource is not captured in this Swagger spec. This is because we haven't yet done the engineering work to figure out how to get AutoRest to generate acceptable code for the dynamically-typed data plane part of our API (something the old Hyak generator wasn't designed to do). This is a non-trivial amount of work for us, and is currently on hold pending higher business priorities.The text was updated successfully, but these errors were encountered: