bfirsh / bfirsh/docker-api-reference

Change operationId to more human friendly names

Abierto
#21 0 comentarios 1 reacción 0 asignados Ver en GitHub
Lenguaje dominante
HTML
Estrellas
3
Forks
1
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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`

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

Comienza localizando las definiciones de Swagger operationId en la referencia de la API y enumera las entradas que usan verbos HTTP como prefijos. Renómbralas eliminando el verbo, siguiendo los ejemplos VolumesList y ContainerExec, y luego verifica que todos los operation IDs afectados sigan el mismo patrón de nomenclatura.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
docker, openapi
Área
api, documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.