-
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
[Datadog] Add api version parameter #12345
Conversation
Hi, @limingu Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com |
Swagger Validation Report
|
Rule | Message |
---|---|
1010 - AddingRequiredParameter |
The required parameter 'api-version' was added in the new version. New: Microsoft.Datadog/preview/2020-02-01-preview/datadog.json#L39:9 |
1010 - AddingRequiredParameter |
The required parameter 'api-version' was added in the new version. New: Microsoft.Datadog/preview/2020-02-01-preview/datadog.json#L84:9 |
1042 - ChangedParameterOrder |
The order of parameter 'body' was changed. New: Microsoft.Datadog/preview/2020-02-01-preview/datadog.json#L84:9 Old: Microsoft.Datadog/preview/2020-02-01-preview/datadog.json#L81:9 |
️⚠️
LintDiff: 1 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.6.0 , classic-openapi-validator v1.1.5 )
- Linted configuring files (Based on target branch, openapi-validator v1.6.0 , classic-openapi-validator v1.1.5 )
Rule | Message |
---|---|
'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. New: Microsoft.Datadog/preview/2020-02-01-preview/datadog.json#L91 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
Swagger Generation Artifacts
|
Hi @limingu, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
@jianyexi, the service is still in private preview. So it is ok for the change to be breaking change. |
As it's in public repo, this preview version is public preview , right ? Or you need to seed the change to private repo first ? |
@jianyexi, we will soon be in public preview. Also, I will create another PR to merge into private repo. I don't think the order matters, right? |
@jianyexi, the service is still in private preview and only internal customers and our own team are using the APIs. NO external customers are using it. So the breaking change is fine. Thanks! |
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.
fix https://github.com/Azure/azure-rest-api-specs-pr/issues/8974
fix #20705