New Api version 2024-11-01

[ryuzakil]

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

• Link to API Spec engagement record issue: 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):

• [ ] a private preview
• [ ] a public preview
• [x] GA release 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.}

• Design Document: https://microsoftapc-my.sharepoint.com/:w:/r/personal/bhkansag_microsoft_com/Documents/Referential%20Data%20Catalogs.docx?d=wbb1ab21823be4e198b8ac9c0aebe9c60&csf=1&web=1&e=sdv0yu
• Previous API Spec Doc:
• Updated paths:

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 ApiView comment 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.

• 💬 Teams Channel
• 💌 email

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

• Azure REST API Guidelines
• OpenAPI Style Guidelines
• Azure Breaking Change Policy

Helpful Links

• Schedule a data plane REST API spec review

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 https://github.com/Azure/azure-rest-api-specs/issues/28833

[openapi-pipeline-app[bot]]

Next Steps to Merge

Next steps that must be taken to merge this PR:

• ❌ Your PR requires an API stewardship board review as it introduces a new API version (label: new-api-version). Schedule the review by following aka.ms/azsdk/onboarding/restapischedule.
• ❌ The required check named Swagger PrettierCheck has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide

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:

• ⚠️ The check named TypeSpec Requirement (data-plane) has failed. TypeSpec usage is required for all new (greenfield) services. This is currently enforced as a warning for data-plane specs, but will be made a blocking error in the near future. For information on converting from OpenAPI specs to TypeSpec specs or on data-plane (DP) policies, refer to aka.ms/azsdk/typespec. If you have general questions on resource provider (RP) policies, refer to aka.ms/rphelp

[openapi-pipeline-app[bot]]

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail]

The following breaking changes are detected by comparison with the latest preview version:

Rule

Message

❌ Runtime Exception

"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/@[email protected]/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
❌ UNREFERENCED_JSON_FILE	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
❌ unacceptable kind of an object to dump [object Error]	"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

❌ INTERNAL_ERROR

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]

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app[bot]]

Swagger Generation Artifacts

️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
❌ RestBuild error	"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 44cf1a8cb0a7d9984c747f6a88d48c34a30288ac. SDK Automation 14.0.0

  command	./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

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app[bot]]

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

[microsoft-github-policy-service[bot]]

Hi, @ryuzakil. 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.

[microsoft-github-policy-service[bot]]

Hi, @ryuzakil. 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.