Skip to content

Latest commit

 

History

History
52 lines (49 loc) · 17.2 KB

targetsdk.md

File metadata and controls

52 lines (49 loc) · 17.2 KB

TargetSDK

Fields

Field Type Required Description
CommitHead *string ➖ Remote commit ID.
ContinuousIntegrationEnvironment *string ➖ Name of the CI environment.
Error *string ➖ Error message if the last event was not successful.
GenerateConfigPostVersion *string ➖ Version of the generated target (post generation)
GenerateEligibleFeatures *string ➖ Eligible feature set during generation
GenerateGenLockID string ✔️ gen.lock ID (expected to be a uuid). The same as id. A unique identifier for the target.
GenerateGenLockPreFeatures *string ➖ Features prior to generation
GenerateGenLockPreVersion *string ➖ Artifact version for the Previous Generation
GenerateNumberOfOperationsIgnored *int64 ➖ The number of operations ignored in generation.
GenerateNumberOfOperationsUsed *int64 ➖ The number of operations used in generation.
GenerateNumberOfTerraformResources *int64 ➖ The number of terraform resources used in generation.
GeneratePublished *bool ➖ Indicates whether the target was considered published.
GenerateTarget string ✔️ eg typescript, terraform, python
GenerateTargetName *string ➖ The workflow name of the target.
GenerateTargetVersion *string ➖ The version of the Speakeasy generator for this target eg v2 of the typescript generator.
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.
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.
ID string ✔️ Unique identifier of the target the same as generate_gen_lock_id
LastEventCreatedAt time.Time ✔️ Timestamp when the event was created in the database.
LastEventID string ✔️ Unique identifier of the last event for the target
LastEventInteractionType shared.InteractionType ✔️ Type of interaction.
LastPublishCreatedAt *time.Time ➖ Timestamp when the last publishing event was created.
LastPublishGhActionRunLink *string ➖ Link to the GitHub action run for the last publishing event.
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.
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.
Success *bool ➖ Indicates whether the event was successful.
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)