CliEvent.md

CliEvent

Fields

Field	Type	Required	Description
createdAt	\DateTime	✔️	Timestamp when the event was created in the database.
executionId	string	✔️	Unique identifier for each execution of the CLI.
id	string	✔️	Unique identifier for each event.
interactionType	Shared\InteractionType	✔️	Type of interaction.
localStartedAt	\DateTime	✔️	Timestamp when the event started, in local time.
speakeasyApiKeyName	string	✔️	Identifier of the Speakeasy API key.
speakeasyVersion	string	✔️	Version of the Speakeasy CLI.
success	bool	✔️	Indicates whether the event was successful.
workspaceId	string	✔️	Identifier of the workspace.
commitHead	?string	➖	Remote commit ID.
continuousIntegrationEnvironment	?string	➖	Name of the CI environment.
durationMs	?int	➖	Duration of the event in milliseconds.
error	?string	➖	Error message if the event was not successful.
generateBumpType	?Shared\GenerateBumpType	➖	Bump type of the lock file (calculated semver delta, custom change (manual release), or prerelease/graduate)
generateConfigPostChecksum	?string	➖	Checksum of the configuration file (post generation)
generateConfigPostRaw	?string	➖	Rendered configuration file (post generation)
generateConfigPostVersion	?string	➖	The version of the customer's SDK that we just generated
generateConfigPreChecksum	?string	➖	Checksum of the configuration file (prior to generation)
generateConfigPreRaw	?string	➖	Rendered configuration file (prior to generation)
generateConfigPreVersion	?string	➖	The version of the customer's SDK before we generated
generateEligibleFeatures	?string	➖	Eligible feature set during generation
generateGenLockId	?string	➖	gen.lock ID (expected to be a uuid).
generateGenLockPostFeatures	?string	➖	Features post generation
generateGenLockPreBlobDigest	?string	➖	Blob digest of the Previous Generation
generateGenLockPreDocChecksum	?string	➖	Checksum of the Previous Rendered OpenAPI document (prior to generation, via gen lock)
generateGenLockPreDocVersion	?string	➖	info.Version of the Previous Rendered OpenAPI document (prior to generation, via gen lock)
generateGenLockPreFeatures	?string	➖	Features prior to generation
generateGenLockPreNamespaceName	?string	➖	Namespace name of the Previous Generation
generateGenLockPreRevisionDigest	?string	➖	Revision digest of the Previous Generation
generateGenLockPreVersion	?string	➖	Artifact version for the Previous Generation
generateNumberOfOperationsIgnored	?int	➖	The number of operations ignored in generation.
generateNumberOfOperationsUsed	?int	➖	The number of operations used in generation.
generateNumberOfTerraformResources	?int	➖	The number of terraform resources used in generation.
generateOutputTests	?bool	➖	Indicates whether tests were output.
generatePublished	?bool	➖	Indicates whether the target was considered published.
generateRepoUrl	?string	➖	Expected Repo URL, for use in documentation generation.
generateTarget	?string	➖	The target of the event.
generateTargetName	?string	➖	The workflow name of the target.
generateTargetVersion	?string	➖	The version of the target.
generateVersion	?string	➖	Version of the generation logic used.
ghActionOrganization	?string	➖	GitHub organization of the action.
ghActionRef	?string	➖	GitHub Action ref value.
ghActionRepository	?string	➖	GitHub repository of the action.
ghActionRunLink	?string	➖	Link to the GitHub action run.
ghActionVersion	?string	➖	Version of the GitHub action.
ghChangesCommitted	?bool	➖	Whether or not changes were committed from generation in the Github Action.
ghPullRequest	?string	➖	The reference to a created pull request URL.
gitRelativeCwd	?string	➖	Current working directory relative to the git root.
gitRemoteDefaultOwner	?string	➖	Default owner for git remote.
gitRemoteDefaultRepo	?string	➖	Default repository name for git remote.
gitUserEmail	?string	➖	User email from git configuration.
gitUserName	?string	➖	User's name from git configuration. (not GitHub username)
hostname	?string	➖	Remote hostname.
lastStep	?string	➖	The last step of the event.
lintReportDigest	?string	➖	The checksum of the lint report.
lintReportErrorCount	?int	➖	The number of errors in the lint report.
lintReportInfoCount	?int	➖	The number of info messages in the lint report.
lintReportWarningCount	?int	➖	The number of warnings in the lint report.
localCompletedAt	\DateTime	➖	Timestamp when the event completed, in local time.
managementDocChecksum	?string	➖	Checksum of the currently Rendered OpenAPI document.
managementDocVersion	?string	➖	Version taken from info.version field of the Rendered OpenAPI document.
mermaidDiagram	?string	➖	Mermaid diagram
openapiDiffBaseSourceBlobDigest	?string	➖	The blob digest of the base source.
openapiDiffBaseSourceNamespaceName	?string	➖	The namespace name of the base source.
openapiDiffBaseSourceRevisionDigest	?string	➖	The revision digest of the base source.
openapiDiffBreakingChangesCount	?int	➖	The number of breaking changes in the openapi diff report.
openapiDiffBumpType	?Shared\OpenapiDiffBumpType	➖	Bump type of the lock file (calculated semver delta, or a custom change (manual release))
openapiDiffReportDigest	?string	➖	The checksum of the openapi diff report.
publishPackageName	?string	➖	Name of the published package.
publishPackageRegistryName	?string	➖	Name of the registry where the package was published.
publishPackageUrl	?string	➖	URL of the published package.
publishPackageVersion	?string	➖	Version of the published package.
rawCommand	?string	➖	Full CLI command.
repoLabel	?string	➖	Label of the git repository.
sourceBlobDigest	?string	➖	The blob digest of the source.
sourceNamespaceName	?string	➖	The namespace name of the source.
sourceRevisionDigest	?string	➖	The revision digest of the source.
workflowLockPostRaw	?string	➖	Workflow lock file (post execution)
workflowLockPreRaw	?string	➖	Workflow lock file (prior to execution)
workflowPostRaw	?string	➖	Workflow file (post execution)
workflowPreRaw	?string	➖	Workflow file (prior to execution)