-
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
Subscription RP v2021-10-01 endpoint fix, s360 correctness #17155
Conversation
…red by OpenAPI Validation Tools(linter)
…quired by OpenAPI Validation Tools(linter)
…erenced; required by Swagger Avocado on the PR
…red by OpenAPI Validation Tools(linter)
Hi, @Ochirkhuyag 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 pipeline can not start as the pull request has merge conflicts. |
[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 pipeline can not start as the pull request has merge conflicts. |
Hi, @Ochirkhuyag your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
Swagger Validation Report
|
Rule | Message |
---|---|
R4010 - RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Subscription/stable/2016-06-01/subscriptions.json#L58 |
R4010 - RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Subscription/stable/2016-06-01/subscriptions.json#L91 |
R4010 - RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Subscription/stable/2016-06-01/subscriptions.json#L118 |
R4010 - RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Subscription/stable/2016-06-01/subscriptions.json#L148 |
R4037 - MissingTypeObject |
The schema 'Location' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Subscription/stable/2016-06-01/subscriptions.json#L163 |
R4037 - MissingTypeObject |
The schema 'LocationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Subscription/stable/2016-06-01/subscriptions.json#L198 |
R4037 - MissingTypeObject |
The schema 'Subscription' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Subscription/stable/2016-06-01/subscriptions.json#L210 |
R4037 - MissingTypeObject |
The schema 'SubscriptionPolicies' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Subscription/stable/2016-06-01/subscriptions.json#L254 |
R4037 - MissingTypeObject |
The schema 'SubscriptionListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Subscription/stable/2016-06-01/subscriptions.json#L283 |
R4037 - MissingTypeObject |
The schema 'TenantIdDescription' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Subscription/stable/2016-06-01/subscriptions.json#L302 |
R4037 - MissingTypeObject |
The schema 'TenantListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Subscription/stable/2016-06-01/subscriptions.json#L317 |
'GET' operation 'Subscription_AcceptOwnershipStatus' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L347 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'SubscriptionPolicy_AddUpdatePolicyForTenant' Request Model: 'PutTenantPolicyRequestProperties' Response Model: 'GetTenantPolicyResponse' Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L378 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SubscriptionModel'. Consider using the plural form of 'Subscription' 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.Subscription/stable/2021-10-01/subscriptions.json#L21 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SubscriptionModel'. Consider using the plural form of 'Subscription' 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.Subscription/stable/2021-10-01/subscriptions.json#L54 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SubscriptionModel'. Consider using the plural form of 'Subscription' 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.Subscription/stable/2021-10-01/subscriptions.json#L90 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SubscriptionModel'. Consider using the plural form of 'Subscription' 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.Subscription/stable/2021-10-01/subscriptions.json#L297 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SubscriptionModel'. Consider using the plural form of 'Subscription' 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.Subscription/stable/2021-10-01/subscriptions.json#L347 |
|
'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L330 |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.ManagementPartner/preview/2018-02-01/ManagementPartner.json#L156 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.ManagementPartner/preview/2018-02-01/ManagementPartner.json#L247 |
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.ManagementPartner/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.ManagementPartner/preview/2018-02-01/ManagementPartner.json#L169 |
R4019 - GetCollectionResponseSchema |
The response in the GET collection operation 'Partners_Get' does not match the response definition in the individual GET operation 'Partner_Get' . Location: Microsoft.ManagementPartner/preview/2018-02-01/ManagementPartner.json#L206 |
'PUT' operation 'SubscriptionPolicy_AddUpdatePolicyForTenant' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L380 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L643 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L721 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L820 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L926 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L975 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Alias_Create' Request Model: 'PutAliasRequest' Response Model: 'SubscriptionAliasResponse' Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L155 |
|
Based on the response model schema, operation 'Alias_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L265 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L611 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: blockSubscriptionsLeavingTenant Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L888 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: blockSubscriptionsIntoTenant Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L892 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: allowTransfers Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L999 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: blockSubscriptionsLeavingTenant Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L1014 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: blockSubscriptionsIntoTenant Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L1018 |
|
'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L188 |
|
'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L401 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: GetPartnerDetails Location: Microsoft.ManagementPartner/preview/2018-02-01/ManagementPartner.json#L211 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/subscription/resource-manager/readme.md tag: specification/subscription/resource-manager/readme.md#tag-package-2021-10 |
️️✔️
~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️
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.
️️✔️
SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️
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).
Swagger Generation Artifacts
|
The lint issues are not related to the change in this PR. Add the tag to suppress it. |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
* Copied the last item from private repo and renamed to 2021-10-01 * Updated the version to 2021-10-01 * Error response is updated. It is required by OpenAPI Validation Tools(linter) * http status response on post method is updated to 201 from 202; required by OpenAPI Validation Tools(linter) * description is added in #definitions.Operation.properties.display; required by OpenAPI Validation Tools(linter) * updated error response to match it previous * systemData properties are added; required by Swagger validation on the PR * updated readme.md for the new version * removed a file getSubscriptionOperation.json as long as it is not referenced; required by Swagger Avocado on the PR * Modified style by npm prettier * executed npm run prettier; required by prettier check on PR * added type:object; required by swagger LintDiff * added type:object; required by swagger LintDiff * reverted back the post response of acceptOwnership to 202 * http status response on post method is updated to 201 from 202; required by OpenAPI Validation Tools(linter) * reverted back the post response of acceptOwnership to 202 * Updated property name value to subscriptionId * Added missing property in response body of Get List of Alias subscription API * Updated response of default policies from 201 to 200 based on API response * Updated example for response of default policies from 201 to 200 based on API response * s360 fix: error response is fixed on managementpartner * added Microsoft.Subscription/stable/2016-06-01/subscriptions.json in input file list * Lint diff errors are fixed * reverting back the changes for 2-16-06-01 * added v2016-06-01 for the new * executed prettier Co-authored-by: Ochi <[email protected]>
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.
-[x] 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.