-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Adding Id for Resource Providers path validation #1068
Conversation
No modification for Python |
No modification for Ruby |
No modification for NodeJS |
@azuresdkci Test this please |
1 similar comment
@azuresdkci Test this please |
documentation/swagger-checklist.md
Outdated
@@ -247,6 +247,8 @@ For example, [NetworkInterface.ipConfigurations](https://github.com/Azure/azure- | |||
|
|||
- :white_check_mark: **M2060**: x-ms-pageable operations must have a 200 response defined. | |||
|
|||
- :white_check_mark: **M2061**: URLs should have parameterized resource type values instead of defaults. |
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 think we want to put more than this in the documentation, can you write down the pattern for the URL and indicate what you're referring to as type values versus other parts of the path? Also, it'd be good to write (at least in parenthesis) the name of the rule (ProvidersPathValidation) I think it makes it easier to identify for swagger authors and reviewers (numbers are just not as easy to remember and could change). Feel free to consult with Kirthi as well if needed.
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.
sorry, meant to request changes.
Addressed PR comments
No modification for Ruby |
No modification for NodeJS |
No modification for Python |
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.
Let's start with that, but it's still kind of cryptic in my opinion from an outsider's perspective, we'll work on making that better afterwards, at least we add the rule for now.
No modification for Ruby |
No modification for Python |
No modification for NodeJS |
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