-
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: Adding some missing descriptions to the 2016-09-01 spec #1086
Conversation
@@ -1285,7 +1288,11 @@ | |||
"type": "string" | |||
}, | |||
"name": { |
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.
You can also put regex rules here with min/max length
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.
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.
@anudeepsharma I have some (IMO) well-grounded objections to regex constraints. Rather than repeat them, I'll direct you to this discussion on an earlier PR.
Regarding min/max constraints, I believe they are valuable for documentation purposes where applicable. These limits are documented in the (hand written) REST API reference, which we now link to from the Swagger spec. However, I would still refrain from adding them to the Swagger until AutoRest supports disabling client-side validation.
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.
Waiting for regex and min/max length. In case you are not doing, let me know, I will merge the PR. Changes look fine to me otherwise.
Also - https://travis-ci.org/Azure/azure-rest-api-specs/jobs/216953241 is failing. In case you can make build better, please do it (don't make breaking changes though).
@anudeepsharma Regarding the Travis CI build failing, please see my comment at the top of this PR:
|
@anudeepsharma Opened an issue on AutoRest to track disabling client-side validation: Azure/autorest#2100 |
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.
LGTM
No modification for Ruby |
No modification for NodeJS |
No modification for Python |
NOTE: This Swagger spec fails validation with the current version of the linter. This is a known issue: #1085
We are trying to ship an incremental bugfix/feature update to our .NET SDK. We do not have the bandwidth right now to do a full pass over this Swagger spec, so please keep that in mind as you review it.
FYI @chaosrealm @Yahnoosh @vishrutshah
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-version
in the path should match theapi-version
in the spec).Quality of Swagger