[Hub Generated] Review request for Microsoft.InstanceMetadataService to add version stable/2023-07-01

[xxxxiehf]

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

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.

• 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.

• 💬 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

• Azure DevTools Wiki

[openapi-pipeline-app]

Next Steps to Merge

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

[openapi-pipeline-app]

Swagger Validation Report

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

There are no breaking changes.

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

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
imds.json	2023-07-01(d94998b)	2021-12-13(main)

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

There is no credential detected.

️⚠️LintDiff: 6 Warnings warning [Detail]

compared tags (via openapi-validator v2.1.6)	new version	base version
package-2023-07-01	package-2023-07-01(d94998b)	default(main)

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

Rule	Message	Related RPC [For API reviewers]
⚠️ PageableOperation	Based on the response model schema, operation 'GetVersions' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L28
⚠️ PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L28
⚠️ VersionPolicy	Operation does not define an 'api-version' query parameter. Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L28
⚠️ OperationId	OperationId should be of the form 'Noun_Verb' Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L29
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L38
⚠️ ErrorResponse	Error response schema should contain an object property named error. Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L40

The following errors/warnings exist before current PR submission:

Rule	Message
❌ XmsParameterLocation	The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L1100
❌ XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L1107
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L71
⚠️ ErrorResponse	Error response schema should contain an object property named error. Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L73
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L111
⚠️ ErrorResponse	Error response schema should contain an object property named error. Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L113
⚠️ ParameterNamesConvention	Parameter name 'client_id' should be camel case. Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L156
⚠️ ParameterNamesConvention	Parameter name 'object_id' should be camel case. Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L163
⚠️ ParameterNamesConvention	Parameter name 'msi_res_id' should be camel case. Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L170
⚠️ ParameterNamesConvention	Parameter name 'bypass_cache' should be camel case. Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L184
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L206
⚠️ ErrorResponse	Error response schema should contain an object property named error. Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L213
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L250
⚠️ ErrorResponse	Error response schema should contain an object property named error. Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L252
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L424
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L469
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L493
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L681
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L859
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L863
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L879
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.InstanceMetadataService/stable/2023-07-01/imds.json#L883

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

Validation passes for Avocado.

️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]

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

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️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]

Swagger pipeline restarted successfully, please wait for status update in this comment.

[openapi-pipeline-app]

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

[heaths]

LGTM, but should get a second REST API reviewer as well. @mikekistler @johanste? It's a pretty small change and we probably don't need a meeting. The /versions endpoint has been in production for a few years they said in a comment, so this matches what's already there in a new api-version.

[heaths]

@mikekistler APIView failed to parse the security section of the swagger, if that helps: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=3241235&view=logs&j=9e7477d6-80c4-54a8-ebef-1e18da128ba0&t=f4a3c60c-600e-599b-d672-ffecbc71e09d&l=48 . Not a required check, fortunately.

[heaths]

@jhendrixMSFT this is ready to merge.

[openapi-pipeline-app]

Swagger pipeline restarted successfully, please wait for status update in this comment.