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 ?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.
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 \DateTime ✔️ 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 \DateTime ➖ 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)