Azure / Azure/azure-openapi-validator
Ability to build ARM summary report
- Lenguaje dominante
- TypeScript
- Estrellas
- 53
- Forks
- 57
- Merge medio
- 1 d 23 h
- PR fusionados (30 d)
- 2
Descripción
To build confidence in the linter automation we need a summary report in the following format that can be the starting place for API reviewers to review the PRs.
For each RT
RPC category | #rules | #applicable | #success | #fail
-- | -- | -- | -- | --
RPC-V1-PUT | 22 | 22 | 20 | 2
RPC-V1-PATCH | 11 | 0 | 0 | 0
| | | |
we need to investigate how to fix below issues:
1. the linter output message should include the RT and/or Namespace field , so we may need to update some rules implementation to relate the swagger paths with the rule
3. Linter should output message for each passed linter rule execution (currently there is no message for passed rules)
then we can generate a result base on the linter output message
4. some rules are implemented as only finding the violations of swagger greedily, so they don't have chance to visit all the swagger paths/operations and these rules need to be re-implemented
Guía de contribución
Línea de trabajo
Empieza siguiendo la salida del linter y las implementaciones de las reglas; después, inspecciona cómo se visitan las rutas y operaciones de Swagger. La tarea está completa cuando se produce el resumen solicitado por RT con los recuentos de reglas y se añade suficiente contexto de RT o namespace, junto con mensajes de reglas superadas, para respaldar la revisión de la API.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- api, tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100