Skip to content
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

tsp, loadtesting #3397

Closed
wants to merge 48 commits into from
Closed

Conversation

XiaofeiCao
Copy link

Data Plane API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

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.

  • Link to API Spec engagement record issue:

Is this review for (select one):

  • a private preview
  • a public preview
  • 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:
  • 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.

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Guidelines & Specifications

Helpful Links

Getting help

  • First, please carefully read through this PR description, from top to bottom.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • 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.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

weidongxu-microsoft and others added 30 commits June 20, 2024 15:13
…lianceautomation (Azure#29361)

* disable flatten for JS for mongocluster

* Update readme.typescript.md

* update
Azure#29473)

* Adds base for updating Microsoft.Network from version stable/2023-11-01 to version 2024-01-01

* Updates readme

* Updates API version in new specs and examples

* Add examples for Subnet peering and v6 Subnet peering. (Azure#28827)

Add examples for Subnet peering and v6 Subnet peering.
---------

Co-authored-by: saurabh83 <[email protected]>

* Init (Azure#29127)

Co-authored-by: Abhishek Shah <[email protected]>

* Adding the new response code to the 2024-01-01 version release of swagger to match the bugfix in 2023-11-01 (Azure#29048)

Co-authored-by: Arsheen Khatib (from Dev Box) <[email protected]>

* Added NoHealthyBackendsBehavior (Azure#28868)

Added the property "NoHealthyBackendsBehavior" to the Probe properties.

* VirtualNetworkGatewayConnection using key vault for authentication. (Azure#28760)

* Add parameters for cert based auth connection

* retrigger checks

* retrigger checks

* lintDiff

* Trigger Build

* revert PATCH changes

* fix

* change managed identity to v5

* add format and description

* added networkidentifier under vnet->subet->serviceendpoint (Azure#29292)

* added networkidentifier under vnet->subet->serviceendpoint

* resolving conflict (Azure#29343)

* Fix for PR VirtualNetworkGatewayConnection using key vault for authentication. (Azure#29357)

* Fix

* Fix2

---------

Co-authored-by: Khushboo Baheti <[email protected]>

* Adding GET operaton for Network Virtual Appliance Inbound Secuirty Rule (Azure#29339)

* Moving missed changes from 2023-11-01 packet capture swagger fix to latest api version

* Add CrossConnection Name as an optional query parameter in List ExpressRoute CrossConnection (Azure#29251)

* Add CrossConnection name as an optional query parameter for List CrossConnection

* update example

* Addressing comments

* Change to OData filtering

* Fix the parameter reference

* Update

---------

Co-authored-by: Jianqi Zhao <[email protected]>

* initial changes (Azure#29235)

* adding supression for the breaking change in azure-sdk-for-go

* adding correct package for this supression

---------

Co-authored-by: GuptaVertika <[email protected]>
Co-authored-by: saurabh83 <[email protected]>
Co-authored-by: saurabh83 <[email protected]>
Co-authored-by: Abhishek Shah <[email protected]>
Co-authored-by: Abhishek Shah <[email protected]>
Co-authored-by: AFK1194 <[email protected]>
Co-authored-by: Arsheen Khatib (from Dev Box) <[email protected]>
Co-authored-by: Eugenio Peña García <[email protected]>
Co-authored-by: daweiwang-microsoft <[email protected]>
Co-authored-by: Bhupesh Kumar Bhatt <[email protected]>
Co-authored-by: Khushboo Baheti <[email protected]>
Co-authored-by: Khushboo Baheti <[email protected]>
Co-authored-by: Ashutosh Mishra <[email protected]>
Co-authored-by: jianzhao1992 <[email protected]>
Co-authored-by: Jianqi Zhao <[email protected]>
Co-authored-by: nimaller <[email protected]>
…ure#29452)

* Added missing id property to some example resources. Added headers with locations to long-running operation examples.

* Added some missing information on some response object typings regarding the location property used in long-running operations.

* Fixed a possible typo 'azure-async-operation' to 'azure-asyncoperation' (removed a hyphen).

* Ran prettier against azureFirewall.json

* Applying the 2023-05-01 validation fixes to the 2023-06-01 and 2023-09-01 versions as well.

* Removed duplicate property

* Added missing location header to the 06 and 09 verisions, similar to the 05 version.

* Added missing IDs to certain resource gets/puts. Added missing location header for long running delete operation.

* Updated 2023-09-01 stable examples.

* Fixed improper resource id

* Fixed example errors for 2023-06-01. Fixed small whitespace typo on a 2023-09-01 file.

* Updated 2023-05-01 firewall examples. Fixed small whitespace typoe missed from previous commit.

* Updated 2023-04-01 examples with resource IDs. Updated some resource IDs that use the wrong firewall name in their path.

* Updated firewall examples for 2023-02-01.

* Added location headers for several long-running operations. Updated some location headers so their URL paths have the accurate api-version.
* Update readme.md

* Create readme.python.md
…#29542)

* Added `stream-style-serialization: false` in `readme.java.md`.
remove openapi hub related steps;
change breaking change label property name.
* 2023-11-01

* .

* fix json file name

* update resume and suspend operations

* update examples of resume and suspend

* fixed json format

* resolve comments

* .

* .

* .

* update description

* updating State model to ResourceState

* fix comments
* add base commit by copying previous version

* update api version

* add suppression yaml

* add suppression yaml

* fix suppression yaml

* move suppression.yaml to service folder

* fix suppression

* fix path

* remove migration
* fix docs creating bad docstrings in purview

* fix ci
…#29487)

* copy API version from 2024-06-01-preview to 2024-07-01-preview

* updating API version to 2024-07-01-preview

* update readme files

* add configurationSettings parameter for this api version

* add secret flag for protectedSettings

* update readme file

* made gateway as first class param

* update to a more appropriate name

* fix prettier issue

---------

Co-authored-by: Bavneet Singh <[email protected]>
* Add Web PubSub data plane version 2024-01-01

* Add Web PubSub data plane version 2024-01-01

---------

Co-authored-by: Liangying.Wei <[email protected]>
…ure#29543)

* Added 2023-12-01 API Specs and Initial Examples

* Added validated examples

* Changes in the README and Provisioning State Suppression

* Format changes

* Pattern on resource names
* fix docs creating bad docstrings in healthinsights

* fix ci
* Copy files from preview/2024-06-01-preview

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.

* Update version to preview/2024-07-01-preview

Updated the API version from preview/2024-06-01-preview to preview/2024-07-01-preview.

* Added tag for 2024-07-01-preview in readme file

* Change introduces a new feature in the form of an API for Imaging on top of Image Definition.

* Add suppression same as previous API version

* Fixed example. Ran prettier

* Remove suppression

* re-add suppression

* Update references to commontypes to v5 for changes included in this PR

* Per PR comment, renamed getDetails to getBuildDetails. Added Azure-AsyncOperation as header returned in new async post actions

* Generated new example subscription id as the previous one was not passing the uuid validation locally

* Remove unused ListImageBuildTaskGroupsIncludeParameter

---------

Co-authored-by: Nick Depinet <[email protected]>
* Update readme.python.md

* Create readme.python.md
* [StorageTasks] Bugfix maxpagesize type

* add sdk-suppressions.yaml

---------

Co-authored-by: Alancere <[email protected]>
* Baseline for 2024-04-01 from 2020-05-01

* Updates for GA 2024-04-01

* Adding suppression as 'resource' schema is missing properties

* Build fixes and PR feedback

* tr lint error fix

* update example

* try fixing python

* try removing the override

* updating invoice download uri

* Update reservation.json

* Removing additional properties on policy

* updated the resource reference and removed unused override

* fixed error response

* fix error

* updated to proxyResourcewithTags

* fix errors

* Prettier check fix

* merge conflict resolved

* Prettier fix

* reverted package.json

* updated the ref

* Prettier check

* updated operation.json

* add sdk-suppressions.yaml

* remove modelerfour.lenient-model-deduplication, first stable

* fix sdk-suppressions

---------

Co-authored-by: Braden Watkins (from Dev Box) <[email protected]>
Co-authored-by: Umang Shah <[email protected]>
Co-authored-by: us6193 <[email protected]>
Co-authored-by: gaoyp830 <[email protected]>
Co-authored-by: Alancere <[email protected]>
…ure#28964)

* Copy files from stable/2023-05-01

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.

* Update version to preview/2024-05-01-preview

Updated the API version from stable/2023-05-01 to preview/2024-05-01-preview.

* Added tag for 2024-05-01-preview in readme file

* Added ContainerGroupProfile, StandbyPoolProfile, isCreatedFromStandbyPool to Container Group Properties and ConfigMap to ContainerProperties specs and modified examples

* Corrected code style issues using prettier

* Fixed code styling issues using prettier

* Corrected definition types

* Added isCreatedFromStandbyPool to container group properties in examples

* Corrected config map property definition in example

* Added arm resource id identifier for container group profile and standby pool profile

* Added format variable for container group profile and standby pool profile reference id

* Added 200 http status response in standby pool scenario example

* Modified the Container Group Create with standby pools example

* Corrected format

* Created suppressions.yaml

* Update containerInstance.json to remove osType,image and resources as required properties

* Update suppressions.yaml

* Update suppressions.yaml

* Delete specification/containerinstance/resource-manager/suppressions.yaml

* Added suppression for AvoidAdditionalProperties in readme.md

* Update suppression in readme.md

* Update readme.md
…ed (Azure#29483)

* add ops.ResourceCollectionAction KeepModel

* add ops.ResourceAction KeepModel

* add ops.LongRunningResourceAction KeepModel

* other templates

* switch over to BodyParameter

* format

* use valueof in BodyParameter template, add doc

* remove unnecessary documentation

* add doc to BodyParameter template

* add extra specs

* fix formatting of BodyParameter

* format

* format

* format

* suppress doc warning

* move body parameter to template

* add default body parameter doc

* default bodyparam doc to body parameter

* fix validation errors

* remove bodyparameter from codetransparency

* try for openai

* remove incorrect alias bodyparameter

* don't spread CreateLivenessWithVerifySessionContent

* fix breaking change in easm

* add readme to openai assistants

* update readme

* add tag to readme

* fix json file reference

* add json files to list

---------

Co-authored-by: iscai-msft <[email protected]>
Co-authored-by: Mark Cowlishaw <[email protected]>
…eration (Azure#29510)

* add back command

* remove run command PATCH

* update operation description
Azure#29472)

* Add Azure async APIs.

* Add examples, fix return codes.

* Fix typo.

* Add tags, run linter.

* Add missing refs.

* Formatting

* Add missing parameters.

* Remove unused status codes, defined Location header.

* Model validation errors.

* Prettier

* ProvisioningStateSpecifiedForLROPut

* Address PR comments.

* Create sdk-suppressions.yaml

---------

Co-authored-by: Marcus Beltman <[email protected]>
Co-authored-by: Yuchao Yan <[email protected]>
* up

* up

* almost there

* example

* up

* up

* up

* review comments
ArthurMa1978 and others added 14 commits June 28, 2024 10:04
Co-authored-by: Yunsong Bai <[email protected]>
Co-authored-by: Travis Wilson <[email protected]>
* Update readme.python.md

* Update readme.python.md
…re#29276)

* Remove flatten attribute to fix conflict for CLI generation tool
* Create sdk-suppressions.yaml
* Fixed examples and properrty documentation in TestProfiles

* Remove CANCELLED change
* Update detection description

* update spec
* update password in example to fix sdk credscan error

* update in tsp example
Copy link

openapi-pipeline-app-test bot commented Jul 5, 2024

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR has CI-RpaaSRPNotInPrivateRepo label. This means it is introducing a new RP (Resource Provider) namespace to the main branch without first merging the new RP to the RPSaaSMaster branch. To resolve, first submit and merge a PR with the new RP namespace to the RPSaaSMasterbranch.This PR will remain blocked until then.
  • ❌ This PR has at least one breaking change (label: BreakingChangeReviewRequired).
    To unblock this PR, follow the process at aka.ms/brch.
  • ❌ The required check named Swagger BreakingChange has failed. To unblock this PR, follow the process at aka.ms/brch.

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

Copy link

openapi-pipeline-app-test bot commented Jul 5, 2024

Swagger Generation Artifacts

️🔄[ignore this check status; not blocking PR merge] ApiDocPreview inProgress [Detail]
️🔄 $(sdkName) inProgress [Detail]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app-test bot commented Jul 5, 2024

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

Copy link

openapi-pipeline-app-test bot commented Jul 5, 2024

Swagger Validation Report

️❌BreakingChange: 78 Errors, 5 Warnings failed [Detail]
Compared specs (v0.10.12) new version base version
Face.json v1.1-preview.1(92d981e) v1.1-preview.1(main)
openapi.json 2024-04-01(92d981e) 2024-04-01(main)
assistants_generated.json 2024-02-15-preview(92d981e) 2024-02-15-preview(main)
assistants_generated.json 2024-05-01-preview(92d981e) 2024-05-01-preview(main)
generated.json 2023-06-01-preview(92d981e) 2023-06-01-preview(main)
generated.json 2023-07-01-preview(92d981e) 2023-07-01-preview(main)
generated.json 2024-02-15-preview(92d981e) 2024-02-15-preview(main)
generated.json 2024-03-01-preview(92d981e) 2024-03-01-preview(main)
generated.json 2024-04-01-preview(92d981e) 2024-04-01-preview(main)
generated.json 2024-05-01-preview(92d981e) 2024-05-01-preview(main)
generated.json 2022-12-01(92d981e) 2022-12-01(main)
generated.json 2023-05-15(92d981e) 2023-05-15(main)
communicationservicesmessages.json 2024-02-01(92d981e) 2024-02-01(main)
azure.developer.signing.json 2023-06-15-preview(92d981e) 2023-06-15-preview(main)
devopsinfrastructure.json 2024-04-04-preview(92d981e) 2024-04-04-preview(main)
HybridCompute.json 2024-05-20-preview(92d981e) 2024-05-20-preview(main)
openapi.json 2024-05-08(92d981e) 2024-05-08(main)
loadtestservice.json 2023-04-01-preview(92d981e) 2023-04-01-preview(main)
loadtestservice.json 2024-03-01-preview(92d981e) 2024-03-01-preview(main)
loadtestservice.json 2024-05-01-preview(92d981e) 2024-05-01-preview(main)
loadtestservice.json 2022-11-01(92d981e) 2022-11-01(main)
route.json 1.0(92d981e) 1.0(main)
maps-management.json 2023-12-01-preview(92d981e) 2023-12-01-preview(main)
azureFirewall.json 2024-01-01(92d981e) 2024-01-01(main)
expressRoutePort.json 2024-01-01(92d981e) 2024-01-01(main)
routeFilter.json 2024-01-01(92d981e) 2024-01-01(main)
openapi.json 2023-09-01-preview(92d981e) 2023-09-01-preview(main)
openapi.json 2023-09-01(92d981e) 2023-09-01(main)
openapi.json 2024-02-09-preview(92d981e) 2024-02-09-preview(main)
purviewdatamap.json 2023-09-01(92d981e) 2023-09-01(main)
easm.json 2023-03-01-preview(92d981e) 2023-03-01-preview(main)
easm.json 2024-03-01-preview(92d981e) 2024-03-01-preview(main)
searchservice.json 2024-07-01(92d981e) 2024-07-01(main)
defenderForStorageSettings.json 2022-12-01-preview(92d981e) 2022-12-01-preview(main)
storageTaskAssignments.json 2023-05-01(92d981e) 2023-05-01(main)
storageactions.json 2023-01-01(92d981e) 2023-01-01(main)
swagger.json 2024-02-29-preview(92d981e) 2024-02-29-preview(main)

Only 5 items are listed, please refer to log for more details.

Rule Message
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'FirewallPacketCaptureParametersFormat' removed or renamed?
New: Microsoft.Network/stable/2024-01-01/azureFirewall.json#L510:3
Old: Microsoft.Network/stable/2024-01-01/azureFirewall.json#L510:3
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Informatica.DataManagement/stable/2024-05-08/openapi.json#L1351:9
Old: Informatica.DataManagement/stable/2024-05-08/openapi.json#L1346:9
1023 - TypeFormatChanged The new version has a different format 'uri' than the previous one ''.
New: Informatica.DataManagement/stable/2024-05-08/openapi.json#L1443:9
Old: Informatica.DataManagement/stable/2024-05-08/openapi.json#L1434:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: Informatica.DataManagement/stable/2024-05-08/openapi.json#L1810:9
Old: Informatica.DataManagement/stable/2024-05-08/openapi.json#L1785:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Informatica.DataManagement/stable/2024-05-08/openapi.json#L1351:9
Old: Informatica.DataManagement/stable/2024-05-08/openapi.json#L1346:9

Only 5 items are listed, please refer to log for more details.

Rule Message
1008 - ModifiedOperationId The operation id has been changed from 'SubscriptionUsages_ListByLocation' to 'SubscriptionUsages_Usages'. This will impact generated code.
New: Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/devopsinfrastructure.json#L145:7
Old: Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/devopsinfrastructure.json#L145:7
1009 - RemovedRequiredParameter The required parameter 'locationName' was removed in the new version.
Old: Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/devopsinfrastructure.json#L158:11
1010 - AddingRequiredParameter The required parameter 'location' was added in the new version.
New: Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/devopsinfrastructure.json#L151:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/devopsinfrastructure.json#L165:13
Old: Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/devopsinfrastructure.json#L170:13
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/devopsinfrastructure.json#L1374:9
Old: common-types/resource-management/v5/types.json#L20:9
️❌Breaking Change(Cross-Version): 133 Errors, 301 Warnings failed [Detail]
Compared specs (v0.10.12) new version base version
billingSubscription.json 2024-04-01(92d981e) 2021-10-01(main)
payment.json 2024-04-01(92d981e) 2021-10-01(main)
types.json 2024-04-01(92d981e) 2021-10-01(main)
azureopenai.json 2024-06-01(92d981e) 2024-02-01(main)
containerInstance.json 2024-05-01-preview(92d981e) 2023-05-01(main)
containerInstance.json 2024-05-01-preview(92d981e) 2023-02-01-preview(main)
commonDefinitions.json 2024-07-01-preview(92d981e) 2024-02-01(main)
commonDefinitions.json 2024-07-01-preview(92d981e) 2024-06-01-preview(main)
devcenter.json 2024-07-01-preview(92d981e) 2024-02-01(main)
devcenter.json 2024-07-01-preview(92d981e) 2024-06-01-preview(main)
vdi.json 2024-07-01-preview(92d981e) 2024-02-01(main)
vdi.json 2024-07-01-preview(92d981e) 2024-06-01-preview(main)
connectedClusters.json 2024-07-01-preview(92d981e) 2024-01-01(main)
connectedClusters.json 2024-07-01-preview(92d981e) 2024-06-01-preview(main)
loadtestservice.json 2023-12-01-preview(92d981e) 2022-12-01(main)
loadtestservice.json 2023-12-01-preview(92d981e) 2022-04-15-preview(main)
AzureADAdministrator.json 2023-12-30(92d981e) 2023-06-30(main)
AzureADAdministrator.json 2023-12-30(92d981e) 2023-06-01-preview(main)
BackupAndExport.json 2023-12-30(92d981e) 2023-06-30(main)
BackupAndExport.json 2023-12-30(92d981e) 2023-10-01-preview(main)
Backups.json 2023-12-30(92d981e) 2023-06-30(main)
Backups.json 2023-12-30(92d981e) 2023-10-01-preview(main)
LongRunningBackups.json 2023-12-30(92d981e) 2023-10-01-preview(main)
Configurations.json 2023-12-30(92d981e) 2023-06-30(main)
Configurations.json 2023-12-30(92d981e) 2023-06-01-preview(main)
Databases.json 2023-12-30(92d981e) 2023-06-30(main)
Databases.json 2023-12-30(92d981e) 2023-06-01-preview(main)
FirewallRules.json 2023-12-30(92d981e) 2023-06-30(main)
FirewallRules.json 2023-12-30(92d981e) 2023-06-01-preview(main)
LogFiles.json 2023-12-30(92d981e) 2023-06-30(main)
LogFiles.json 2023-12-30(92d981e) 2023-06-01-preview(main)
Maintenances.json 2023-12-30(92d981e) 2023-10-01-preview(main)
webpubsub.json 2024-01-01(92d981e) 2023-07-01(main)
webpubsub.json 2024-01-01(92d981e) 2021-08-01-preview(main)

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

Only 5 items are listed, please refer to log for more details.

Rule Message
1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Billing/operations' removed or restructured?
Old: Microsoft.Billing/stable/2021-10-01/payment.json#L373:5
1011 - AddingResponseCode The new version adds a response code '201'.
New: Microsoft.Billing/stable/2024-04-01/billingSubscription.json#L400:11
1019 - RemovedEnumValue The new version is removing enum value(s) 'fine-tune, fine-tune-event' from the old version.
New: authoring/stable/2024-06-01/azureopenai.json#L1034:9
Old: authoring/stable/2024-02-01/azureopenai.json#L977:9
1019 - RemovedEnumValue The new version is removing enum value(s) 'fine-tune, fine-tune-event' from the old version.
New: authoring/stable/2024-06-01/azureopenai.json#L966:9
Old: authoring/stable/2024-02-01/azureopenai.json#L909:9
1019 - RemovedEnumValue The new version is removing enum value(s) 'fine-tune, fine-tune-event' from the old version.
New: authoring/stable/2024-06-01/azureopenai.json#L1398:9
Old: authoring/stable/2024-02-01/azureopenai.json#L1233:9


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

Only 5 items are listed, please refer to log for more details.

Rule Message
Runtime Exception "new":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/92d981e312efba67198b9fbc1e175e7163cc5a0e/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/azureopenai.json",
"old":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.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/AzureApiValidationTest_1a18ed4f-f3bf-4f34-9fed-13cb57bd2410/0.0.459/common/temp/node_modules/.pnpm/@Azure[email protected]/node_modules/autorest/dist/app.js" --v2 --input-file=/mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp/oad-hafm3O
2: ERROR: Schema violation: Expected type boolean but found type string
3:
4: code: 'INVALID-TYPE',

5: params: [ 'boolean',
'string' ],

6: message: 'Expected type boolean but found type string',

7: path: '#/definitions/TargetType/x-ms-enum/modelAsString',

8: schemaId: 'https://raw.githubusercontent.com/Azure/autorest/master/schema/swagger-extensions.json#'
9:
10: - file:///mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.json:2161:6 ($.definitions.TargetType["x-ms-enum"].modelAsString)
11: FATAL: swagger-document/individual/schema-validator - FAILED
12: FATAL: Error: [OperationAbortedException] Error occurred. Exiting.
13: Process() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting."
Runtime Exception "new":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/92d981e312efba67198b9fbc1e175e7163cc5a0e/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/inference.json",
"old":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/inference.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/AzureApiValidationTest_1a18ed4f-f3bf-4f34-9fed-13cb57bd2410/0.0.459/common/temp/node_modules/.pnpm/@Azure[email protected]/node_modules/autorest/dist/app.js" --v2 --input-file=/mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/inference.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp/oad-GflhmN
2: FATAL: swagger-document/loader - FAILED
3: FATAL: Error: File 'file:///mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/inference.json' is not a valid OpenAPI 2.0 definition (expected 'swagger: 2.0')
4: Error: File 'file:///mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/inference.json' is not a valid OpenAPI 2.0 definition (expected 'swagger: 2.0')"
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'LoadTestResourcePatchRequestBody' removed or renamed?
New: Microsoft.LoadTestService/preview/2023-12-01-preview/loadtestservice.json#L1094:3
Old: Microsoft.LoadTestService/preview/2022-04-15-preview/loadtestservice.json#L380:3
⚠️ 1011 - AddingResponseCode The new version adds a response code '204'.
New: WebPubSub/stable/2024-01-01/webpubsub.json#L476:11
⚠️ 1011 - AddingResponseCode The new version adds a response code '204'.
New: WebPubSub/stable/2024-01-01/webpubsub.json#L984:11

Rule Message
⚠️ APIsBeingMovedToANewSpec "details":"Attention: There are some existing APIs currently documented in a new spec file. The validation may not be able to report breaking changes with these APIs. It is recommended not to rename swagger file or move public APIs to a new file when creating a new API version.The existing APIs being moved are:Operations_List;",
"location":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/main/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/operation.json"
️🔄LintDiff inProgress [Detail]
️️✔️[ignore this check status; not blocking PR merge] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️❌TypeSpecAPIView: 0 Errors, 2 Warnings failed [Detail]
Rule Message
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest. "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest. "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌PoliCheck: 1 Errors, 0 Warnings failed [Detail]
Rule Message
Click detail for error messages. Exception contact [email protected] or https://aka.ms/swaggersupport.
️❌Avocado: 14 Errors, 2 Warnings failed [Detail]

Only 5 items are listed, please refer to log for more details.

Rule Message
MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
folder: resource-manager/Microsoft.HandWritten/preview/2024-01-01-preview
MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
folder: resource-manager/Microsoft.NoTspConfig/preview/2024-01-01-preview
MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
folder: resource-manager/Microsoft.ParseError/preview/2024-01-01-preview
MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
folder: resource-manager/Microsoft.Suppression/preview/2024-01-01-preview
MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
folder: resource-manager/Microsoft.TypeSpecGenerated/preview/2024-01-01-preview
️❌ModelValidation: 128 Errors, 0 Warnings failed [Detail]

Only 5 items are listed, please refer to log for more details.

Rule Message
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: deployment-id
Url: inference/stable/2024-06-01/inference.json#L34:11
ExampleUrl: stable/2024-06-01/examples/completions.json
RESPONSE_SCHEMA_NOT_IN_SPEC Response statusCode 200 for operation Completions_Create has response body provided in the example, however the response does not have a "schema" defined in the swagger spec.
Url: inference/stable/2024-06-01/inference.json#L191:22
ExampleUrl: stable/2024-06-01/examples/completions.json#L17:16
RESPONSE_SCHEMA_NOT_IN_SPEC Response statusCode 200 for operation embeddings_create has response body provided in the example, however the response does not have a "schema" defined in the swagger spec.
Url: inference/stable/2024-06-01/inference.json#L435:22
ExampleUrl: stable/2024-06-01/examples/embeddings.json#L13:16
RESPONSE_SCHEMA_NOT_IN_SPEC Response statusCode 200 for operation ChatCompletions_Create has response body provided in the example, however the response does not have a "schema" defined in the swagger spec.
Url: inference/stable/2024-06-01/inference.json#L543:22
ExampleUrl: stable/2024-06-01/examples/chat_completions.json#L20:16
RESPONSE_SCHEMA_NOT_IN_SPEC Response statusCode 200 for operation ChatCompletions_Create has response body provided in the example, however the response does not have a "schema" defined in the swagger spec.
Url: inference/stable/2024-06-01/inference.json#L543:22
ExampleUrl: stable/2024-06-01/examples/chat_completions_azure_search_minimum.json#L28:16
️❌SemanticValidation: 8 Errors, 0 Warnings failed [Detail]

Only 5 items are listed, please refer to log for more details.

Rule Message
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: swagger
JsonUrl: inference/stable/2024-06-01/inference.json
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: openapi
JsonUrl: inference/stable/2024-06-01/inference.json
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: servers
JsonUrl: inference/stable/2024-06-01/inference.json
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: components
JsonUrl: inference/stable/2024-06-01/inference.json
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: requestBody
JsonUrl: inference/stable/2024-06-01/inference.json
️️✔️[ignore this check status; not blocking PR merge] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@XiaofeiCao
Copy link
Author

/azp run

Copy link

No pipelines are associated with this pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.