bfirsh / bfirsh/docker-api-reference

Change operationId to more human friendly names

Aperta
#21 0 commenti 1 reazione 0 assegnatari Vedi su GitHub
Lingua principale
HTML
Stelle
3
Fork
1
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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`

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Inizia individuando le definizioni Swagger operationId nel riferimento dell’API ed elenca le voci che usano verbi HTTP come prefissi. Rinominale rimuovendo il verbo, seguendo gli esempi VolumesList e ContainerExec, quindi verifica che tutti gli operation ID interessati seguano lo stesso schema di denominazione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
docker, openapi
Ambito
api, documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.