Skip to content

Commit 0a7965c

Browse files
evanpurkhisergeorge-sentry
authored andcommitted
ref(pipleine): Add comments to types (#112599)
1 parent 70b4379 commit 0a7965c

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

static/app/components/pipeline/types.tsx

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,18 @@ export function getBackendPipelineType(type: PipelineType): string {
1313
* A single step in a pipeline definition.
1414
*/
1515
export interface PipelineStepDefinition<StepId extends string = string> {
16+
/**
17+
* The React component rendered for this step. Receives step data,
18+
* an advance callback, and error state via {@link PipelineStepProps}.
19+
*/
1620
component: React.ComponentType<PipelineStepProps<any, any>>;
21+
/**
22+
* Human-readable label shown in the modal header (e.g. "Selecting a project").
23+
*/
1724
shortDescription: string;
25+
/**
26+
* Unique identifier for this step, matching the backend step ID.
27+
*/
1828
stepId: StepId;
1929
}
2030

@@ -25,10 +35,26 @@ export interface PipelineDefinition<
2535
T extends PipelineType = PipelineType,
2636
P extends string = string,
2737
> {
38+
/**
39+
* Title displayed in the pipeline modal header.
40+
*/
2841
actionTitle: string;
42+
/**
43+
* Casts the raw completion response to the typed completion data shape.
44+
* Use the {@link pipelineComplete} helper for this.
45+
*/
2946
getCompletionData: (data: Record<string, unknown>) => unknown;
47+
/**
48+
* The integration provider key (e.g. 'github', 'aws_lambda').
49+
*/
3050
provider: P;
51+
/**
52+
* Ordered list of step definitions that make up this pipeline.
53+
*/
3154
steps: readonly PipelineStepDefinition[];
55+
/**
56+
* The pipeline type (e.g. 'integration', 'identity').
57+
*/
3258
type: T;
3359
}
3460

0 commit comments

Comments
 (0)