AdobeDocs / AdobeDocs/cloudmanager-api-docs

Clarify details in PipelineExecutionStepState

未关闭
#24 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
JavaScript
星标
9
派生
35
平均合并
6 天 22 小时
30 天内合并 PR
2

描述

The `details` element in https://github.com/AdobeDocs/cloudmanager-api-docs/blob/b6c0678a414f112dba41e3bc8ecbf324385cd20f/swagger-specs/api.yaml#L1707 does not define which map keys to expect there.

I have seen the following details map

```
"environmentUrls": [
{
"instanceType": "author",
"instanceUrl": "https://author-p7802-e44859.adobeaemcloud.com"
},
{
"instanceType": "publish",
"instanceUrl": "https://publish-p7802-e44859.adobeaemcloud.com"
}
],
"deploymentStepDescription": "[{\"id\":1,\"stepAction\":\"update-author-indexes\",\"updated\":\"2020-11-02T13:24:11.870+0000\"},{\"id\":2,\"stepAction\":\"update-publish-indexes\",\"updated\":\"2020-11-02T13:27:22.581+0000\"},{\"id\":3,\"stepAction\":\"update-services\",\"updated\":\"2020-11-02T13:27:46.629+0000\"},{\"id\":4,\"stepAction\":\"install-mutable-content\",\"updated\":\"2020-11-02T13:37:18.741+0000\"}]"
```

Would be nice to clarify this in a model or at least in some accompanying markdown document.

贡献指南

打开贡献指南

调研方向

检查 swagger-specs/api.yaml 第 1707 行,并检查 PipelineExecutionStepState 的 details 定义。在模型或随附的 Markdown 文档中记录观察到的 environmentUrls 和 deploymentStepDescription 键,使 API 用户能够清楚了解预期结构。

由索引模型根据 Issue 内容生成。

评估

技术栈
openapi
领域
api, documentation
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
48/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。