AdobeDocs / AdobeDocs/cloudmanager-api-docs

Give example values for file parameter in getStepLogs

Offen
#20 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
JavaScript
Sterne
9
Forks
35
Ø Merge
6 T. 22 Std.
Gemergte PRs (30 T.)
2

Beschreibung

The `file` request parameter in https://github.com/AdobeDocs/cloudmanager-api-docs/blob/b6c0678a414f112dba41e3bc8ecbf324385cd20f/swagger-specs/api.yaml#L751 does not come with a description nor example values which would explain valid values here. By looking at the CloudManager Web UI I figured out there is only `sonarLogFile` supported now in step code scanning.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Öffne swagger-specs/api.yaml bei der Definition von getStepLogs etwa in Zeile 751 und prüfe den Datei-Request-Parameter. Dokumentiere den unterstützten Wert sonarLogFile mit einer Beschreibung und einem Beispiel und verifiziere anschließend, dass der OpenAPI-Eintrag den gültigen Wert eindeutig erklärt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
openapi
Bereich
api, documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.