Storage STG 93

[seanmcc-msft]

[openapi-pipeline-app[bot]]

Next Steps to Merge

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 has failed. TypeSpec usage is required for all new (greenfield) services. This is currently enforced as a warning, 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.

If you still want to proceed merging this PR without addressing the above failures, refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

[openapi-pipeline-app[bot]]

Swagger Validation Report

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

There are no breaking changes.

️⚠️Breaking Change(Cross-Version): 49 Warnings warning [Detail]

compared swaggers (via Oad v0.10.5)]	new version	base version
file.json	2024-05-04(e397ff2)	2024-02-04(main)

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

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

Rule	Message
:warning: 1009 - RemovedRequiredParameter	The required parameter 'directory' was removed in the new version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L4960:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L46:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L93:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L164:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L240:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L313:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L491:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L566:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L689:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L804:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L927:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L1047:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L1175:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L1271:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L1334:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L1419:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L1516:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L1607:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L1671:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L1762:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L1853:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L1952:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L2077:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L2190:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L2265:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L2420:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L2517:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L2630:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L2724:9
:warning: 1019 - RemovedEnumValue	The new version is removing enum value(s) '2024-02-04' from the old version. Old: Microsoft.FileStorage/preview/2024-02-04/file.json#L2826:9

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 1 Warnings warning [Detail]

compared tags (via openapi-validator v2.2.0)	new version	base version
package-2024-05	package-2024-05(e397ff2)	default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule	Message	Related RPC [For API reviewers]
:warning: EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L7000

The following errors/warnings exist before current PR submission:

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

Rule	Message
❌ HostParametersValidation	The host parameter must be called 'endpoint'. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L16
❌ HostParametersValidation	The host parameter must be typed 'type 'string', format 'url''. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L16
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L135
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L145
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L221
❌ IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L361
❌ IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L366
❌ IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L371
❌ IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L376
❌ IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L387
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L547
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L644
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L670
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L759
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L785
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L882
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L908
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L1002
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L1028
❌ IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L1080
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L1130
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L1156
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L1239
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L1249
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L1390
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L1400
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L1487
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L1497
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L1578
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2024-05-04/file.json#L1588

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView 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.

️️✔️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 succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account. 

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

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

[openapi-pipeline-app[bot]]

Generated ApiView

Language	Package Name	ApiView Link
Swagger	Microsoft.FileStorage	https://apiview.dev/Assemblies/Review/a4e81fa81cae4aee9435e6d8b39e6a9f?revisionId=6924c7a7f5874f82a78a7bdebdc89da9

[openapi-workflow-bot[bot]]

Hi @seanmcc-msft! 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.

[seanmcc-msft]

@tg-msft can we get approval to merge this?