Added First stable version for vi #19727

tshoham · 2022-07-10T15:20:27Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No refresh required for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

…he stable folder

openapi-workflow-bot · 2022-07-10T15:20:29Z

Hi, @tshoham Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

openapi-pipeline-app · 2022-07-10T15:20:30Z

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.9.6)]	new version	base version
vi.json	2022-08-01(e80d4b8)	2022-04-13(main)

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

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v1.13.0)	new version	base version
package-2022-08-01	package-2022-08-01(e80d4b8)	default(main)

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.VideoIndexer/stable/2022-08-01/vi.json#L1164
`❌` R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.VideoIndexer/stable/2022-08-01/vi.json#L1204
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	The operation 'Accounts_Delete' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.VideoIndexer/stable/2022-08-01/vi.json#L438
⚠️ R2066 - PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'generateaccesstoken' in:'Generate_AccessToken'. Consider updating the operationId Location: Microsoft.VideoIndexer/stable/2022-08-01/vi.json#L608
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: connected Location: Microsoft.VideoIndexer/stable/2022-08-01/vi.json#L1066
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: eventGridProviderRegistered Location: Microsoft.VideoIndexer/stable/2022-08-01/vi.json#L1070
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: streamingEndpointStarted Location: Microsoft.VideoIndexer/stable/2022-08-01/vi.json#L1084
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.VideoIndexer/stable/2022-08-01/vi.json#L1105
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nameAvailable Location: Microsoft.VideoIndexer/stable/2022-08-01/vi.json#L1242
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List accounts Location: Microsoft.VideoIndexer/stable/2022-08-01/vi.json#L497
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get account Location: Microsoft.VideoIndexer/stable/2022-08-01/vi.json#L596

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

Validation passes for Avocado.

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

Rule	Message
`❌` API Readiness check failed. Please make sure your service is deployed.	"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.VideoIndexer' for api version '2022-08-01'. The supported api-versions are '2021-10-18-preview, 2021-10-27-preview, 2021-11-10-preview, 2022-04-13-preview'."

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️⚠️SDK Track2 Validation: 1 Warnings warning [Detail]

The following tags are being changed in this PR

"https://github.com/Azure/azure-rest-api-specs/blob/e80d4b8ee98171b405beb2ed364420af8e58a44f/specification/vi/resource-manager/readme.md#tag-package-2022-08-01">vi/resource-manager/readme.md#package-2022-08-01

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ UnkownSecurityScheme	"readme":"vi/resource-manager/readme.md", "tag":"package-2022-08-01", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous"

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

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

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

openapi-pipeline-app · 2022-07-10T15:20:31Z

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

️✔️azure-sdk-for-go - armvideoindexer - 0.1.0
️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-videoindexer - first release

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from 7986769. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]  config global `--global`, `--local` are deprecated. Use `--location=global` instead.

️✔️track2_azure-mgmt-videoindexer [View full logs] [Release SDK Changes]
- azure_mgmt_videoindexer-1.0.0b1-py3-none-any.whl
- azure-mgmt-videoindexer-1.0.0b1.zip
```
info	[Changelog]   - Initial Release
```

️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 7986769. 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

️✔️azure-resourcemanager-vi [View full logs] [Release SDK Changes]

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 7986769. SDK Automation 14.0.0

command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️armvideoindexer [View full logs] [Release SDK Changes]
```
info	[Changelog] This is a new package
info	[Changelog]
```

️⚠️ azure-sdk-for-js warning [Detail]

⚠️Warning [Logs]Release - Generate from 7986769. SDK Automation 14.0.0

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
cmderr	[automation_init.sh]  [email protected]: The functionality that this package provided is now in @npmcli/arborist
cmderr	[automation_init.sh]  [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
cmderr	[automation_init.sh]  deprecated @opentelemetry/[email protected]: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr	[automation_init.sh]  deprecated @azure/[email protected]: This version has been deprecated, please upgrade to the version tagged as latest
cmderr	[automation_init.sh]  @octokit/[email protected] requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

️✔️vi [View full logs] [Release SDK Changes]

info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from 7986769. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh]  old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json

️✔️vi [View full logs] [Release Schema Changes]

️️✔️ azure-powershell succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 7986769. SDK Automation 14.0.0

command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json

️✔️Az.Vi [View full logs] [Release SDK Changes]
- Az.Vi.0.1.0.nupkg

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

openapi-workflow-bot · 2022-07-10T15:21:06Z

Hi, @tshoham your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

tshoham · 2022-07-11T13:35:27Z

@lirenhe
Could you help figure out why the APIReadinessCheck is failing?
(If we could get on a call I would appreciate it)

mentat9 · 2022-07-11T19:56:44Z

@tshoham - This PR has no API changes, just the change in API version so ARM review is not required. I've removed the labels.

lirenhe · 2022-07-12T09:40:27Z

@lirenhe Could you help figure out why the APIReadinessCheck is failing? (If we could get on a call I would appreciate it)

It is to detect whether this API version is deployed to production or not. From the error message, it seems the current API version is not supported in production, is that correct?

tshoham · 2022-07-12T11:52:37Z

@lirenhe Could you help figure out why the APIReadinessCheck is failing? (If we could get on a call I would appreciate it)

It is to detect whether this API version is deployed to production or not. From the error message, it seems the current API version is not supported in production, is that correct?

This Api version is not deployed in production.
In all of our previous pr's in which we added an api version, we completed the "azure-rest-api-specs" pr, and only after it was completed, we deployed the version to production.
Is there a difference with "stable" versions?

lirenhe · 2022-07-13T02:22:25Z

specification/vi/resource-manager/readme.terraform.md

@@ -25,4 +25,7 @@ gosdk-folder: services/preview/vi/mgmt/2021-11-10-preview/vi

 ``` yaml $(tag) == 'package-2022-04-13-preview' && $(terraform)
 gosdk-folder: services/preview/vi/mgmt/2022-04-13-preview/vi


Please remove readme.terraform.md and we do not support that in SDK automation.

lirenhe · 2022-07-13T02:26:20Z

specification/vi/resource-manager/readme.design.md

I don't think we require this file in spec repo. Is this file mainly about the description of your service?

raych1 · 2022-07-13T03:17:39Z

@lirenhe Could you help figure out why the APIReadinessCheck is failing? (If we could get on a call I would appreciate it)

@tshoham, you can ignore APIReadinessCheck as your service is RpaaS service and needs to merge swagger before rolling out manifest. BTW, I assume this version of specs were already reviewed in RPSaaSMaster branch in private spec repo. If that's true, you can use the publishing page to publish the reviewed PR to public spec repo.
For more information, refer to this wiki page.

tshoham · 2022-07-13T06:38:17Z

W, I assume this version of spec

@lirenhe This branch has is the same branch as our 2022-04-13-preview version. It hasn't gone through our private spec repo. Can I go ahead and publish the pr in this case?

lirenhe · 2022-07-14T01:48:42Z

W, I assume this version of spec

@lirenhe This branch has is the same branch as our 2022-04-13-preview version. It hasn't gone through our private spec repo. Can I go ahead and publish the pr in this case?

Could you remove readme.terraform.md as it is no longer needed. Other parts look good.

tshoham · 2022-07-14T14:11:49Z

W, I assume this version of spec

@lirenhe This branch has is the same branch as our 2022-04-13-preview version. It hasn't gone through our private spec repo. Can I go ahead and publish the pr in this case?

Could you remove readme.terraform.md as it is no longer needed. Other parts look good.

@lirenhe , I have removed the readme.terraform.md as requested.

tshoham · 2022-07-18T10:58:33Z

@lirenhe can you please approve/complete this pr?

Create to sync Azure/azure-rest-api-specs#19727 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/vi?expand=1)

tshoham added 2 commits July 10, 2022 17:19

Added first stable version - copied preview version 2022-04-13 into t…

e18c8e9

…he stable folder

Updated stable version to 2022-08-01

70955d3

openapi-assignment-bot bot assigned lirenhe Jul 10, 2022

openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jul 10, 2022

mentat9 removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required ARMReview labels Jul 11, 2022

lirenhe reviewed Jul 13, 2022

View reviewed changes

Removed readme.terraform.md

e80d4b8

lirenhe approved these changes Jul 19, 2022

View reviewed changes

lirenhe merged commit 7986769 into main Jul 19, 2022

lirenhe deleted the feature/talshoham/first-stable-version-vi branch July 19, 2022 02:34

azure-sdk mentioned this pull request Jul 19, 2022

[ReleasePR vi] VI stable/2024-01-01 - AMSless accounts Azure/azure-sdk-for-js#21781

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added First stable version for vi #19727

Added First stable version for vi #19727

tshoham commented Jul 10, 2022 •

edited

Loading

openapi-workflow-bot bot commented Jul 10, 2022

openapi-pipeline-app bot commented Jul 10, 2022 •

edited

Loading

openapi-pipeline-app bot commented Jul 10, 2022 •

edited

Loading

Breaking Changes Tracking

openapi-workflow-bot bot commented Jul 10, 2022

tshoham commented Jul 11, 2022

mentat9 commented Jul 11, 2022 •

edited

Loading

lirenhe commented Jul 12, 2022

tshoham commented Jul 12, 2022

lirenhe Jul 13, 2022

lirenhe Jul 13, 2022

raych1 commented Jul 13, 2022

tshoham commented Jul 13, 2022

lirenhe commented Jul 14, 2022

tshoham commented Jul 14, 2022

tshoham commented Jul 18, 2022

		@@ -25,4 +25,7 @@ gosdk-folder: services/preview/vi/mgmt/2021-11-10-preview/vi

		``` yaml $(tag) == 'package-2022-04-13-preview' && $(terraform)
		gosdk-folder: services/preview/vi/mgmt/2022-04-13-preview/vi

Added First stable version for vi #19727

Added First stable version for vi #19727

Conversation

tshoham commented Jul 10, 2022 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Jul 10, 2022

openapi-pipeline-app bot commented Jul 10, 2022 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jul 10, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-workflow-bot bot commented Jul 10, 2022

tshoham commented Jul 11, 2022

mentat9 commented Jul 11, 2022 • edited Loading

lirenhe commented Jul 12, 2022

tshoham commented Jul 12, 2022

lirenhe Jul 13, 2022

Choose a reason for hiding this comment

lirenhe Jul 13, 2022

Choose a reason for hiding this comment

raych1 commented Jul 13, 2022

tshoham commented Jul 13, 2022

lirenhe commented Jul 14, 2022

tshoham commented Jul 14, 2022

tshoham commented Jul 18, 2022

tshoham commented Jul 10, 2022 •

edited

Loading

openapi-pipeline-app bot commented Jul 10, 2022 •

edited

Loading

openapi-pipeline-app bot commented Jul 10, 2022 •

edited

Loading

mentat9 commented Jul 11, 2022 •

edited

Loading