-
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
Adding xms-ids for AppPlatform #17632
Adding xms-ids for AppPlatform #17632
Conversation
Hi, @agalerrotaru 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 |
---|---|
R4009 - RequiredReadOnlySystemData |
The response of operation:'Services_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L20 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ConfigServers_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L407 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'MonitoringSettings_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L628 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Apps_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L788 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Bindings_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L1110 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Certificates_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L1395 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'CustomDomains_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L1655 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Deployments_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L1994 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Services_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L60 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ConfigServers_UpdatePut' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L447 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'MonitoringSettings_UpdatePut' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L668 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Apps_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L838 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Bindings_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L1156 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Certificates_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L1438 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'CustomDomains_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L1701 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Deployments_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L2040 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Services_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L172 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ConfigServers_UpdatePatch' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L506 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'MonitoringSettings_UpdatePatch' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L727 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Apps_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L956 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Bindings_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L1280 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'CustomDomains_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L1825 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Deployments_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L2164 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L148 |
R4037 - MissingTypeObject |
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L4519 |
R4037 - MissingTypeObject |
The schema 'CloudErrorBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L4529 |
Per the Noun_Verb convention for Operation Ids, the noun 'RuntimeVersions' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AppPlatform/stable/2020-07-01/appplatform.json#L2677 |
|
Since operation 'ConfigServers_Validate' response has model definition 'array', 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.AppPlatform/stable/2020-07-01/appplatform.json#L572 |
|
'PUT' operation 'ConfigServers_UpdatePut' 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.AppPlatform/stable/2020-07-01/appplatform.json#L452 |
|
'PUT' operation 'MonitoringSettings_UpdatePut' 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.AppPlatform/stable/2020-07-01/appplatform.json#L673 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
~[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: 0 Errors, 0 Warnings failed [Detail]
️️✔️
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).
[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
|
…thub.com/agalerrotaru/azure-rest-api-specs into agalerrotaru/xms-ids-appplatform-rebased
@agalerrotaru , appPlatform is onboarded to shiftleft PR review pipeline. Please make swagger change in ADO repository then it will be synced to github. |
/azp run |
Commenter does not have sufficient privileges for PR 17632 in repo Azure/azure-rest-api-specs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are also 4 preview API versions in the preview. You should update them as well.
...cation/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/appplatform.json
Outdated
Show resolved
Hide resolved
@yuwzho Our service only uses the public api version - the stable specs. Also to get the places which require xms identifiers, we run the autorest command: 'autorest --validation --azure-validator --openapi-type=arm --use=@microsoft.azure/classic-openapi-validator@1.1.13 --use=@microsoft.azure/openapi-validator@1.12.1 "specification/appplatform/resource-manager/readme.md" > output.txt` . This will grab the files under the most recent tag of the stable version api. |
@agalerrotaru good to know that! |
Hi @agalerrotaru, Your PR has some issues. Please fix the CI sequentially by following the order of
|
* Adding xms-ids for AppPlatform * remove stale changes * remove prettier over fix * fixing semantic val errors
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 are using OpenAPIHub to initialize the PR for adding a new version. 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 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.