Board Review: Azure.ResourceManager.Help Namespace Review (Microsoft.Help Resource Provider)

[BharathaAravind]

Thank you for submitting this review request. Thorough review of your client library ensures that your APIs are consistent with the guidelines and the consumers of your client library have a consistently good experience when using Azure.

The Architecture Board reviews Track 2 libraries only. If your library does not meet this requirement, please reach out to Architecture Board before creating the issue.

Please reference our review process guidelines to understand what is being asked for in the issue template.

To ensure consistency, all Tier-1 languages (C#, TypeScript, Java, Python) will generally be reviewed together. In expansive libraries, we will pair dynamic languages (Python, TypeScript) together, and strongly typed languages (C#, Java) together in separate meetings.

For Tier-2 languages (C, C++, Go, Android, iOS), the review will be on an as-needed basis.

Before submitting, ensure you adjust the title of the issue appropriately.

Note that the required material must be included before a meeting can be scheduled.

Contacts and Timeline

• Responsible service team: Aravind Bharatha (arbhara@microsoft.com); Joshua Min (joshuamin@microsoft.com); Nithya Shivam (nithyasivam@microsoft.com)
• Main contacts: Aravind Bharatha (arbhara@microsoft.com); Joshua Min (joshuamin@microsoft.com); Nithya Shivam (nithyasivam@microsoft.com)
• Expected code complete date:
• Expected release date: 03/30/2023

About the Service

• Link to documentation introducing/describing the service: https://review.learn.microsoft.com/en-us/rest/api/azure-rest-preview/?branch=result_7590b404-e4be-4a9f-821d-ab3ea9fbb55f&view=azure-rest-preview
• Link to the service REST APIs: [Hub Generated] Review request for Microsoft.Help to add version preview/2023-01-01-preview azure-rest-api-specs#23056
• Link to GitHub issue for previous review sessions, if applicable: Link to our preview review. We would like to redo the review as we find HelpRp (Rp word in HelpRp is redundant and would like to request the word "Help" in our sdk's as our RP name is Microsoft.Help. I added the swagger documentation for context about our service above.)

About the client library

• Name of the client library:
• Languages for this review:

• Java
Resource Management - Help
azure-resourcemanager-help
API View Link: https://apiview.dev/Assemblies/Review/73135cd3a34243349ee51728aad80224

• JavaScript
Resource Management - Help
@azure/arm-help
API View Link: https://apiview.dev/Assemblies/Review/d360d9e658664b20ad829dc20a6c45a5

• Go/Golang
Resource Management - Help
sdk/resourcemanager/help/armhelp
API View link: Failed to generate (Working with pr reviewer. Look at swagger pr for more details)

• .NET (Future)
Resource Management - Help
Azure.ResourceManager.Help
API View Link: N/A

• Swagger
API view link: https://apiview.dev/Assemblies/Review/a38db001941d4debac155a8202e88dff

Thank you!

[BharathaAravind]

@ronniegeraghty / @kyle-patterson please review this and rename title API Review/API Sign Off to management and/or client libraries Introducing Microsoft.Help approval

[ronniegeraghty]

@BharathaAravind,
I believe we already reviewed and approved MGMT SDK Namespaces for this spec in this issue: https://github.com/Azure/azure-sdk-pr/issues/854

[BharathaAravind]

@ronniegeraghty Yeah I added the link to previously approved spec in the description. After discussing internally, we would like to do the review again and propose few more options other than HelpRp. Ex: Help, AzureHelp, HelpApi, AzHelp, ArmHelp etc

[KrzysztofCwalina]

To me just "Help" is too generic. Coudl we call it SelfHelp or SelfDiagnostics or Troubleshooting?

[ronniegeraghty]

After an email thread here are the agreed upon namespaces for each language:

• .NET: Azure.ResourceManager.SelfHelp
• Java: azure-resourcemanager-selfhelp (com.azure.resourcemanager.selfhelp)
• Go: sdk/resourcemanager/selfhelp/armselfhelp
• JavaScript: @azure/arm-selfhelp
• Python: azure-mgmt-selfhelp

The namespaces above have been provided to our architect team and are being reviewed.

[JeffreyRichter]

Go should be sdk/resourcemanager/selfhelp/armselfhelp

[BharathaAravind]

@JeffreyRichter - I think it is a typo. For Go, it will follow the default format like you suggested.

sdk/resourcemanager/selfhelp/armselfhelp

[ronniegeraghty]

@JeffreyRichter & @BharathaAravind I updated my comment with the namespaces to reflect your comments.

[BharathaAravind]

@ronniegeraghty - Can we consider this as our approved namespaces based on the email thread conversation?

[ronniegeraghty]

@ronniegeraghty - Can we consider this as our approved namespaces based on the email thread conversation?

At EOB today the architect's week to object to the names will be up and the names will be considered approved. I'll comment again when the approval is final.

[ronniegeraghty]

The following namespaces are approved:

.NET: Azure.ResourceManager.SelfHelp
Java: azure-resourcemanager-selfhelp (com.azure.resourcemanager.selfhelp)
Go: sdk/resourcemanager/selfhelp/armselfhelp
JavaScript: @azure/arm-selfhelp
Python: azure-mgmt-selfhelp