-
Notifications
You must be signed in to change notification settings - Fork 5.6k
Swagger changes for 26 RFI connectors, each with a linkedservice, dataset and source #2016
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
Conversation
|
Hi There, I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result: File: AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback Thanks for your co-operation. |
|
@ravbhatnagar lots of new stuff |
|
As discussed in skype call and over email, this is signed off from ARM side. |
olydis
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Eva-Xiao Looks good to me, see comment about descriptions. I don't treat that as blocking since:
- you seem to have strict deadlines
- the documentation "pattern" seems to be nothing new in this Swagger
- adjusting documentation later is not a breaking change
Still, I'd appreciate it if you could clarify - maybe it's a low hanging fruit to improve customer experience! 🙂
| "properties": { | ||
| "endpoint": { | ||
| "description": "The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com)", | ||
| "type": "object" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see modeling things as object is common here since things can be either a value or expression. The type is often indicated in descriptions (e.g. "Type: X (or Expression with resultType X)"), I think there's great value in doing that consistently!
Maybe there is a system/consistency behind type descriptions in this Swagger that I missed 🙂
Given the example, I guess that I can pass a string here (but maybe I can also pass one of these?).
However, there are less obvious properties like accessKeyId (string? int? GUID? Will it be super obvious for customers?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for pointing this out. Indeed I found it myself when I first start making this change, all the properties are object type except for the situation where it has only limited number of values, or must be a specific type for security concern. I think this is for future extensibility that a property can be extended to an object contains more properties where service can handled it without client breaking change.
|
No modification for AutorestCI/azure-sdk-for-python |
|
No modification for AutorestCI/azure-sdk-for-ruby |
|
No modification for AutorestCI/azure-sdk-for-node |
* Video Swagger API: update example response json to remove special invalid special characters (#2015) * Add Video Search API Swagger * Video Swagger API: update example response json to remove special invalid special characters * take changes from azure-rest-spec-pr, make Microsoft.Subscription tenant level rp (#1984) * Fix bad merge. (#2022) * Add list apis for sql backup LTR policies & vaults (#2006) * Add list LTR vaults & policies * Added pageable * Change output folder for Search SDKs (#2023) * update output folders in readmes * rename with bing in name * App Model for Tumbling window trigger (#2028) * App model for tumbling window trigger * Addressed CR comments * Renamed retry to count in RetryPolicy * swagger definition for 26 RFI connectors (#2016) * Updated OMS data plane C# namespace & output-folder (#2021) * Update Azure Batch enum to use "values" - also some documentation updates (#2008) * Enum fixes * Improve DataDisks documentation * Update NATPool port range documentation * [Compute] Update Sku APIs (#2034) * Initial commit of 2017-12-01 compute.json * Changes for new API version 2017-12-01 compute.json * Add Compute SKU APIs * Add swagger spec for spell check API (#1997) * Add swagger spec for spell check API * Add Examples to spec * Remove redundant forward slash in path. Specify array from body parameters. * Fix oav errors * Remove x-Bing_Apis-SDK * Change spec to reflect what objects we want to expose in the response. * Fix operationId name to avoid conflict with "SpellCheck" schema. * Add X-BingApis-SDK back. * Remove Unintentional change Packages.json change here was unintentionally added to this review
* [Network-2017-11-01] Pull latest from current (#2039) * Video Swagger API: update example response json to remove special invalid special characters (#2015) * Add Video Search API Swagger * Video Swagger API: update example response json to remove special invalid special characters * take changes from azure-rest-spec-pr, make Microsoft.Subscription tenant level rp (#1984) * Fix bad merge. (#2022) * Add list apis for sql backup LTR policies & vaults (#2006) * Add list LTR vaults & policies * Added pageable * Change output folder for Search SDKs (#2023) * update output folders in readmes * rename with bing in name * App Model for Tumbling window trigger (#2028) * App model for tumbling window trigger * Addressed CR comments * Renamed retry to count in RetryPolicy * swagger definition for 26 RFI connectors (#2016) * Updated OMS data plane C# namespace & output-folder (#2021) * Update Azure Batch enum to use "values" - also some documentation updates (#2008) * Enum fixes * Improve DataDisks documentation * Update NATPool port range documentation * [Compute] Update Sku APIs (#2034) * Initial commit of 2017-12-01 compute.json * Changes for new API version 2017-12-01 compute.json * Add Compute SKU APIs * Add swagger spec for spell check API (#1997) * Add swagger spec for spell check API * Add Examples to spec * Remove redundant forward slash in path. Specify array from body parameters. * Fix oav errors * Remove x-Bing_Apis-SDK * Change spec to reflect what objects we want to expose in the response. * Fix operationId name to avoid conflict with "SpellCheck" schema. * Add X-BingApis-SDK back. * Remove Unintentional change Packages.json change here was unintentionally added to this review * Add 2017-11-01 folder in microsoft.network (#2019) * Video Swagger API: update example response json to remove special invalid special characters (#2015) * Add Video Search API Swagger * Video Swagger API: update example response json to remove special invalid special characters * take changes from azure-rest-spec-pr, make Microsoft.Subscription tenant level rp (#1984) * Fix bad merge. (#2022) * Add 2017-11-01 folder in microsoft.network * Add Ip Tags into Swagger (#2145) * add iptags for publicip in 2017-11-01 * read me changes for 2017-11-01 * Add Python conf for Network 2017-11-01 * Complete Python conf for 2017-11-01 * Updated LB InboundNatPool API (#2150) * Revert "[Network-2017-11-01] Pull latest from current (#2039)" This reverts commit a0257f9. * Moving to stable folder to account for refactoring changes in dec 2017
This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.
PR information
api-versionin the path should match theapi-versionin the spec).Quality of Swagger