New Api version 2024-11-01 #28646
Open
New Api version 2024-11-01 #28646
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ryuzakil
requested review from
tg-msft and
mikekistler
and removed request for
a team
Next Steps to MergeNext steps that must be taken to merge this PR:
Important checks have failed. As of today they are not blocking this PR, but in near future they will. Addressing the following failures is highly recommended:
|
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
"new":"https://github.com/Azure/azure-rest-api-specs/blob/005de3e987a4d78650c43fe2f3906d4f59aad679/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2024-11-01-preview/agfood.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/agfood.json", "details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 20 lines of stack trace follow, indexed. First line should contain AutoRest command line invocation details. Remaining lines should contain the main message reported by AutoRest. ==================== 1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.98/common/temp/node_modules/.pnpm/@Azure+oad@0.10.8/node_modules/autorest/dist/app.js" --v2 --input-file=specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2024-11-01-preview/agfood.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp/oad-1HleHJ 2: ERROR: Referenced file 'file:///mnt/vss/work/1/azure-rest-api-specs/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2024-11-01-preview/examples/WeatherGet.json' not found 3: - file:///mnt/vss/work/1/azure-rest-api-specs/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2024-11-01-preview/agfood.json:2054:14 ($.paths["/external/weather:fetch"].post["x-ms-examples"].WeatherGet["$ref"]) 4: FATAL: swagger-document/loader - FAILED 5: FATAL: Error: [OperationAbortedException] Error occurred. Exiting. 6: Process() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting." |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| default | default(005de3e) | default(main) |
️❌Avocado: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The swagger JSON file is not referenced from the readme file. readme: specification/agrifood/data-plane/readme.md json: Microsoft.AgFoodPlatform/preview/2024-11-01-preview/agfood.json |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/005de3e987a4d78650c43fe2f3906d4f59aad679/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2024-11-01-preview/agfood.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/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2024-11-01-preview/examples/Catalogs_List.json' Error: ENOENT: no such file or directory, open '/mnt/vss/_work/1/azure-rest-api-specs/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2024-11-01-preview/examples/Catalogs_List.json' JsonUrl: Microsoft.AgFoodPlatform/preview/2024-11-01-preview/agfood.json |
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
| Rule | Message |
|---|---|
|
"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=428298&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 1 " |
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning in generating from 44cf1a8. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json warn No file changes detected after generation warn No package detected after generation
|
PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
New Api version for our service.
Spec Doc: W12024 CDM V3 collections and references - DR.docx
Spec Doc W12024 CDM V3 collections and references - DR.docx
API Design Doc - https://microsoftapc-my.sharepoint.com/:w:/r/personal/bhkansag_microsoft_com/Documents/Referential%20Data%20Catalogs.docx?d=wbb1ab21823be4e198b8ac9c0aebe9c60&csf=1&web=1&e=sdv0yu
Is this review for (select one):
Its for 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 API Spec document (if applicable), and the root paths that have been updated.
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
❔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
Checks stuck in `queued` state?
If the PR CI checks appear to be stuck in `queued` state, please add a comment with contents `/azp run`. This should result in a new comment denoting a `PR validation pipeline` has started and the checks should be updated after few minutes.fix #28833