azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Added Oakes API 2022-05-04 preview
ARM API Information (Control Plane)
Changelog
- What's the purpose of the update?
- [x] new API version
- When are you targeting to deploy the new service/feature to public regions?
- October 2022
- When do you expect to publish the swagger?
- October 2022
- By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after the swagger of the new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
Contribution checklist (MS Employees Only):
- [x ] I commit to follow the Breaking Change Policy of "no breaking changes"
- [ x] I have reviewed the documentation for the workflow.
- [ ] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further questions about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :warning:
If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.
- Change to data plane APIs
- Adding new properties
- All removals
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 the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[ ] 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. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow. Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Hi, @ittayo 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) succeeded [Detail] [Expand]
There are no breaking changes.
️❌LintDiff: 2 Errors, 5 Warnings failed [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2022-05-04-preview | package-2022-05-04-preview(4c0e817) | default(dev-datacollaboration-Microsoft.DataCollaboration-2020-05-04-preview) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
The delete response body must be empty. Location: Microsoft.DataCollaboration/preview/2022-05-04-preview/DataCollaboration.json#L718 |
RPC-V2-Delete-04 |
|
The delete response body must be empty. Location: Microsoft.DataCollaboration/preview/2022-05-04-preview/DataCollaboration.json#L3271 |
RPC-V2-Delete-04 |
| :warning: RequiredReadOnlySystemData | The property systemData in the response of operation:'Computations_Get' is not read only. Please add the readonly for the systemData. Location: Microsoft.DataCollaboration/preview/2022-05-04-preview/DataCollaboration.json#L570 |
|
| :warning: RequiredReadOnlySystemData | The property systemData in the response of operation:'Computations_CreateOrUpdate' is not read only. Please add the readonly for the systemData. Location: Microsoft.DataCollaboration/preview/2022-05-04-preview/DataCollaboration.json#L619 |
|
| :warning: RequiredReadOnlySystemData | The property systemData in the response of operation:'ComputationRevisions_Get' is not read only. Please add the readonly for the systemData. Location: Microsoft.DataCollaboration/preview/2022-05-04-preview/DataCollaboration.json#L813 |
|
| :warning: RequiredReadOnlySystemData | The property systemData in the response of operation:'ComputationReferences_Get' is not read only. Please add the readonly for the systemData. Location: Microsoft.DataCollaboration/preview/2022-05-04-preview/DataCollaboration.json#L3102 |
|
| :warning: RequiredReadOnlySystemData | The property systemData in the response of operation:'ComputationReferences_CreateOrUpdate' is not read only. Please add the readonly for the systemData. Location: Microsoft.DataCollaboration/preview/2022-05-04-preview/DataCollaboration.json#L3159 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
️❌Avocado: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag does not contain all APIs in this RP. Please make sure the missing API swaggers are in the default tag. readme: specification/datacollaboration/resource-manager/readme.md json: Microsoft.DataCollaboration/preview/2020-05-04-preview/DataCollaboration.json |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️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 Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 2bbdc88cb96989209ef82f0d00beba1ab4bce9c5. SDK Automation 14.0.0warn Skip initScript due to not configured command sudo apt-get install -y dotnet-sdk-6.0 command autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/datacollaboration/resource-manager/readme.md cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied
️✔️Microsoft.Azure.Management.DataCollaboration [View full logs] [Preview SDK Changes]warn Skip artifact folder because it doesn't exist: artifacts/packages
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs] Generate from 2bbdc88cb96989209ef82f0d00beba1ab4bce9c5. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json cmderr [automation_generate.sh] notice cmderr [automation_generate.sh] npm notice New major version of npm available! 8.19.2 -> 9.1.1 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.1.1> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-datacollaboration [View full logs] [Preview SDK Changes]info [Changelog] - Initial Release
Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.
Hi, @ittayo, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline
Hi @ittayo, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
Hi, @ittayo, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline
Please see this requirement, thanks.
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested
Hi @ittayo, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval.