Skip to content

docs: update help text for "accept limit" for schema app creation #579

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/cool-foxes-live.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@smartthings/cli": patch
---

Updated help text for "accept limit" for schema invitation creation.
11 changes: 6 additions & 5 deletions packages/cli/src/commands/invites/schema/create.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,12 @@ export default class InvitesSchemaCreateCommand extends APICommand<typeof Invite
const createInputDefinition = objectDef<SchemaAppInvitationCreate>('Schema App Invitation', {
schemaAppId: schemaAppIdDef,
description: optionalStringDef('Description'),
acceptLimit: optionalIntegerDef('Accept Limit',
{
helpText: 'Enter the maximum number of users you want to be able to accept the invitation.\n' +
'Leave blank for no maximum.',
}),
acceptLimit: optionalIntegerDef('Accept (Install) Limit', {
helpText:
'Invitations are limited to a maximum of 500 installations (called "accept"s by the API) by default and are only valid for 30 days.\n' +
'Once either the install limit or the time limit is reached, you will need to create a new invitation.\n' +
'Leave blank to accept the default or enter a different install limit if desired.\n',
}),
})

return createFromUserInput(this, createInputDefinition, { dryRun: this.flags['dry-run'] })
Expand Down