azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
[Hub Generated] Publish private branch 'RPSaaSMaster-easm-data-plane-sdk'
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
Data Plane API - Pull Request
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your engagement record.
- Link to engagement record issue:
Is this review for (select one):
- [x] a private preview
- [ ] a public preview
- [ ] GA release
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous Open API document (swagger) if applicable, and the root paths that have been updated.
- Design Document:
- Previous Open API Doc:
- Updated paths:
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
- 💬 Teams Channel
Click here for links to tools, specs, guidelines & other good stuff
Tooling
- Open API validation tools were run on this PR. Go here to see how to fix errors
- Spectral Linting
- Open API Hub
Guidelines & Specifications
Helpful Links
The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/8254
Hi, @eqtip Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 25 Warnings warning [Detail]
| compared swaggers (via Oad v0.10.1)] | new version | base version |
|---|---|---|
| easm.json | 2022-09-01-preview(7d3a198) | 2022-04-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 4 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| 2022-09-01-preview | 2022-09-01-preview(7d3a198) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: R4000 - ParameterDescriptionRequired | 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Easm/preview/2022-09-01-preview/easm.json#L515 |
|
| :warning: R4000 - ParameterDescriptionRequired | 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Easm/preview/2022-09-01-preview/easm.json#L574 |
|
| :warning: R4000 - ParameterDescriptionRequired | 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Easm/preview/2022-09-01-preview/easm.json#L945 |
|
| :warning: R4000 - ParameterDescriptionRequired | 'dataConnectionName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Easm/preview/2022-09-01-preview/easm.json#L5461 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| :warning: R3017 - GuidUsage | Guid used in model definition 'AssetResponse' for property 'uuid'. 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.Easm/preview/2022-09-01-preview/easm.json#L1958 |
| :warning: R4000 - ParameterDescriptionRequired | 'mark' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Easm/preview/2022-09-01-preview/easm.json#L84 |
| :warning: R4000 - ParameterDescriptionRequired | 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Easm/preview/2022-09-01-preview/easm.json#L155 |
| :warning: R4000 - ParameterDescriptionRequired | 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Easm/preview/2022-09-01-preview/easm.json#L780 |
| :warning: R4000 - ParameterDescriptionRequired | 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Easm/preview/2022-09-01-preview/easm.json#L1107 |
| :warning: R4000 - ParameterDescriptionRequired | 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Easm/preview/2022-09-01-preview/easm.json#L1163 |
| :warning: R4000 - ParameterDescriptionRequired | 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Easm/preview/2022-09-01-preview/easm.json#L1369 |
| :warning: R4000 - ParameterDescriptionRequired | 'assetId' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Easm/preview/2022-09-01-preview/easm.json#L5454 |
| :warning: R4000 - ParameterDescriptionRequired | 'discoGroupName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Easm/preview/2022-09-01-preview/easm.json#L5468 |
| :warning: R4000 - ParameterDescriptionRequired | 'discoTemplateId' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Easm/preview/2022-09-01-preview/easm.json#L5475 |
| :warning: R4000 - ParameterDescriptionRequired | 'savedFilterName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Easm/preview/2022-09-01-preview/easm.json#L5508 |
| :warning: R4000 - ParameterDescriptionRequired | 'taskId' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Easm/preview/2022-09-01-preview/easm.json#L5525 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger pipeline restarted successfully, please wait for status update in this comment.
Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment.
Have we had a meeting? https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/271/Azure-REST-API-Stewardship
Yes. This is a new API version that was already reviewed, approved, and merged in the private repo. This PR is to get it merged to the public repo.
Add @heaths as he reviewed the private PR https://github.com/Azure/azure-rest-api-specs-pr/pull/8254
@heaths Regarding the private branch ... looks like they are on RPSaaSMaster which was the source of the branch and where the PR got merged to:
https://github.com/Azure/azure-rest-api-specs-pr/tree/RPSaaSMaster/specification/riskiq/data-plane/Microsoft.Easm/preview/2022-09-01-preview
Would love some direction on a couple things:
- How to get those changes into main.
- For future versions (there will be one more representing our public preview) where should we be branching from? I think the RPSaaSMaster thing came from some ARM documentation.
If your target branch is main branch, I would assume the code should be based on main, not RPSaaSMaster
Looks like @heaths is out for the remainder of the year. @markweitzel @rysweet @jhendrixMSFT @weidongxu-microsoft Anyone who can help us get over the finish line here?
Hi, @eqtip. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
Hi, @eqtip. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.