search

microsoft / botframework-cli

CLI Tools for the Microsoft Bot Framework
Other
176 stars 129 forks source link

Naming concern: subscriptionkey actually meant authoringkey #811

Open dawwa opened 4 years ago

dawwa commented 4 years ago

Versions

@microsoft/botframework-cli/4.8.0 win32-x64 node-v12.16.3 Windows 10

Describe the bug

There seems many places in the CLI and the doc, the subscriptionkey actually meant authoringkey, and the endpoint is authoring endpoint. e.g., bf luis:version:list

This feels misleading as I was trying to use the key of Prediction Resource, earlier known as a subscription key in the legacy luis API terms, and probably nowadays still being referred as the key of the Prediction Resource.

I'm not sure if it's too late to revise the naming, but this is a bit concerned. Maybe at least ensure the documentation explicitly call out this to avoid confusion.

munozemilio commented 4 years ago

Hi @dawwa, I agree this might be a little bit confusing. The CLI is a wrapper of the Luis endpoint and the intention was to keep it consistent with those docs. We will asses during this cycle your request and take action accordingly