Adding new version 2023-05-01-preview for adding an additional parameter in "MarketplaceSaaSInfo" response #24031

RheaHooda23 · 2023-05-17T17:59:57Z

ARM API Information (Control Plane)

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.
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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 apply 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

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

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

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

openapi-workflow-bot · 2023-05-17T18:00:01Z

Hi, @RheaHooda23 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. vscswagger@microsoft.com

openapi-pipeline-app · 2023-05-17T18:00:02Z

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
elastic.json	2023-05-01-preview(f4fbc53)	2020-07-01(main)
elastic.json	2023-05-01-preview(f4fbc53)	2023-02-01-preview(main)

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

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.1.2)	new version	base version
package-2023-05-01-preview	package-2023-05-01-preview(f4fbc53)	default(main)

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.Elastic/preview/2023-05-01-preview/elastic.json#L2470
`❌` XmsParameterLocation	The parameter 'SubscriptionIdParameter' 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.Elastic/preview/2023-05-01-preview/elastic.json#L2478
⚠️ SummaryAndDescriptionMustNotBeSame	The summary and description values should not be same. Location: Microsoft.Elastic/preview/2023-05-01-preview/elastic.json#L1424
⚠️ 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.Elastic/preview/2023-05-01-preview/elastic.json#L1544
⚠️ SchemaDescriptionOrTitle	Schema should have a description or title. Location: Microsoft.Elastic/preview/2023-05-01-preview/elastic.json#L1758
⚠️ 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.Elastic/preview/2023-05-01-preview/elastic.json#L1806
⚠️ 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.Elastic/preview/2023-05-01-preview/elastic.json#L2051
⚠️ 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.Elastic/preview/2023-05-01-preview/elastic.json#L2055
⚠️ 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.Elastic/preview/2023-05-01-preview/elastic.json#L2059
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Elastic/preview/2023-05-01-preview/elastic.json#L2141
⚠️ 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.Elastic/preview/2023-05-01-preview/elastic.json#L2217
⚠️ 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.Elastic/preview/2023-05-01-preview/elastic.json#L2390
⚠️ SchemaDescriptionOrTitle	Schema should have a description or title. Location: Microsoft.Elastic/preview/2023-05-01-preview/elastic.json#L2458

️️✔️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.Elastic' for api version '2023-05-01-preview'. The supported api-versions are '2020-07-01-preview, 2020-07-01, 2021-09-01-preview, 2021-10-01-preview, 2022-05-05-preview, 2022-07-01-preview, 2022-09-01-preview, 2023-02-01-preview'."

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

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

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

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

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

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

openapi-pipeline-app · 2023-05-17T18:00:03Z

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-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from 1e77878. 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]  notice
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.6.7
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.7>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.7` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-elastic [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Added operation group ElasticVersionsOperations
info	[Changelog]   - Model MarketplaceSaaSInfo has a new parameter marketplace_status
info	[Changelog]   - Model MonitorProperties has a new parameter generate_api_key
info	[Changelog]   - Model UserApiKeyResponse has a new parameter properties
info	[Changelog]
info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog]   - Model ElasticMonitorResource no longer has parameter generate_api_key
info	[Changelog]   - Model UserApiKeyResponse no longer has parameter api_key
info	[Changelog]   - Operation OrganizationsOperations.get_api_key no longer has parameter resource_group_name

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

⚠️Warning [Logs]Release - Generate from 1e77878. 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
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

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

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

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

️✔️sdk/resourcemanager/elastic/armelastic [View full logs] [Release SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New field `MarketplaceStatus` in struct `MarketplaceSaaSInfo`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 1 additive change(s).

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

⚠️Warning [Logs]Release - Generate from 1e77878. 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

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

️❌ azure-powershell failed [Detail]

❌Pipeline Framework Failed [Logs]Release - Generate from 1e77878. 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
SSL error: syscall failure: Broken pipe
Error: SSL error: syscall failure: Broken pipe

️✔️Az.elastic.DefaultTag [View full logs]

Az.Elastic.0.1.0.nupkg

error	Fatal error: SSL error: syscall failure: Broken pipe
error	The following packages are still pending:
error		Az.elastic.DefaultTag

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

openapi-pipeline-app · 2023-05-17T18:00:04Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/elastic/armelastic	https://apiview.dev/Assemblies/Review/28b2d516aba44584b99a105d0148a7a9
Java	azure-resourcemanager-elastic	https://apiview.dev/Assemblies/Review/0ceae64294454445b052923c56a7b356

openapi-workflow-bot · 2023-05-17T18:00:41Z

Hi, @RheaHooda23 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

openapi-workflow-bot · 2023-05-17T18:09:37Z

Hi @RheaHooda23, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

openapi-workflow-bot · 2023-05-17T18:09:37Z

Hi, @RheaHooda23, 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. Or you could onboard API spec pipeline

v-xuto · 2023-05-18T03:15:31Z

@RheaHooda23 Please contact the ARM team to review this PR. If you don't know how to contact ARM team, you can check the third of the ARM API Review Checklist in the first comment.

v-xuto · 2023-05-19T06:25:27Z

@RheaHooda23 The api readiness check is failing, have you deployed your manifest?

RheaHooda23 · 2023-05-19T06:41:27Z

@RheaHooda23 The api readiness check is failing, have you deployed your manifest?

Hey @v-xuto No, I have not yet deployed.

qiaozha · 2023-05-19T07:06:52Z

@RheaHooda23 The api readiness check is failing, have you deployed your manifest?

Hey @v-xuto No, I have not yet deployed.

Are you planning to deploy it sooner after this PR get merged ?Because once this PR merged into main branch, it's public to the customer. If yes, I can merged this PR. otherwise, customer may get errors like api version is not available.

RheaHooda23 · 2023-05-19T08:26:11Z

@RheaHooda23 The api readiness check is failing, have you deployed your manifest?

Hey @v-xuto No, I have not yet deployed.

Are you planning to deploy it sooner after this PR get merged ?Because once this PR merged into main branch, it's public to the customer. If yes, I can merged this PR. otherwise, customer may get errors like api version is not available.

I'll deploy this today. No, it won't cause customer any issues because we haven't exposed this version yet. Yes, you can merge this PR. Thank you!

Base API Commit

dea1f02

openapi-assignment-bot bot assigned v-xuto May 17, 2023

openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 17, 2023

Changing API version to 2023-05-01-preview

52cbd19

azure-sdk mentioned this pull request May 17, 2023

[AutoPR sdk/resourcemanager/elastic/armelastic] Adding new version 2023-05-01-preview for adding an additional parameter in "MarketplaceSaaSInfo" response azure-sdk/azure-sdk-for-go#5745

Closed

adding additional parameter "marketplaceStatus"

19b0834

AzureRestAPISpecReview added CI-FixRequiredOnFailure CI-MissingBaseCommit new-api-version resource-manager RPaaS labels May 17, 2023

updating readme.md

f4fbc53

RheaHooda23 requested a review from poshett May 17, 2023 18:21

azure-sdk mentioned this pull request May 17, 2023

[AutoPR elastic] Adding new version 2023-05-01-preview for adding an additional parameter in "MarketplaceSaaSInfo" response azure-sdk/azure-resource-manager-schemas#2602

Closed

AzureRestAPISpecReview added ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test and removed CI-FixRequiredOnFailure labels May 17, 2023

poshett approved these changes May 18, 2023

View reviewed changes

raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label May 18, 2023

openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 18, 2023

v-xuto self-requested a review May 19, 2023 03:33

v-xuto approved these changes May 19, 2023

View reviewed changes

v-xuto added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label May 19, 2023

qiaozha merged commit 1e77878 into main May 22, 2023

qiaozha deleted the users/rheahooda/addingNewVersion_2023-05-01-preview branch May 22, 2023 02:23

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label May 22, 2023

azure-sdk mentioned this pull request May 22, 2023

[ReleasePR azure-resourcemanager-elastic] Adding new preview version 2023-10-01-preview with elasticsearchEndPoint property Azure/azure-sdk-for-java#29444

Closed

poshett mentioned this pull request May 29, 2023

Adding new stable API version 2023-06-01 for Microsoft.Elastic #24182

Merged

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding new version 2023-05-01-preview for adding an additional parameter in "MarketplaceSaaSInfo" response #24031

Adding new version 2023-05-01-preview for adding an additional parameter in "MarketplaceSaaSInfo" response #24031

RheaHooda23 commented May 17, 2023 •

edited

Loading

openapi-workflow-bot bot commented May 17, 2023

openapi-pipeline-app bot commented May 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 17, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented May 17, 2023 •

edited

Loading

openapi-workflow-bot bot commented May 17, 2023

openapi-workflow-bot bot commented May 17, 2023

openapi-workflow-bot bot commented May 17, 2023

v-xuto commented May 18, 2023

v-xuto commented May 19, 2023 •

edited

Loading

RheaHooda23 commented May 19, 2023

qiaozha commented May 19, 2023

RheaHooda23 commented May 19, 2023

Adding new version 2023-05-01-preview for adding an additional parameter in "MarketplaceSaaSInfo" response #24031

Adding new version 2023-05-01-preview for adding an additional parameter in "MarketplaceSaaSInfo" response #24031

Conversation

RheaHooda23 commented May 17, 2023 • edited Loading

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented May 17, 2023

openapi-pipeline-app bot commented May 17, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented May 17, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented May 17, 2023 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented May 17, 2023

openapi-workflow-bot bot commented May 17, 2023

openapi-workflow-bot bot commented May 17, 2023

v-xuto commented May 18, 2023

v-xuto commented May 19, 2023 • edited Loading

RheaHooda23 commented May 19, 2023

qiaozha commented May 19, 2023

RheaHooda23 commented May 19, 2023

RheaHooda23 commented May 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 17, 2023 •

edited

Loading

v-xuto commented May 19, 2023 •

edited

Loading