Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update descriptions and flags to match specs #393

Merged
merged 2 commits into from
Dec 2, 2019
Merged

Update descriptions and flags to match specs #393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17f7892
Update descriptions and flags to match specs
Nov 27, 2019
bde8c47
Merge branch 'master' into bf-cli-luis-update-flags-and-descriptions
Dec 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions packages/luis/src/commands/luis/application/create.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ export default class LuisApplicationCreate extends Command {
static flags: any = {
help: flags.help({char: 'h'}),
endpoint: flags.string({description: 'LUIS endpoint hostname'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (aka Ocp-Apim-Subscription-Key)'}),
name: flags.string({description: 'LUIS application name'}),
culture: flags.string({description: 'LUIS application culture'}),
description: flags.string({description: 'LUIS application description'}),
versionId: flags.string({description: 'LUIS application initial version Id'}),
tokenizerVersion: flags.string({description: 'Version specifies how sentences are tokenized.'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (mandatory, default: config:LUIS:subscriptionKey)'}),
name: flags.string({description: 'Name of LUIS application'}),
culture: flags.string({description: 'Specify culture language (default: en-us)'}),
description: flags.string({description: 'Description of LUIS application'}),
versionId: flags.string({description: 'LUIS version Id. (mandatory, defaults to config:LUIS:versionId)'}),
tokenizerVersion: flags.string({description: 'Version specifies how sentences are tokenized (optional). See also: https://aka.ms/luistokens'}),
}

async run() {
Expand Down
4 changes: 2 additions & 2 deletions packages/luis/src/commands/luis/application/delete.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ export default class LuisApplicationDelete extends Command {

static flags: any = {
help: flags.help({char: 'h'}),
appId: flags.string({description: 'LUIS application Id'}),
appId: flags.string({description: 'LUIS application Id (mandatory, defaults to config:LUIS:appId)'}),
endpoint: flags.string({description: 'LUIS endpoint hostname'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (aka Ocp-Apim-Subscription-Key)'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (mandatory, default: config:LUIS:subscriptionKey)'}),
}

async run() {
Expand Down
8 changes: 4 additions & 4 deletions packages/luis/src/commands/luis/application/import.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {CLIError, Command, flags} from '@microsoft/bf-cli-command'
const utils = require('../../../utils/index')

export default class LuisApplicationImport extends Command {
static description = 'Imports an application to LUIS'
static description = 'Imports LUIS application from JSON or LU content.'

static examples = [`
$ bf luis:application:import --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --name {NAME} --in {PATH_TO_JSON}
Expand All @@ -18,9 +18,9 @@ export default class LuisApplicationImport extends Command {
static flags: any = {
help: flags.help({char: 'h'}),
endpoint: flags.string({description: 'LUIS endpoint hostname'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (aka Ocp-Apim-Subscription-Key)'}),
name: flags.string({description: 'LUIS application name'}),
in: flags.string({char: 'i', description: 'File path containing LUIS application contents'})
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (mandatory, default: config:LUIS:subscriptionKey)'}),
name: flags.string({description: 'LUIS application name (optional)'}),
in: flags.string({char: 'i', description: 'File path containing LUIS application contents, uses STDOUT if not specified (mandatory)'})
}

async run() {
Expand Down
8 changes: 4 additions & 4 deletions packages/luis/src/commands/luis/application/list.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ export default class LuisApplicationList extends Command {
static flags: any = {
help: flags.help({char: 'h'}),
endpoint: flags.string({description: 'LUIS endpoint hostname'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (aka Ocp-Apim-Subscription-Key)'}),
out: flags.string({char: 'o', description: 'Path to the directory where the exported file will be placed.'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (mandatory, default: config:LUIS:subscriptionKey)'}),
out: flags.string({char: 'o', description: 'Output results to specified file in JSON format, otherwise prints to STDOUT (optional)'}),
force: flags.boolean({char: 'f', description: 'If --out flag is provided with the path to an existing file, overwrites that file', default: false}),
skip: flags.string({description: 'The number of entries to skip. The default is 0 (no skips)'}),
take: flags.string({description: 'The number of etnries to return. The maximum page size is 500. The default is 100.'}),
skip: flags.string({description: 'Number of entries to skip. Default: 0 (no skips)'}),
take: flags.string({description: 'Number of etnries to return. Maximum page size is 500. Default: 100'}),
}

async run() {
Expand Down
8 changes: 4 additions & 4 deletions packages/luis/src/commands/luis/application/publish.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {CLIError, Command, flags} from '@microsoft/bf-cli-command'
const utils = require('../../../utils/index')

export default class LuisApplicationPublish extends Command {
static description = 'Publishes a specific version of the application'
static description = 'Publishes application\'s version'

static examples = [`
$ bf luis:application:publish --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --versionId {INITIAL_VERSION_ID} --appId {APP_ID} --staging {BOOLEAN}
Expand All @@ -17,9 +17,9 @@ export default class LuisApplicationPublish extends Command {
static flags: any = {
help: flags.help({char: 'h'}),
endpoint: flags.string({description: 'LUIS endpoint hostname'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (aka Ocp-Apim-Subscription-Key)'}),
appId: flags.string({description: 'LUIS applicaton id'}),
versionId: flags.string({description: 'LUIS application initial version Id'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (mandatory, default: config:LUIS:subscriptionKey)'}),
appId: flags.string({description: 'LUIS application Id (mandatory, defaults to config:LUIS:appId)'}),
versionId: flags.string({description: 'Version to publish (mandatory, defaults to config:LUIS:versionId)'}),
staging: flags.string({description: 'Publishes application version to Staging slot, otherwise publish to production (default: false)'}),
direct: flags.string({description: 'Available only in direct version query. Do not publish to staging or production (default: false)'})
}
Expand Down
8 changes: 4 additions & 4 deletions packages/luis/src/commands/luis/application/rename.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ export default class LuisApplicationRename extends Command {
static flags: any = {
help: flags.help({char: 'h'}),
endpoint: flags.string({description: 'LUIS endpoint hostname'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (aka Ocp-Apim-Subscription-Key)'}),
appId: flags.string({description: 'LUIS applicaton id'}),
name: flags.string({description: 'LUIS application name'}),
description: flags.string({description: 'LUIS application description'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (mandatory, default: config:LUIS:subscriptionKey)'}),
appId: flags.string({description: 'LUIS application Id (mandatory, defaults to config:LUIS:appId)'}),
name: flags.string({description: 'Name of LUIS application (mandatory)'}),
description: flags.string({description: 'Description of LUIS application (mandatory)'}),
}

async run() {
Expand Down
6 changes: 3 additions & 3 deletions packages/luis/src/commands/luis/endpoints/list.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ export default class LuisEndpointsList extends Command {
static flags: any = {
help: flags.help({char: 'h'}),
endpoint: flags.string({description: 'LUIS endpoint hostname'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (aka Ocp-Apim-Subscription-Key)'}),
appId: flags.string({description: 'LUIS application Id'}),
out: flags.string({char: 'o', description: 'Path to the directory where the exported file will be placed.'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (mandatory, default: config:LUIS:subscriptionKey)'}),
appId: flags.string({description: 'LUIS application Id (mandatory, defaults to config:LUIS:appId)'}),
out: flags.string({char: 'o', description: 'Output results to specified file in JSON format, otherwise prints to STDOUT (optional)'}),
force: flags.boolean({char: 'f', description: 'If --out flag is provided with the path to an existing file, overwrites that file', default: false}),
}

Expand Down
8 changes: 4 additions & 4 deletions packages/luis/src/commands/luis/version/clone.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ export default class LuisVersionClone extends Command {

static flags: any = {
help: flags.help({char: 'h'}),
appId: flags.string({description: 'LUIS application Id'}),
versionId: flags.string({description: 'LUIS version Id'}),
targetVersionId: flags.string({description: 'LUIS target version Id'}),
appId: flags.string({description: 'LUIS application Id (mandatory, defaults to config:LUIS:appId)'}),
versionId: flags.string({description: 'Source version to clone (mandatory, defaults to config:LUIS:versionId)'}),
targetVersionId: flags.string({description: 'Destination version to create (mandatory)'}),
endpoint: flags.string({description: 'LUIS endpoint hostname'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (aka Ocp-Apim-Subscription-Key)'}),
subscriptionKey: flags.string({description: 'LUIS authoring (Ocp-Apim-subscription) key'}),
}

async run() {
Expand Down
8 changes: 4 additions & 4 deletions packages/luis/src/commands/luis/version/delete.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@ import {CLIError, Command, flags} from '@microsoft/bf-cli-command'
const utils = require('../../../utils/index')

export default class LuisVersionDelete extends Command {
static description = 'Deletes a version of a LUIS application'
static description = 'Deletes a LUIS application version'

static examples = [`
$ bf luis:version:delete --appId {APP_ID} --versionId {VERSION_ID} --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY}
`]

static flags: any = {
help: flags.help({char: 'h'}),
appId: flags.string({description: 'LUIS application Id'}),
versionId: flags.string({description: 'LUIS application version Id'}),
appId: flags.string({description: 'LUIS application Id (mandatory, defaults to config:LUIS:appId)'}),
versionId: flags.string({description: 'Version to delete (mandatory)'}),
endpoint: flags.string({description: 'LUIS endpoint hostname'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (aka Ocp-Apim-Subscription-Key)'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (mandatory, default: config:LUIS:subscriptionKey)'}),
}

async run() {
Expand Down
10 changes: 5 additions & 5 deletions packages/luis/src/commands/luis/version/export.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ export default class LuisVersionExport extends Command {

static flags: any = {
help: flags.help({char: 'h'}),
appId: flags.string({description: 'LUIS application Id'}),
versionId: flags.string({description: 'LUIS application version Id'}),
out: flags.string({char: 'o', description: 'Path to the directory where the exported file will be placed.'}),
force: flags.boolean({char: 'f', description: 'If --out flag is provided with the path to an existing file, overwrites that file', default: false}),
appId: flags.string({description: 'LUIS application Id (mandatory, defaults to config:LUIS:appId)'}),
versionId: flags.string({description: 'Version to export (mandatory, defaults to config:LUIS:versionId)'}),
out: flags.string({char: 'o', description: 'Save exported application to specified file, uses STDOUT if not specified (optional)'}),
force: flags.boolean({char: 'f', description: 'Overwrites output file if exists, otherwise creates a parallel numbered file (optional)', default: false}),
endpoint: flags.string({description: 'LUIS endpoint hostname'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (aka Ocp-Apim-Subscription-Key)'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (mandatory, default: config:LUIS:subscriptionKey)'}),
}

async run() {
Expand Down
10 changes: 5 additions & 5 deletions packages/luis/src/commands/luis/version/import.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {CLIError, Command, flags} from '@microsoft/bf-cli-command'
const utils = require('../../../utils/index')

export default class LuisVersionImport extends Command {
static description = 'Imports a new version into a LUIS application'
static description = 'Imports a new version into a LUIS application from JSON or LU content.'

static examples = [`
$ bf luis:version:import --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --appId {APP_ID} --in {PATH_TO_JSON} --versionId {VERSION_ID}
Expand All @@ -17,11 +17,11 @@ export default class LuisVersionImport extends Command {

static flags: any = {
help: flags.help({char: 'h'}),
appId: flags.string({description: 'LUIS application Id'}),
versionId: flags.string({description: 'LUIS application version to import'}),
appId: flags.string({description: 'LUIS application Id (mandatory, defaults to config:LUIS:appId)'}),
versionId: flags.string({description: 'Version to export (mandatory, defaults to config:LUIS:versionId)'}),
endpoint: flags.string({description: 'LUIS endpoint hostname'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (aka Ocp-Apim-Subscription-Key)'}),
in: flags.string({char: 'i', description: 'File path containing LUIS application contents'})
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (mandatory, default: config:LUIS:subscriptionKey)'}),
in: flags.string({char: 'i', description: 'File path containing LUIS application contents, uses STDOUT if not specified (mandatory)'})
}

async run() {
Expand Down
12 changes: 6 additions & 6 deletions packages/luis/src/commands/luis/version/list.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {CLIError, Command, flags} from '@microsoft/bf-cli-command'
const utils = require('../../../utils/index')

export default class LuisVersionList extends Command {
static description = 'Lists application version data'
static description = 'Returns application\'s versions'

static examples = [`
$ bf luis:version:list --appId {APPLICATION_ID} --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --take 3
Expand All @@ -18,11 +18,11 @@ export default class LuisVersionList extends Command {
static flags: any = {
help: flags.help({char: 'h'}),
endpoint: flags.string({description: 'LUIS endpoint hostname'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (aka Ocp-Apim-Subscription-Key)'}),
appId: flags.string({description: 'LUIS application Id'}),
out: flags.string({char: 'o', description: 'Path to the directory where the exported file will be placed.'}),
skip: flags.string({description: 'The number of entries to skip. The default is 0 (no skips)'}),
take: flags.string({description: 'The number of etnries to return. The maximum page size is 500. The default is 100.'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (mandatory, default: config:LUIS:subscriptionKey)'}),
appId: flags.string({description: 'LUIS application Id (mandatory, defaults to config:LUIS:appId)'}),
out: flags.string({char: 'o', description: 'Output results to specified folder and/or file in JSON format, otherwise prints to STDOUT (optional)'}),
skip: flags.string({description: 'Number of entries to skip. Default: 0 (no skips)'}),
take: flags.string({description: 'Number of etnries to return. Maximum page size is 500. Default: 100'}),
force: flags.boolean({char: 'f', description: 'If --out flag is provided with the path to an existing file, overwrites that file', default: false}),
}

Expand Down
6 changes: 3 additions & 3 deletions packages/luis/src/commands/luis/version/rename.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ export default class LuisVersionRename extends Command {
static flags: any = {
help: flags.help({char: 'h'}),
endpoint: flags.string({description: 'LUIS endpoint hostname'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (aka Ocp-Apim-Subscription-Key)'}),
appId: flags.string({description: 'LUIS applicaton id'}),
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (mandatory, default: config:LUIS:subscriptionKey)'}),
appId: flags.string({description: 'LUIS application Id (mandatory, defaults to config:LUIS:appId)'}),
name: flags.string({description: 'LUIS applicaton name'}),
versionId: flags.string({description: 'Version to update (mandatory, defaults to config:LUIS:versionId'}),
versionId: flags.string({description: 'Version to update (mandatory, defaults to config:LUIS:versionId)'}),
newVersionId: flags.string({description: 'New version name (mandatory)'}),
}

Expand Down
2 changes: 1 addition & 1 deletion packages/luis/test/commands/luis/application/import.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ describe('luis:application:import', () => {
.stdout()
.command(['luis:application:import', '--help'])
.it('should print the help contents when --help is passed as an argument', ctx => {
expect(ctx.stdout).to.contain('Imports an application to LUIS')
expect(ctx.stdout).to.contain('Imports LUIS application from JSON or LU content.')
})

test
Expand Down
2 changes: 1 addition & 1 deletion packages/luis/test/commands/luis/application/publish.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ describe('luis:application:publish', () => {
.stdout()
.command(['luis:application:publish', '--help'])
.it('should print the help contents when --help is passed as an argument', ctx => {
expect(ctx.stdout).to.contain('Publishes a specific version of the application')
expect(ctx.stdout).to.contain('Publishes application\'s version')
})

test
Expand Down
2 changes: 1 addition & 1 deletion packages/luis/test/commands/luis/version/delete.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ describe('luis:version:delete', () => {
.stdout()
.command(['luis:version:delete', '--help'])
.it('should print the help contents when --help is passed as an argument', ctx => {
expect(ctx.stdout).to.contain('Deletes a version of a LUIS application')
expect(ctx.stdout).to.contain('Deletes a LUIS application version')
})

test
Expand Down
2 changes: 1 addition & 1 deletion packages/luis/test/commands/luis/version/import.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ describe('luis:version:import', () => {
.stdout()
.command(['luis:version:import', '--help'])
.it('should print the help contents when --help is passed as an argument', ctx => {
expect(ctx.stdout).to.contain('Imports a new version into a LUIS application')
expect(ctx.stdout).to.contain('Imports a new version into a LUIS application from JSON or LU content.')
})

test
Expand Down
2 changes: 1 addition & 1 deletion packages/luis/test/commands/luis/version/list.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ describe('luis:version:list', () => {
.stdout()
.command(['luis:version:list', '--help'])
.it('should print the help contents when --help is passed as an argument', ctx => {
expect(ctx.stdout).to.contain('Lists application version data')
expect(ctx.stdout).to.contain('Returns application\'s versions')
})

test
Expand Down