-
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
Add Policy apis and Unblock Documentation Team #1117
Conversation
@amarzavery @dsgouda this fixes the issue #1071 |
FYI: I ran the latest validation (and manually suppressed some that I think are not applicable) and got the following: You're not really modifying these today, so I'm not going to block on them, but I'm going to note that corrections will soon have to be made to pass the validations.
|
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.
Looks nearly good to me, couple minor fixes, that's all.
@@ -2,13 +2,9 @@ | |||
"swagger": "2.0", | |||
"info": { | |||
"title": "ApiManagementClient", | |||
"description": "Use these REST APIs for managing OAuth2 servers configuration in your Azure API Management deployment.", | |||
"description": "Use these REST APIs for managing OAuth2 servers configuration in your Azure API Management deployment. We can authorize developer accounts using OAuth 2.0 in Azure API Management. For more information refer to [How to OAuth2](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-oauth2).", |
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.
Minor quibble : We can authorize developer accounts...
We
seems an odd choice for words here. Typically, documentation should be written in the non-possessive tense:
OAuth 2.0 can be used to authorize developer accounts for Azure API Management
or something. (like I said... minor quibble 😄 )
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.
#fixed
"$ref": "#/parameters/OperationIdParameter" | ||
}, | ||
{ | ||
"name": "policyData", |
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.
Standards are now that a body parameter should be named parameters
(instead of policyData
)
(BodyParametersValidation/M2063/SDKViolation): A body parameter must be named 'parameters'.
let's fix these ones 👍 (all cases!)
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.
#fixed
@fearthecowboy regarding RPC Violations, we have got exception from @ravbhatnagar and have an open issue #1060 tracking to be fixed in next api-version |
@solankisamir I assumed as much; just like to point them out 😄 |
No modification for Ruby |
No modification for Python |
No modification for NodeJS |
* Create FeatureRP swagger file * Address comments * Address comments * add SubscriptionFeatureRegistrationGET example * Create SubscriptionFeatureRegistrationPUT.json * Create SubscriptionFeatureRegistrationDELETE.json * Create SubscriptionFeatureRegistrationLIST.json * Update SubscriptionFeatureRegistrationGET.json * Update SubscriptionFeatureRegistrationPUT.json * Update SubscriptionFeatureRegistration.json * Update SubscriptionFeatureRegistrationLIST.json * Update SubscriptionFeatureRegistration.json
PR information
api-version
in the path should match theapi-version
in the spec).Quality of Swagger