GA payment method APIs #15886
Merged
GA payment method APIs #15886
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, @deep9c 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 |
|
[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 Validation Report
|
| Rule | Message |
|---|---|
| 'DELETE' operation 'PaymentMethodAtBillingProfile_Remove' should use method name 'Delete'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Billing/stable/2021-10-01/payment.json#L311 |
|
| 'ErrorSubDetails' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Billing/stable/2021-10-01/payment.json#L764 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: PaymentMethodsListByBillingProfile Location: Microsoft.Billing/stable/2021-10-01/payment.json#L273 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Billing/stable/2021-10-01/payment.json#L708 |
|
The schema 'ErrorDetails' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Billing/stable/2021-10-01/payment.json#L729 |
|
The schema 'OperationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Billing/stable/2021-10-01/payment.json#L787 |
|
The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Billing/stable/2021-10-01/payment.json#L819 |
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.Billing/stable/2021-10-01/payment.json#L814 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/billing/resource-manager/readme.md tag: specification/billing/resource-manager/readme.md#tag-package-2020-05 |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️Cross-Version Breaking Changes: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| "details":"Attention: There are some existing APIs currently documented in a new spec file. The validation may not be able to report breaking changes with these APIs. It is recommended not to rename swagger file or move public APIs to a new file when creating a new API version.The existing APIs being moved are:Operations_List;", "location":"https://github.com/Azure/azure-rest-api-specs/blob/4c013647b8d6a6bf77e1ec65ac50efbf3b7a3539/specification/billing/resource-manager/Microsoft.Billing/stable/2021-10-01/payment.json" |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️[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).
Swagger Generation Artifacts
|
|
Hi @deep9c, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi, @deep9c your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
This was referenced Sep 1, 2021
|
@deep9c the default branch of the spec repo has been updated as main and I have updated the PR as so. |
merge ValidateDetachPaymentMethod API into detach API
deep9c
removed
the
ARMChangesRequested
j5lim
reviewed
Sep 15, 2021
| "description": "Conflict. Payment method cannot be detached from billing profile.", | ||
| "x-ms-error-response": true, | ||
| "schema": { | ||
| "$ref": "#/definitions/DetachPaymentMethodEligibilityResult" |
There was a problem hiding this comment.
There are specific error codes enum for this scenario. Don't we have to mention those as part of new schema?
There was a problem hiding this comment.
modified the schema to mirror ARM error schema
There was a problem hiding this comment.
Not sure how this would impact SDK generation. I will let the SDK team review.
j5lim
reviewed
Sep 15, 2021
...nager/Microsoft.Billing/stable/2021-10-01/examples/PaymentMethodAtBillingProfile_Remove.json
Outdated
Show resolved
Hide resolved
j5lim
added
the
ARMChangesRequested
j5lim
added
ARMSignedOff
ArcturusZhang
approved these changes
Sep 22, 2021
This was referenced Sep 22, 2021
Closed
Closed
Closed
Hardell
pushed a commit
to Hardell/azure-rest-api-specs
that referenced
this pull request
Sep 27, 2021
* GA payment method APIs * changed version * added Delete PaymentMethodLink API * fix status enum case * added new version to readme files * fix readme.azureresourceschema.md * merge ValidateDetachPaymentMethod API into detach API * fix LintDiff check * fix LintDiff checks * x-ms-error-response with 409 * detach eligibility error mirror arm error schema * suppress systemData LintDiff check
LeiWang3
pushed a commit
to LeiWang3/azure-rest-api-specs
that referenced
this pull request
Mar 31, 2022
* GA payment method APIs * changed version * added Delete PaymentMethodLink API * fix status enum case * added new version to readme files * fix readme.azureresourceschema.md * merge ValidateDetachPaymentMethod API into detach API * fix LintDiff check * fix LintDiff checks * x-ms-error-response with 409 * detach eligibility error mirror arm error schema * suppress systemData LintDiff check
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
Add a changelog entry for 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
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 label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] 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.
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 any of the following scenarios apply to the PR, request approval from the 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.