Skip to content

Align command's options with our naming convention #2696

@waldekmastykarz

Description

@waldekmastykarz

We should review all commands and ensure that all options match our naming convention:

  • if the option doesn't have a prefix (eg. id, title), it refers to the last noun in the command name, eg. spo listitem get > last noun = listitem so id and title refer to listitem
  • if the option needs to point to a property of a different object, it needs to be prefixed to make this clear, eg. listId, listTitle in spo listitem list. Last noun is listitem but we need the user to specify ID of the list, rather than list item, so just prompting for id or title wouldn't make it clear that we're expecting ID or title of the list

Commands that need adjustments:

  • aad approleassignment add: objectId and displayName should be prefixed with app
  • aad approleassignment list: objectId and displayName should be prefixed with app
  • aad approleassignment remove: objectId and displayName should be prefixed with app
  • aad o365group add: isPrivate should be a flag instead of a boolean option
  • aad o365group recyclebinitem list: displayName and mailNickname should be prefixed with group
  • aad o365group teamify: groupId doesn't need the group prefix and could be just id
  • aad policy list: policyType doesn't need the policy prefix and could be just type
  • aad sp get: displayName and objectId should be prefixed with app
  • flow run cancel: flow should be flowName to disambiguate how we expect users to denote the flow, same applies to environment, which should become environmentName
  • flow run get: flow should be flowName to disambiguate how we expect users to denote the flow, same applies to environment, which should become environmentName
  • flow run list: flow should be flowName to disambiguate how we expect users to denote the flow, same applies to environment, which should become environmentName
  • flow run resubmit: flow should be flowName to disambiguate how we expect users to denote the flow, same applies to environment, which should become environmentName
  • flow disable: environment should be environmentName to make it clear how we expect users to denote the environment
  • flow enable: environment should be environmentName to make it clear how we expect users to denote the environment
  • flow export: environment should be environmentName to make it clear how we expect users to denote the environment
  • flow get: environment should be environmentName to make it clear how we expect users to denote the environment
  • flow list: environment should be environmentName to make it clear how we expect users to denote the environment
  • flow remove: environment should be environmentName to make it clear how we expect users to denote the environment
  • outlook message move: messageId should be id
  • pa connector export: environment should be environmentName to make it clear how we expect users to denote the environment
  • pa connector list: environment should be environmentName to make it clear how we expect users to denote the environment
  • pa solution reference add: path should be projectPath
  • spfx package generate: packageName should be name
  • spo app add: scope should be appCatalogScope
  • spo app deploy: scope should be appCatalogScope
  • spo app get: scope should be appCatalogScope
  • spo app install: scope should be appCatalogScope
  • spo app list: scope should be appCatalogScope
  • spo app remove: scope should be appCatalogScope
  • spo app retract: scope should be appCatalogScope
  • spo app uninstall: scope should be appCatalogScope
  • spo app upgrade: scope should be appCatalogScope
  • spo apppage set: pageName should be name
  • spo cdn policy list: type should be cdnType
  • spo cdn policy set: type should be cdnType
  • spo contenttype field set: fieldId should be id
  • spo customaction add: url should be webUrl
  • spo customaction clear: url should be webUrl
  • spo customaction get: url should be webUrl
  • spo customaction list: url should be webUrl
  • spo customaction remove: url should be webUrl
  • spo customaction set: url should be webUrl
  • spo feature disable: url should be webUrl, featureId should be id
  • spo feature enable: url should be webUrl, featureId should be id
  • spo feature list: url should be webUrl
  • spo field get: fieldTitle should be title
  • spo field remove: fieldTitle should be title
  • spo file checkin: fileUrl should be url
  • spo file checkout: fileUrl should be url
  • spo file sharinginfo get: url should be fileUrl
  • spo folder get: folderUrl should be url
  • spo folder remove: folderUrl should be url
  • spo folder rename: folderUrl should be url
  • spo hubsite connect: url should be siteUrl
  • spo hubsite disconnect: url should be siteUrl
  • spo hubsite register: url should be siteUrl
  • spo hubsite rights grant: url should be hubSiteUrl
  • spo hubsite rights revoke: url should be hubSiteUrl
  • spo knowledgehub set: url should be siteUrl
  • spo list contenttype add: contentTypeId should be id
  • spo list contenttype remove: contentTypeId should be id
  • spo list view field add: fieldId should be id, fieldTitle should be title, fieldPosition should be position
  • spo list view field remove: fieldId should be id, fieldTitle should be title
  • spo list view field set: fieldId should be id, fieldTitle should be title, fieldPosition should be position
  • spo list view get: viewId should be id, viewTitle should be title
  • spo list view remove: viewId should be id, viewTitle should be title
  • spo list view set: viewId should be id, viewTitle should be title
  • spo listitem list: id should be listId, title should be listTitle
  • spo listitem record declare: id should be listItemId
  • spo listitem record undeclare: id should be listItemId
  • spo page column get: name should be pageName
  • spo page column list: name should be pageName
  • spo page control get: name should be pageName
  • spo page control list: name should be pageName
  • spo page control set: name should be pageName
  • spo page section add: name should be pageName
  • spo page section get: name should be pageName
  • spo page section list: name should be pageName
  • spo sp grant revoke: grantId should be id
  • spo sp permissionrequest approve: requestId should be id
  • spo sp permissionrequest deny: requestId should be id
  • spo site appcatalog add: url should be siteUrl
  • spo site appcatalog remove: url should be siteUrl
  • spo site apppermission get: permissionId should be id
  • spo site apppermission remove: permissionId should be id
  • spo site apppermission set: permissionId should be id
  • spo site chrome set: url should be siteUrl
  • spo site groupify: siteUrl should be url
  • spo site rename: siteUrl should be url
  • spo sitedesign rights grant: id should be siteDesignId
  • spo sitedesign rights list: id should be siteDesignId
  • spo sitedesign rights revoke: id should be siteDesignId
  • spo sitedesign task get: taskId should be id
  • spo sitedesign task remove: taskId should be id
  • spo tenant recyclebinitem remove: url should be siteUrl
  • spo tenant recyclebinitem restore: url should be siteUrl
  • spo web add: webUrl should be url
  • spo web get: webUrl should be url
  • spo web list: webUrl should be url
  • spo web reindex: webUrl should be url
  • spo web remove: webUrl should be url
  • spo web set: webUrl should be url
  • teams app install: appId should be id
  • teams app uninstall: appId should be id
  • teams channel get: channelId should be id, channelName should be name
  • teams channel remove: channelId should be id, channelName should be name
  • teams channel set: channelName should be name
  • teams message get: messageId should be id
  • teams tab get: tabId should be id, tabName should be name
  • teams tab remove: tabId should be id
  • teams team archive: teamId should be id
  • teams team clone: teamId should be id
  • teams team remove: teamId should be id
  • teams team set: teamId should be id
  • teams team unarchive: teamId should be id
  • teams user app add: appId should be id
  • teams user app remove: appId should be id
  • viva connections app create: appName should be name
  • yammer group user add: id should be groupId, userId should be id
  • yammer group user remove: id should be groupId, userId should be id
  • yammer message like set: id should be messageId
  • yammer user get: userId should be id
  • fix tests and coverage

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions