id |
::String |
✔️ |
Unique identifier for each event. |
execution_id |
::String |
✔️ |
Unique identifier for each execution of the CLI. |
workspace_id |
::String |
✔️ |
Identifier of the workspace. |
speakeasy_api_key_name |
::String |
✔️ |
Identifier of the Speakeasy API key. |
interaction_type |
::OpenApiSDK::Shared::InteractionType |
✔️ |
Type of interaction. |
local_started_at |
Date |
✔️ |
Timestamp when the event started, in local time. |
local_completed_at |
Date |
➖ |
Timestamp when the event completed, in local time. |
created_at |
Date |
✔️ |
Timestamp when the event was created in the database. |
speakeasy_version |
::String |
✔️ |
Version of the Speakeasy CLI. |
success |
T::Boolean |
✔️ |
Indicates whether the event was successful. |
raw_command |
T.nilable(::String) |
➖ |
Full CLI command. |
duration_ms |
T.nilable(::Integer) |
➖ |
Duration of the event in milliseconds. |
continuous_integration_environment |
T.nilable(::String) |
➖ |
Name of the CI environment. |
gh_action_run_link |
T.nilable(::String) |
➖ |
Link to the GitHub action run. |
gh_action_version |
T.nilable(::String) |
➖ |
Version of the GitHub action. |
gh_action_organization |
T.nilable(::String) |
➖ |
GitHub organization of the action. |
gh_action_ref |
T.nilable(::String) |
➖ |
GitHub Action ref value. |
gh_action_repository |
T.nilable(::String) |
➖ |
GitHub repository of the action. |
repo_label |
T.nilable(::String) |
➖ |
Label of the git repository. |
commit_head |
T.nilable(::String) |
➖ |
Remote commit ID. |
hostname |
T.nilable(::String) |
➖ |
Remote hostname. |
git_user_name |
T.nilable(::String) |
➖ |
User's name from git configuration. (not GitHub username) |
git_user_email |
T.nilable(::String) |
➖ |
User email from git configuration. |
git_remote_default_owner |
T.nilable(::String) |
➖ |
Default owner for git remote. |
git_remote_default_repo |
T.nilable(::String) |
➖ |
Default repository name for git remote. |
git_relative_cwd |
T.nilable(::String) |
➖ |
Current working directory relative to the git root. |
generate_target |
T.nilable(::String) |
➖ |
The target of the event. |
generate_target_name |
T.nilable(::String) |
➖ |
The workflow name of the target. |
generate_target_version |
T.nilable(::String) |
➖ |
The version of the target. |
generate_gen_lock_id |
T.nilable(::String) |
➖ |
gen.lock ID (expected to be a uuid). |
management_doc_checksum |
T.nilable(::String) |
➖ |
Checksum of the currently Rendered OpenAPI document. |
management_doc_version |
T.nilable(::String) |
➖ |
Version taken from info.version field of the Rendered OpenAPI document. |
generate_version |
T.nilable(::String) |
➖ |
Version of the generation logic used. |
generate_output_tests |
T.nilable(T::Boolean) |
➖ |
Indicates whether tests were output. |
generate_config_pre_raw |
T.nilable(::String) |
➖ |
Rendered configuration file (prior to generation) |
generate_config_post_raw |
T.nilable(::String) |
➖ |
Rendered configuration file (post generation) |
generate_config_pre_version |
T.nilable(::String) |
➖ |
The version of the customer's SDK before we generated |
generate_config_post_version |
T.nilable(::String) |
➖ |
The version of the customer's SDK that we just generated |
generate_config_pre_checksum |
T.nilable(::String) |
➖ |
Checksum of the configuration file (prior to generation) |
generate_config_post_checksum |
T.nilable(::String) |
➖ |
Checksum of the configuration file (post generation) |
generate_eligible_features |
T.nilable(::String) |
➖ |
Eligible feature set during generation |
generate_gen_lock_pre_features |
T.nilable(::String) |
➖ |
Features prior to generation |
generate_gen_lock_post_features |
T.nilable(::String) |
➖ |
Features post generation |
generate_gen_lock_pre_doc_version |
T.nilable(::String) |
➖ |
info.Version of the Previous Rendered OpenAPI document (prior to generation, via gen lock) |
generate_gen_lock_pre_doc_checksum |
T.nilable(::String) |
➖ |
Checksum of the Previous Rendered OpenAPI document (prior to generation, via gen lock) |
generate_gen_lock_pre_version |
T.nilable(::String) |
➖ |
Artifact version for the Previous Generation |
generate_gen_lock_pre_revision_digest |
T.nilable(::String) |
➖ |
Revision digest of the Previous Generation |
generate_gen_lock_pre_blob_digest |
T.nilable(::String) |
➖ |
Blob digest of the Previous Generation |
generate_gen_lock_pre_namespace_name |
T.nilable(::String) |
➖ |
Namespace name of the Previous Generation |
generate_bump_type |
T.nilable(::OpenApiSDK::Shared::GenerateBumpType) |
➖ |
Bump type of the lock file (calculated semver delta, custom change (manual release), or prerelease/graduate) |
generate_number_of_operations_ignored |
T.nilable(::Integer) |
➖ |
The number of operations ignored in generation. |
generate_number_of_operations_used |
T.nilable(::Integer) |
➖ |
The number of operations used in generation. |
generate_published |
T.nilable(T::Boolean) |
➖ |
Indicates whether the target was considered published. |
generate_repo_url |
T.nilable(::String) |
➖ |
Expected Repo URL, for use in documentation generation. |
publish_package_url |
T.nilable(::String) |
➖ |
URL of the published package. |
publish_package_name |
T.nilable(::String) |
➖ |
Name of the published package. |
publish_package_version |
T.nilable(::String) |
➖ |
Version of the published package. |
publish_package_registry_name |
T.nilable(::String) |
➖ |
Name of the registry where the package was published. |
source_revision_digest |
T.nilable(::String) |
➖ |
The revision digest of the source. |
source_blob_digest |
T.nilable(::String) |
➖ |
The blob digest of the source. |
source_namespace_name |
T.nilable(::String) |
➖ |
The namespace name of the source. |
lint_report_digest |
T.nilable(::String) |
➖ |
The checksum of the lint report. |
lint_report_error_count |
T.nilable(::Integer) |
➖ |
The number of errors in the lint report. |
lint_report_warning_count |
T.nilable(::Integer) |
➖ |
The number of warnings in the lint report. |
lint_report_info_count |
T.nilable(::Integer) |
➖ |
The number of info messages in the lint report. |
openapi_diff_report_digest |
T.nilable(::String) |
➖ |
The checksum of the openapi diff report. |
openapi_diff_base_source_revision_digest |
T.nilable(::String) |
➖ |
The revision digest of the base source. |
openapi_diff_base_source_blob_digest |
T.nilable(::String) |
➖ |
The blob digest of the base source. |
openapi_diff_base_source_namespace_name |
T.nilable(::String) |
➖ |
The namespace name of the base source. |
openapi_diff_breaking_changes_count |
T.nilable(::Integer) |
➖ |
The number of breaking changes in the openapi diff report. |
openapi_diff_bump_type |
T.nilable(::OpenApiSDK::Shared::OpenapiDiffBumpType) |
➖ |
Bump type of the lock file (calculated semver delta, or a custom change (manual release)) |
error |
T.nilable(::String) |
➖ |
Error message if the event was not successful. |
mermaid_diagram |
T.nilable(::String) |
➖ |
Mermaid diagram |
last_step |
T.nilable(::String) |
➖ |
The last step of the event. |
workflow_pre_raw |
T.nilable(::String) |
➖ |
Workflow file (prior to execution) |
workflow_post_raw |
T.nilable(::String) |
➖ |
Workflow file (post execution) |
workflow_lock_pre_raw |
T.nilable(::String) |
➖ |
Workflow lock file (prior to execution) |
workflow_lock_post_raw |
T.nilable(::String) |
➖ |
Workflow lock file (post execution) |