bfirsh / bfirsh/docker-api-reference
Change operationId to more human friendly names
- Vorherrschende Sprache
- HTML
- Sterne
- 3
- Forks
- 1
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
Currently the operationId is using the HTTP verb as a prefix. This makes many of the names very awkward. We should change them to be more human readable:
`GetVolumesList` -> `VolumesList`
`PostContainerExec` -> `ContainerExec`
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Beginne damit, die Swagger operationId-Definitionen in der API-Referenz zu suchen, und liste die Einträge auf, die HTTP-Verben als Präfixe verwenden. Benenne sie um, indem du das Verb entfernst, entsprechend den Beispielen VolumesList und ContainerExec, und überprüfe anschließend, dass alle betroffenen operation IDs demselben Benennungsmuster folgen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- docker, 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
- 45/100