[Defender (RiskIQ) - EASM] Api version 2023-05-01-preview #24465
Conversation
|
Hi, @mspwood 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
|
| Rule | Message |
|---|---|
|
"new":"https://github.com/Azure/azure-rest-api-specs/blob/194336f2a53cc402c8e72a67158b81af9e6a56e0/specification/riskiq/data-plane/Microsoft.Easm/preview/2023-05-01-preview/easm.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/riskiq/data-plane/Microsoft.Easm/preview/2023-03-01-preview/easm.json", "details":"Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.55/common/temp/node_modules/.pnpm/@Azure+oad@0.10.4/node_modules/autorest/dist/app.js" --v2 --input-file=specification/riskiq/data-plane/Microsoft.Easm/preview/2023-05-01-preview/easm.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp\nERROR: Referenced file 'file:///mnt/vss/work/1/azure-rest-api-specs/specification/riskiq/data-plane/Microsoft.Easm/preview/2023-05-01-preview/examples/TasksDownload.json' not found\n - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/riskiq/data-plane/Microsoft.Easm/preview/2023-05-01-preview/easm.json:1665:12 ($.paths["/subscriptions/subscriptionId/resourceGroups/resourceGroupName/workspaces/workspaceName/tasks/taskId:download"].get["x-ms-examples"].Tasks["$ref"])\nFATAL: swagger-document/loader - FAILED\nFATAL: Error: [OperationAbortedException] Error occurred. Exiting.\nProcess() cancel" |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| default | default(194336f) | default(main) |
️❌Avocado: 34 Errors, 0 Warnings failed [Detail]
Only 30 items are listed, please refer to log for more details.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 0 Errors, 0 Warnings failed [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 2 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/194336f2a53cc402c8e72a67158b81af9e6a56e0/specification/riskiq/data-plane/Microsoft.Easm/preview/2023-05-01-preview/easm.json" |
|
"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/194336f2a53cc402c8e72a67158b81af9e6a56e0/specification/riskiq/data-plane/Microsoft.Easm/preview/2023-05-01-preview/easm.json" |
️❌SemanticValidation: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Unexpected internal error: ENOENT: no such file or directory, open '/mnt/vss/_work/1/azure-rest-api-specs/specification/riskiq/data-plane/Microsoft.Easm/preview/2023-05-01-preview/examples/Reports_Snapshot_Export.json' Error: ENOENT: no such file or directory, open '/mnt/vss/_work/1/azure-rest-api-specs/specification/riskiq/data-plane/Microsoft.Easm/preview/2023-05-01-preview/examples/Reports_Snapshot_Export.json' JsonUrl: Microsoft.Easm/preview/2023-05-01-preview/easm.json |
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️❌PrettierCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Code style issues found path: Microsoft.Easm/preview/2023-05-01-preview/easm.json |
️️✔️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.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Please ignore, experimental check succeeded [Detail] [Expand]
Validation passes for 'Please ignore, experimental check'.
Swagger Generation Artifacts
|
| Rule | Message |
|---|---|
|
"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=374210&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 1 " |
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]
Breaking Changes Tracking
|
Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment. |
|
Hi, @mspwood, 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 @mspwood, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi, @mspwood. 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 |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Reopen for REST API review on 7/18/23 |
|
/azp run |
|
No commit pushedDate could be found for PR 24465 in repo Azure/azure-rest-api-specs |
| } | ||
| }, | ||
| "tags": ["Assets"], | ||
| "operationId": "Assets_Observations", |
There was a problem hiding this comment.
The operationId for get on a collection should contain "list"
| { | ||
| "in": "query", | ||
| "name": "fileName", | ||
| "required": false, | ||
| "type": "string" | ||
| }, |
There was a problem hiding this comment.
All parameters should have a description.
| "summary": "Queue an export of the most recent snapshot of asset summary values to a file.", | ||
| "x-ms-examples": { | ||
| "Reports": { | ||
| "$ref": "./examples/Reports_Snapshot_Export.json" |
There was a problem hiding this comment.
invalid-ref error ENOENT: no such file or directory
| }, | ||
| "type": "array" | ||
| } | ||
| }, |
There was a problem hiding this comment.
The value property in pageable response should be required. This error occurs several more times ... please fix all.
| "$ref": "#/parameters/ApiVersionParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/DiscoGroupNameParameter" |
There was a problem hiding this comment.
Parameter "groupName" must be used in path.
|
/azp run |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
29 similar comments
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @mspwood. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
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 API Spec engagement record.
Is this review for (select one):
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 API Spec document (if applicable), and the root paths that have been updated.
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/assets:export
❔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.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links
fix #24466