AdobeDocs / AdobeDocs/cloudmanager-api-docs
Clarify details in PipelineExecutionStepState
- Vorherrschende Sprache
- JavaScript
- Sterne
- 9
- Forks
- 35
- Ø Merge
- 6 T. 22 Std.
- Gemergte PRs (30 T.)
- 2
Beschreibung
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.
Beitragsleitfaden
Rechercherichtung
Überprüfe swagger-specs/api.yaml in Zeile 1707 und untersuche die Detailsdefinition von PipelineExecutionStepState. Dokumentiere die beobachteten Schlüssel environmentUrls und deploymentStepDescription im Modell oder in einem begleitenden Markdown-Dokument, sodass die erwartete Struktur für API-Nutzer klar ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- openapi
- Bereich
- api, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 48/100