-
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 API readiness tests for AMS #22428
Adding API readiness tests for AMS #22428
Conversation
Hi, @giakas 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. vscswagger@microsoft.com |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
Accounts.json | 2021-11-01(a970719) | 2021-11-01(main) |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-preview-2022-05 | package-preview-2022-05(a970719) | package-preview-2022-05(main) |
package-encoding-2022-07 | package-encoding-2022-07(a970719) | package-encoding-2022-07(main) |
package-metadata-2022-08 | package-metadata-2022-08(a970719) | package-metadata-2022-08(main) |
package-2022-08 | package-2022-08(a970719) | package-2022-08(main) |
package-account-2021-11 | package-account-2021-11(a970719) | package-account-2021-11(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L411 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L411 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L411 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L411 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L411 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Accounts/stable/2021-11-01/Accounts.json#L476 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Accounts/stable/2021-11-01/Accounts.json#L476 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Accounts/stable/2021-11-01/Accounts.json#L476 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Accounts/stable/2021-11-01/Accounts.json#L476 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Accounts/stable/2021-11-01/Accounts.json#L476 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L632 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L632 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L632 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L632 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L632 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L639 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L639 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L639 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L639 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L639 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L658 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L658 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L658 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L658 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L658 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L665 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L665 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L665 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L665 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2021-11-01/Accounts.json#L665 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/mediaservices/resource-manager/readme.md tag: specification/mediaservices/resource-manager/readme.md#tag-package-encoding-2022-07 |
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️
~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
Tag package-encoding-2022-07; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 99, untested: 30, failed: 0, passed: 69
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️️✔️
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.
Swagger Generation Artifacts
|
Generated ApiView
|
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
This reverts commit 869ebd6.
Hi @giakas, Your PR has some issues. Please fix the CI sequentially by following the order of
|
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
…Version When a service is split-up into different sub-groupings within the Swagger, we need to account for the fact that an API version may not be available in all of the sub-groups. This fixes an issue introduced in Azure/azure-rest-api-specs#22428 where the Media Service has introduced a new sub-group with no Swagger files, meaning importing this currently panics: ``` 2023-02-08T11:36:08.401Z [INFO] Importer for Service "Media".Importer for API Version "2022-08-01": 😵 Service "Media" / Api Version "2022-08-01" contains no resources, skipping. 215 panic: runtime error: invalid memory address or nil pointer dereference 216 [signal SIGSEGV: segmentation violation code=0x1 addr=0x20 pc=0xac65d4] 217 218 goroutine 1 [running]: 219 github.com/hashicorp/pandora/tools/importer-rest-api-specs/pipeline.runImportForService({{0xca2f0d, 0x21}, 0x0, 0x0, 0x0, {0xdde440, 0xc000187710}, {0xc8a2a1, 0xb}, {0xc87687, ...}, ...}, ...) 220 /home/runner/work/pandora/pandora/tools/importer-rest-api-specs/pipeline/run_importer.go:94 +0x1094 221 github.com/hashicorp/pandora/tools/importer-rest-api-specs/pipeline.runImporter({{0xca2f0d, 0x21}, 0x0, 0x0, 0x0, {0xdde440, 0xc000187710}, {0xc8a2a1, 0xb}, {0xc87687, ...}, ...}, ...) 222 /home/runner/work/pandora/pandora/tools/importer-rest-api-specs/pipeline/run_importer.go:39 +0x3b9 223 github.com/hashicorp/pandora/tools/importer-rest-api-specs/pipeline.Run({{0xca2f0d, 0x21}, 0x0, 0x0, 0x0, {0xdde440, 0xc000187710}, {0xc8a2a1, 0xb}, {0xc87687, ...}, ...}) 224 /home/runner/work/pandora/pandora/tools/importer-rest-api-specs/pipeline/interface.go:66 +0x4a5 225 github.com/hashicorp/pandora/tools/importer-rest-api-specs/cmd.ImportCommand.Run({{0xc8a2a1, 0xb}, {0xca2f0d, 0x21}, {0xc8be69, 0xd}, {0xc96634, 0x17}}, {0xc000124010, 0x0, ...}) 226 /home/runner/work/pandora/pandora/tools/importer-rest-api-specs/cmd/import.go:85 +0x4c5 227 github.com/mitchellh/cli.(*CLI).Run(0xc0003492c0) 228 /home/runner/go/pkg/mod/github.com/mitchellh/cli@v1.1.4/cli.go:262 +0x5f8 229 main.main() 230 /home/runner/work/pandora/pandora/tools/importer-rest-api-specs/main.go:31 +0x353 ```
* Adding API readiness tests for AMS * fix lint errors * fix prettier issues * rename rg * try use file as scope * Revert "try use file as scope" This reverts commit 869ebd6. * tiny fix * fix rg name * fix job name * fix job name * fix a model validation * remove job cancel step. * fix a failure --------- Co-authored-by: Lei Ni <leni@microsoft.com> Co-authored-by: Tianxiang Chen <tianxchen@microsoft.com>
ARM API Information (Control Plane)
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.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
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 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.
-[ ] 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.