-
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
[Hub Generated] Review request for Microsoft.CostManagement to add version preview/2018-08-01-preview #20265
[Hub Generated] Review request for Microsoft.CostManagement to add version preview/2018-08-01-preview #20265
Conversation
Hi, @vibsridh 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. [email protected] |
Swagger Validation Report
|
compared swaggers (via Oad v0.9.6)] | new version | base version |
---|---|---|
costmanagement.insights.json | 2020-08-01-preview(10d81ed) | 2020-08-01-preview(main) |
Rule | Message |
---|---|
1033 - RemovedProperty |
The new version is missing a property found in the old version. Was 'value' renamed or removed? New: Microsoft.CostManagement/preview/2020-08-01-preview/costmanagement.insights.json#L83:7 Old: Microsoft.CostManagement/preview/2020-08-01-preview/costmanagement.insights.json#L83:7 |
1040 - AddedReadOnlyPropertyInResponse |
The new version has a new read-only property 'values' in response that was not found in the old version. New: Microsoft.CostManagement/preview/2020-08-01-preview/costmanagement.insights.json#L83:7 Old: Microsoft.CostManagement/preview/2020-08-01-preview/costmanagement.insights.json#L83:7 |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-preview-2020-08 | package-preview-2020-08(10d81ed) | package-preview-2020-08(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
Since operation 'InsightsGet' response has model definition 'x-ms-pageable', it should be of the form 'list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.CostManagement/preview/2020-08-01-preview/costmanagement.insights.json#L41 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'InsightsModel'. Consider using the plural form of 'Insights' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.CostManagement/preview/2020-08-01-preview/costmanagement.insights.json#L41 |
|
The resource 'Insights' does not have get operation, please add it. Location: Microsoft.CostManagement/preview/2020-08-01-preview/costmanagement.insights.json#L99 |
|
The API version:2020-08-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.CostManagement/preview/2020-08-01-preview/costmanagement.insights.json#L4 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
~[Staging] ServiceAPIReadinessTest: 61 Errors, 0 Warnings failed [Detail]
Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
RUNTIME_ERROR |
"statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 404" |
RUNTIME_ERROR |
"statusCode: 400, errorCode: InvalidView, errorMessage: Please provide a valid view ID.Unable to retrieve details for the specified view '/providers/Microsoft.CostManagement/views/swaggerExample'" |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 400" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: details" |
RUNTIME_ERROR |
"statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 404" |
RUNTIME_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The private scheduled action 'namedzzl3e' was not found." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 404" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: details" |
RUNTIME_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The private scheduled action 'namedzzl3e' was not found." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 404" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: details" |
RUNTIME_ERROR |
"statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 404" |
RUNTIME_ERROR |
"statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 404" |
RUNTIME_ERROR |
"statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 404" |
RUNTIME_ERROR |
"statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 404" |
RUNTIME_ERROR |
"statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 404" |
RUNTIME_ERROR |
"statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 404" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: True" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: True" |
RUNTIME_ERROR |
"statusCode: 401, errorCode: 401, errorMessage: Caller is not authorized" |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 401" |
RUNTIME_ERROR |
"statusCode: 401, errorCode: 401, errorMessage: Caller is not authorized" |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️
SDK Track2 Validation: 4 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/10d81ed31f0247879934b055c68b7e6153ba734f/specification/cost-management/resource-manager/readme.md#tag-package-preview-2020-08">cost-management/resource-manager/readme.md#package-preview-2020-08
Rule | Message |
---|---|
"readme":"cost-management/resource-manager/readme.md", "tag":"package-preview-2020-08", "details":"The schema 'AlertProperties-details-resourceGroupFilterItem' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#/components/schemas/AlertProperties-details-resourceGroupFilterItem" |
|
"readme":"cost-management/resource-manager/readme.md", "tag":"package-preview-2020-08", "details":"The schema 'AlertProperties-details-resourceFilterItem' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#/components/schemas/AlertProperties-details-resourceFilterItem" |
|
"readme":"cost-management/resource-manager/readme.md", "tag":"package-preview-2020-08", "details":"The schema 'AlertProperties-details-meterFilterItem' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#/components/schemas/AlertProperties-details-meterFilterItem" |
|
"readme":"cost-management/resource-manager/readme.md", "tag":"package-preview-2020-08", "details":"The schema 'QueryProperties-rows-itemsItem' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#/components/schemas/QueryProperties-rows-itemsItem" |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
"readme":"cost-management/resource-manager/readme.md", "tag":"package-preview-2020-08", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
NewApiVersionRequired reason: |
Hi @vibsridh, 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. |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
|
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.