Adding description in getOrganizationApiKey #23602

poshett · 2023-04-18T13:34:25Z

ARM API Information (Control Plane)

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

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

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.
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-04-18T13:34:29Z

Hi, @poshett 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-04-18T13:34:30Z

Swagger Validation Report

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

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
elastic.json	2023-02-01-preview(ba343ed)	2023-02-01-preview(main)

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

There are no breaking changes.

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

There is no credential detected.

️⚠️LintDiff: 1 Warnings warning [Detail]

compared tags (via openapi-validator v2.0.0)	new version	base version
package-2023-02-01-preview	package-2023-02-01-preview(ba343ed)	package-2023-02-01-preview(main)

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

Rule	Message	Related RPC [For API reviewers]
⚠️ SummaryAndDescriptionMustNotBeSame	The summary and description values should not be same. Location: Microsoft.Elastic/preview/2023-02-01-preview/elastic.json#L1421

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-02-01-preview/elastic.json#L2436
`❌` 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-02-01-preview/elastic.json#L2444
⚠️ 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-02-01-preview/elastic.json#L1541
⚠️ SchemaDescriptionOrTitle	Schema should have a description or title. Location: Microsoft.Elastic/preview/2023-02-01-preview/elastic.json#L1755
⚠️ 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-02-01-preview/elastic.json#L1803
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Elastic/preview/2023-02-01-preview/elastic.json#L1870
⚠️ 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-02-01-preview/elastic.json#L2029
⚠️ 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-02-01-preview/elastic.json#L2033
⚠️ 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-02-01-preview/elastic.json#L2037
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Elastic/preview/2023-02-01-preview/elastic.json#L2088
⚠️ 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-02-01-preview/elastic.json#L2191
⚠️ 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-02-01-preview/elastic.json#L2364

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

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️⚠️~[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-04-18T13:34: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-python-track2 warning [Detail]

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

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

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Added operation group ElasticVersionsOperations
info	[Changelog]   - Added operation group OrganizationsOperations
info	[Changelog]   - Model DeploymentInfoResponse has a new parameter deployment_url
info	[Changelog]   - Model DeploymentInfoResponse has a new parameter marketplace_saas_info
info	[Changelog]   - Model MonitorProperties has a new parameter generate_api_key

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

⚠️Warning [Logs]Release - Generate from cb04639. 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
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
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 cb04639. 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 function `*ClientFactory.NewOrganizationsClient() *OrganizationsClient`
info	[Changelog] - New function `*ClientFactory.NewVersionsClient() *VersionsClient`
info	[Changelog] - New function `NewOrganizationsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*OrganizationsClient, error)`
info	[Changelog] - New function `*OrganizationsClient.GetAPIKey(context.Context, *OrganizationsClientGetAPIKeyOptions) (OrganizationsClientGetAPIKeyResponse, error)`
info	[Changelog] - New function `NewVersionsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*VersionsClient, error)`
info	[Changelog] - New function `*VersionsClient.List(context.Context, string, *VersionsClientListOptions) (VersionsClientListResponse, error)`
info	[Changelog] - New struct `MarketplaceSaaSInfo`
info	[Changelog] - New struct `MarketplaceSaaSInfoMarketplaceSubscription`
info	[Changelog] - New struct `UserAPIKeyResponse`
info	[Changelog] - New struct `UserEmailID`
info	[Changelog] - New struct `VersionsListResponse`
info	[Changelog] - New field `DeploymentURL` in struct `DeploymentInfoResponse`
info	[Changelog] - New field `MarketplaceSaasInfo` in struct `DeploymentInfoResponse`
info	[Changelog] - New field `GenerateAPIKey` in struct `MonitorProperties`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 18 additive change(s).

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

⚠️Warning [Logs]Release - Generate from cb04639. 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]  WARN 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
warn	No file changes detected after generation

️✔️elastic [View full logs]

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

️✔️Succeeded [Logs]Release - Generate from cb04639. 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.elastic.DefaultTag [View full logs] [Release SDK Changes]
- Az.Elastic.0.1.0.nupkg

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

openapi-pipeline-app · 2023-04-18T13:34:32Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/elastic/armelastic	https://apiview.dev/Assemblies/Review/0af843df1dd04a998731706881c852a5
Java	azure-resourcemanager-elastic	There is no API change compared with the previous version

Adding description in getOrganizationApiKey

ba343ed

openapi-assignment-bot bot assigned haolingdong-msft Apr 18, 2023

AzureRestAPISpecReview added resource-manager RPaaS labels Apr 18, 2023

haolingdong-msft approved these changes Apr 19, 2023

View reviewed changes

haolingdong-msft merged commit cb04639 into Azure:main Apr 19, 2023

JoshLove-msft pushed a commit to JoshLove-msft/azure-rest-api-specs that referenced this pull request Apr 25, 2023

Adding description in getOrganizationApiKey (Azure#23602)

a6d7d8f

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 description in getOrganizationApiKey #23602

Adding description in getOrganizationApiKey #23602

poshett commented Apr 18, 2023 •

edited by openapi-workflow-bot bot

Loading

openapi-workflow-bot bot commented Apr 18, 2023

openapi-pipeline-app bot commented Apr 18, 2023 •

edited

Loading

openapi-pipeline-app bot commented Apr 18, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Apr 18, 2023 •

edited

Loading

Adding description in getOrganizationApiKey #23602

Adding description in getOrganizationApiKey #23602

Conversation

poshett commented Apr 18, 2023 • edited by openapi-workflow-bot bot 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 Apr 18, 2023

openapi-pipeline-app bot commented Apr 18, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Apr 18, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Apr 18, 2023 • edited Loading

Generated ApiView

poshett commented Apr 18, 2023 •

edited by openapi-workflow-bot bot

Loading

openapi-pipeline-app bot commented Apr 18, 2023 •

edited

Loading

openapi-pipeline-app bot commented Apr 18, 2023 •

edited

Loading

openapi-pipeline-app bot commented Apr 18, 2023 •

edited

Loading