AdobeDocs / AdobeDocs/cloudmanager-api-docs

Clarify mapping of 'stepStates.action' and the step names in https://www.adobe.io/apis/experiencecloud/cloud-manager/docs.html#!AdobeDocs/cloudmanager-api-docs/master/advancing-and-cancelling-steps.md?

Open
#25 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
9
Forks
35
Avg merge
6d 22h
Merged PRs (30d)
2

Description

The documentation at https://www.adobe.io/apis/experiencecloud/cloud-manager/docs.html#!AdobeDocs/cloudmanager-api-docs/master/advancing-and-cancelling-steps.md refers to some step names. Unfortunately those names are not exposed in https://www.adobe.io/apis/experiencecloud/cloud-manager/api-reference.html#/Pipeline_Execution/getExecution.

How can I map any of the returned fields with the step names from the documentation at https://www.adobe.io/apis/experiencecloud/cloud-manager/docs.html#!AdobeDocs/cloudmanager-api-docs/master/advancing-and-cancelling-steps.md?

The closest match seems to be `_embedded.stepStates.action` with values like
`validate`, `build`, `codeQuality`, `buildImage` and `deploy` (probably some more depending on the pipeline type). Please provide a mapping table.

Contributor guide

Open the contributing guide

Research direction

Compare the step names in the advancing-and-cancelling-steps documentation with the fields returned by the Pipeline_Execution getExecution API reference. Start with `_embedded.stepStates.action` and the listed values; done means providing a mapping table that clarifies how returned fields correspond to documented step names.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.