Documentation updated for Lots, Events and Credits #14314
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @edy2310 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 |
|---|---|
|
Resource type naming must follow camel case. Path: '/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/Microsoft.Consumption/aggregatedCost' Location: Microsoft.Consumption/stable/2021-05-01/consumption.json#L1557 |
|
The last resource provider 'Microsoft.Consumption, Microsoft.Billing' doesn't match the namespace. Location: Microsoft.Consumption/stable/2021-05-01/consumption.json#L36 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Consumption/stable/2021-05-01/consumption.json#L424 |
|
The response schema of operations API '/providers/Microsoft.Consumption/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Consumption/stable/2021-05-01/consumption.json#L1477 |
| Based on the response model schema, operation 'Charges_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Consumption/stable/2021-05-01/consumption.json#L480 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'EventsModel'. Consider using the plural form of 'Events' 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.Consumption/stable/2021-05-01/consumption.json#L1604 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'EventsModel'. Consider using the plural form of 'Events' 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.Consumption/stable/2021-05-01/consumption.json#L1655 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'LotsModel'. Consider using the plural form of 'Lots' 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.Consumption/stable/2021-05-01/consumption.json#L1707 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'LotsModel'. Consider using the plural form of 'Lots' 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.Consumption/stable/2021-05-01/consumption.json#L1752 |
|
| Guid used in model definition 'LegacyUsageDetailProperties' for property 'meterId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Consumption/stable/2021-05-01/consumption.json#L2031 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️[Staging] SDK Track2 Validation: 0 Warnings warning [Detail]
- The following tags are being changed in this PR
|:speech_balloon: AutorestCore/Exception|"readme":"consumption/resource-manager/readme.md",
"tag":"package-2021-05",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"consumption/resource-manager/readme.md",
"tag":"package-2021-05",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| "readme":"consumption/resource-manager/readme.md", "tag":"package-2021-05", "details":"Schema 'ReservationRecommendationDetailsModel' has a property 'etag' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from ReservationRecommendationDetailsModel" |
|
| "readme":"consumption/resource-manager/readme.md", "tag":"package-2021-05", "details":"Schema 'LegacyReservationTransaction' has a property 'properties' that is already declared the parent schema 'ReservationTransaction' but isn't significantly different. The property has been removed from LegacyReservationTransaction" |
|
| 💬 AutorestCore/Exception | "readme":"consumption/resource-manager/readme.md", "tag":"package-2021-05", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Generation Artifacts
|
|
Hi @edy2310, Your PR has some issues. Please fix the CI sequentially by following the order of
|
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
| "description": "The billing currency.", | ||
| "type": "string", | ||
| "readOnly": true | ||
| }, | ||
| "balanceSummary": { | ||
| "description": "Summary of balances associated with this credit summary.", | ||
| "readOnly": true, |
There was a problem hiding this comment.
CreditBalanceSummary definition is missing "EstimatedBalanceInBillingCurrency"
| "properties": { | ||
| "exchangeRate": { | ||
| "description": "The exchange rate.", | ||
| "type": "decimal", |
There was a problem hiding this comment.
"type": "number", "format": "decimal",
| }, | ||
| "exchangeRateMonth": { | ||
| "description": "The exchange rate month.", | ||
| "type": "int", |
There was a problem hiding this comment.
"type": "integer", "format": "int32",
| @@ -5166,6 +5254,38 @@ | |||
| } | |||
| } | |||
| }, | |||
| "AmountWithExchangeRate": { | |||
| "description": "The amount with exchange rate.", | |||
| "type": "object", | |||
There was a problem hiding this comment.
type would not be needed here.
| "Expired", | ||
| "Complete", | ||
| "Canceled" | ||
| ], |
There was a problem hiding this comment.
The following needs to be added
"x-ms-enum": {
"name": "Status",
"modelAsString": true
}
| "source": "PurchasedCredit", | ||
| "startDate": "2021-05-01T00:00:00Z", | ||
| "expirationDate": "2019-12-31T00:00:00Z", | ||
| "poNumber": "31224" | ||
| "poNumber": "31224", | ||
| "purchaseDate": "2019-09-01T00:00:00Z", |
There was a problem hiding this comment.
purchaseDate and status won't be available at the billingProfile scope.
| @@ -13,17 +13,32 @@ | |||
| "name": "lot1", | |||
| "type": "Microsoft.Consumption/lots", | |||
| "properties": { | |||
| "creditCurrency": "USD", | |||
There was a problem hiding this comment.
Please revert all the changes on this file.
| @@ -12,17 +12,32 @@ | |||
| "name": "lot1", | |||
| "type": "Microsoft.Consumption/lots", | |||
| "properties": { | |||
| "creditCurrency": "USD", | |||
There was a problem hiding this comment.
Please revert all the changes in this file.
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
|
@karthikku-2020 I resolved all your comments and made the changes to the Events examples. Please let me know if I made the correct changes. |
|
Hi @edy2310, 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. |
|
@edy2310 Have you released .NET SDK? If the API you change has released .NET SDK, please move all properties you added to the end which is required by .NET SDK. |
| "currency": "USD", | ||
| "value": 500 | ||
| }, | ||
| "creditExpired": { |
There was a problem hiding this comment.
This should be canceledCredit.
After reviewing the messages from BreakingChanges, I consider these to be a false positive as the updated documentation will not be used by external clients or internal partners. |
JeffreyRichter
approved these changes
May 27, 2021
JeffreyRichter
added
the
Approved-BreakingChange
ChenTanyi
added
the
Approved-OkToMerge
|
@edy2310 Please tell me when it ready to merge. |
This was referenced May 31, 2021
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* Documentation updated for Lots, Events and Credits * Fixing PR comments * Fixed PR comments. * Fixed Events examples * Fixing pipeline * Fixing pipeline Co-authored-by: Edgar Vázquez <edgarvazquez@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 Breaking Change 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.